2023.12.3 关于 Spring Boot 拦截器 和 过滤器

目录

引言

Spring 拦截器实现

实例理解

Spring 过滤器实现

实例理解

拦截器和过滤器的区别 

出身不同

触发时机不同

底层实现不同

支持的项目类型不同

使用场景不同

引言

  • 原生 Spring AOP 实现统一拦截有两个难点
  • 难点一：定义拦截规则表达式 
  • 难点二：在切面中获取到 HttpSession

Spring 拦截器实现

  • 为了解决原生 Spring AOP 实现统一拦截的难点
  • Spring 提供了具体的实现拦截器 HandlerInterceptor
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;@Component
public class TestInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {System.out.println("拦截器：执行 preHandle 方法。");return true;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {System.out.println("拦截器：执行 postHandle 方法。");}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {System.out.println("拦截器：执行 afterCompletion 方法。");}
}
  • preHandle 在请求方法执行前被调用，也就是在调用目标方法之前被调用
  • postHandle 在请求方法执行后被调用，但是会在 DispatcherServlet 进行渲染视图之前被执行
  • afterCompletion 会在整个请求结束之后再执行，也就是在 DispatcherServlet 渲染了对应的视图之后再执行

实例理解

  • 此处我们想要实现 用户登录验证 的判断
步骤一
  • 创建自定义拦截器，此处创建了一个 LoginInterceptor 类，实现 HandlerInterceptor 接口
  • 用户登录验证 属于执行目标方法之前就应对其进行判断，所以此处重写 preHandler 方法，并在方法中编写相应的业务代码
package com.example.demo.component;import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;/*
* 自定义拦截器
* */
@Component
public class LoginInterceptor implements HandlerInterceptor {/** 调用目标方法之前执行的方法* 此方法返回 boolean 类型的值 如果返回的为 true 表示拦截器 验证成功 继续走后续的流程* 如果返回 false 则表示拦截器 验证未通过 后续的流程和目标方法不要执行了* */@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//        用户登录判断业务HttpSession session  = request.getSession(false);if(session != null && session.getAttribute("session_userinfo") != null) {
//            用户已经登录return true;}
//        到达此处说明用户未登录
//        我们可以直接重定向到登录页面
//        response.sendRedirect("/login.html");
//        此处我们未写登录页面，所以我们直接返回一个 401 表示客户端错误response.setStatus(401);return false;}
}
步骤二
  • 将自定义拦截器加入到系统配置
  • 设置拦截规则
package com.example.demo.config;import com.example.demo.component.LoginInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;@Configuration
public class MyConfig implements WebMvcConfigurer {@Autowiredprivate LoginInterceptor loginInterceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(loginInterceptor).addPathPatterns("/**")//拦截所有的 url  /* 代表一级 /** 代表多级.excludePathPatterns("/user/login") //排除 url /user/login 不拦截.excludePathPatterns("/user/register") .excludePathPatterns("/css/**") //排除 css 文件夹下的所有文件.excludePathPatterns("/js/**") //排除 js 文件夹下的所有文件.excludePathPatterns("/image/**") //排除 image 文件夹下的所有文件;}
}
  • 设置完拦截器后的交互流程图

Spring 过滤器实现

  • 过滤器的实现可以使用 Servlet 3.0 提供的 @WebFilter 注解
  • 配置过滤的 URL 规则、实现 Filter 接口 、重写接口中的 doFilter 方法
package com.example.demo.component;import org.springframework.stereotype.Component;import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;@Component
@WebFilter(urlPatterns = "/*")
public class TestFilter implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {System.out.println("过滤器：执行 init 方法");}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {System.out.println("过滤器：开始执行 doFilter 方法");
//        请求放行filterChain.doFilter(servletRequest,servletResponse);System.out.println("过滤器：结束执行 doFilter 方法");}@Overridepublic void destroy() {System.out.println("过滤器：执行 destroy 方法");}
}
  • init  在容器启动时会被调用，整个程序运行期只会被调用一次，用于实现 Filter 对象的初始化
  • doFilter 具体过滤功能的实现，通过此方法对请求进行过滤处理
  • destory 用于 Filter 销毁前完成相关资源的回收工作

注意：

  • filterChain.doFilter(servletRequest,servletResponse); （请求放行）
  • 该行代码的作用是将请求传递给过滤器链中的下一个过滤器或目标资源（执行下一个流程）
  • 如果没有这行代码，那么请求将会在当前的过滤器中停止，不会继续向下传递

实例理解

  • 此处我们想实现 敏感词过滤
package com.example.demo.component;import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;@WebFilter(urlPatterns = "/*")
public class SensitiveWordsFilter implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {System.out.println("过滤器：执行 init 方法");}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {System.out.println("过滤器：开始执行 doFilter 方法");// 获取用户提交的信息String message = servletRequest.getParameter("message");// 敏感词库String[] sensitiveWords = {"敏感词1", "敏感词2"};for (String sensitiveWord : sensitiveWords) {if (message.contains(sensitiveWord)) {message = message.replace(sensitiveWord, "*");}}servletRequest.setAttribute("message", message);// 请求放行filterChain.doFilter(servletRequest, servletResponse);System.out.println("过滤器：结束执行 doFilter 方法");}@Overridepublic void destroy() {System.out.println("过滤器：执行 destroy 方法");}
}

拦截器和过滤器的区别 

  • 主要有 5 个方面

出身不同

  • 拦截器 来自于 Spring 框架
  • 过滤器 来自于 Servlet 

触发时机不同

  • 请求执行顺序为：
  • 请求进入容器 ——> 进入过滤器 ——> 进入 Servlet ——> 进入拦截器 ——> 进入控制器（Controller）

底层实现不同

拦截器

  • 基于 Java 的 Servlet 规范实现的，通过实现 HandleInterceptor 接口来实现拦截器功能
  • 在 Spring Boot 框架的执行流程中，拦截器被注册在 DispatcherServlet 的 doDispatch 方法中，该方法是 Spring Boot 框架的核心方法，用于处理请求和响应
  • 程序每次执行时都会调用 doDispatch 方法，并验证拦截器链（一个应用中可以同时存在多个拦截器，每个拦截器均按提前配置好的顺序执行），之后再根据拦截器返回的结果，进行下一步的处理
  • 如果返回的是 true 则将继续调用目标方法
  • 如果返回的是 false 则直接返回验证失败给前端

过滤器

  • 基于方法回调

支持的项目类型不同

  • 拦截器 是 Spring 中的一个组件，因此拦截器即可以用在 Web 项目中，同时还可以用在 Application 或 Swing 程序中
  • 过滤器 是 Servlet 规范中定义的，所以过滤器要依赖于 Servlet 容器，它只能用在 Web 项目中

使用场景不同

  • 拦截器 更接近业务系统，所以拦截器主要用来实现项目中的业务判断，如登录判断、权限判断、日志记录等
  • 过滤器 通常是用来实现通用功能过滤的，如敏感词过滤、字符集编码设置、响应数据压缩 等

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/263693.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

课堂练习4.4：页式虚存

课堂练习4.4：页式虚存

4-7 课堂练习4.4：页式虚存 缺页异常在 Linux 内核处理中占有非常重要的位置，很多 Linux 特性，如写时复制，页框延迟分配，内存回收中的磁盘和内存交换，都需要借助缺页异常来进行。 本实训分析 Linux 0.11 的缺页处理机制。 第1关版本 0 内核的第一次缺页页故障 任务描述 …
阅读更多...
Python满屏飘字表白代码

Python满屏飘字表白代码

​ 目录 系列文章 写在前面 Turtle入门 满屏飘字 写在后面 系列文章 序号文章目录直达链接表白系列1浪漫520表白代码https://want595.blog.csdn.net/article/details/1306668812满屏表白代码https://want595.blog.csdn.net/article/details/1297945183跳动的爱心https://…
阅读更多...
四. 基于环视Camera的BEV感知算法-DETR3D

四. 基于环视Camera的BEV感知算法-DETR3D

目录 前言0. 简述1. 算法动机&开创性思路2. 主体结构3. 损失函数4. 性能对比总结下载链接参考 前言 自动驾驶之心推出的《国内首个BVE感知全栈系列学习教程》，链接。记录下个人学习笔记，仅供自己参考 本次课程我们来学习下课程第四章——基于环视Cam…
阅读更多...
1827_ChibiOS中OSLIB的邮箱机制

1827_ChibiOS中OSLIB的邮箱机制

全部学习汇总： GreyZhang/g_ChibiOS: I found a new RTOS called ChibiOS and it seems interesting! (github.com) 1. 邮箱其实是一个环形队列； 2. 使用场景上，邮箱主要是用来实现异步单向的一些消息或者数据处理的。在处理机制上&#xff…
阅读更多...
MyBatis 四大核心组件之 StatementHandler 源码解析

MyBatis 四大核心组件之 StatementHandler 源码解析

🚀 作者主页： 有来技术 🔥 开源项目： youlai-mall 🍃 vue3-element-admin 🍃 youlai-boot 🌺 仓库主页： Gitee 💫 Github 💫 GitCode 💖 欢迎点赞…
阅读更多...
Java中的IO流②——字符集、字符流、缓冲流

Java中的IO流②——字符集、字符流、缓冲流

主要的编码规范： GBK编码 Windows自带 Unicode编码 为什么会有乱码？ 原因一 原因二 编码和解码的代码实现 字符流 FileReader read()细节： 一：默认也是一个字节一个字节的读取，如果遇到中文就会一次读取多个 二&a…
阅读更多...
FastAPI请求体-多个参数

FastAPI请求体-多个参数

路径参数、查询参数，和请求体混合 首先，我们需要导入所需的库。我们将使用FastAPI、Path和Annotated来处理路由和参数，并使用BaseModel和Union来自定义数据模型。 完整示例代码 from typing import Annotated, Unionfrom fastapi import F…
阅读更多...
【开源】基于JAVA语言的数字化社区网格管理系统

【开源】基于JAVA语言的数字化社区网格管理系统

项目编号： S 042 ，文末获取源码。 \color{red}{项目编号：S042，文末获取源码。} 项目编号：S042，文末获取源码。 目录 一、摘要1.1 项目介绍1.2 项目录屏 二、功能模块三、开发背景四、系统展示五、核心源码5…
阅读更多...
【工具】JS｜浏览器脚本6分钟极速入门 · 开发一个限制自己刷b站的脚本

【工具】JS｜浏览器脚本6分钟极速入门 · 开发一个限制自己刷b站的脚本

这张图花里胡哨的是让AI生成的，我觉得怪可爱的，就直接作为封面了。 这篇文章中会开发一个JS脚本，这是一个用来限制b站网页版功能的脚本，避免刷b站的时间过长。功能如下： 除了搜索、视频页、私信页之外的任何页都会被重…
阅读更多...
[每周一更]-(第76期)：Go源码阅读与分析的方式

[每周一更]-(第76期)：Go源码阅读与分析的方式

读源码可以深层理解Go的编写方式，理解作者们的思维方式；也有助于对Go语法用法深刻的理解，我们从这一篇说一下如何读源码，从哪些源码着手，从 简单到深入的方式学习源码； 学习源码也是一个修炼过程&#xff0…
阅读更多...
windows下 Tomcat启动黑框隐藏

windows下 Tomcat启动黑框隐藏

进入到 tomcat/bin 目录下，找到此文件 setclasspath.bat ，右键文本打开 找到此属性 ： set _RUNJAVA"%JRE_HOME%\bin\java.exe"修改成以下属性，保存文件，重启启动tomcat会发现黑框不默认弹出了： …
阅读更多...
@德人合科技 | 数据透明加密防泄密系统\文件文档加密\设计图纸加密|源代码加密防泄密软件系统，——防止内部办公终端核心文件数据/资料外泄！

@德人合科技 | 数据透明加密防泄密系统\文件文档加密\设计图纸加密|源代码加密防泄密软件系统，——防止内部办公终端核心文件数据/资料外泄！

一款专业的数据防泄密管理系统，它采用了多种加密模式，包括透明加密、半透明加密和落地加密等，可以有效地保护企业的核心数据安全。 PC端访问地址： https://isite.baidu.com/site/wjz012xr/2eae091d-1b97-4276-90bc-6757c5dfedee …
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023