登录/ 注册
 找回密码
 立即注册
关闭

CSDN热搜

程序园 精品问答 技术交流 资源下载
返回列表 发新帖
首页 › 资源区 › 代码 ›SpringBoot过滤器

SpringBoot过滤器

孜稞 2025-5-29 10:50:23
一、概述

1.1 含义

过滤器是Web三大组件之一，也是项目中常用的工具。过滤器由Servlet提供，基于函数回调实现链式对网络请求和响应的拦截与修改。由于基于Servlet，几乎可以拦截Web服务器管理的所有资源（JSP、图片文件、HTML文件、CSS文件等）。
定义过滤器需要实现javax.servlet.Filter接口。过滤器不是Servlet，无法直接生成对客户端的响应，只能拦截已有请求并预处理不需要或不一致的信息资源。
1.2 流程原理

在Web应用中，可以开发编写多个过滤器，这些过滤器组合称为过滤器链。用户发起请求后，请求信息会按过滤器链中过滤器的顺序依次进入每个过滤器。经过每层过滤器时，需通过过滤器的校验逻辑并放行才能进入下一层过滤器，直至服务器获取资源。服务器成功获取资源并响应过滤器后，会按反向顺序经过层层过滤器，最终响应用户。
1.png

1.3 分类

Servlet 2.5:

  • REQUEST: 用户直接访问页面时，WEB容器会调用过滤器链。
  • FORWARD: 通过RequestDispatcher的forward访问目标资源时调用此过滤器。
  • INCLUDE: 通过RequestDispatcher的include方法调用目标资源时调用。
  • ERROR: 通过声明式异常处理机制调用目标资源时调用过滤器链。
Servlet 3.0:

  • ASYNC: 支持异步处理。
二、定义过滤器

返回值类型方法声明描述voiddoFilter(ServletRequest request, ServletResponse response, FilterChain chain)实现实际过滤操作。当客户端请求方法与过滤器设置的URL匹配时，Servlet容器会先调用过滤器的doFilter方法。FilterChain用于访问后续过滤器。voidinit(FilterConfig filterConfig)Web应用启动时，Web服务器创建过滤器实例对象并调用其init方法完成对象初始化（过滤器对象仅创建一次，init方法仅执行一次）。开发者可通过init方法参数执行读取配置文件等初始化操作。voiddestroy()Servlet容器销毁过滤器实例前调用此方法。用于释放过滤器占用的资源。

  • request: 代表客户端的请求对象。
  • response: 代表服务器向客户端发送的响应对象。
  • chain: 用于调用下一个Filter或目标Servlet的FilterChain对象。
三、使用过滤器

3.1 注解方式

创建步骤：

  • 实现Filter接口，添加@WebFilter和@Order注解配置过滤器：
    1. @Order(1)
    2. @WebFilter(filterName = "myFilter", urlPatterns = {"*"})
    3. public class MyCustomFilter1 implements Filter {
    4.     @Override
    5.     public void init(FilterConfig filterConfig) throws ServletException {}
    7.     @Override
    8.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
    9.                          FilterChain filterChain) {
    10.         //TODO...
    11.     }
    13.     @Override
    14.     public void destroy() {}
    15. }
    复制代码
  • 在启动类添加@ServletComponentScan注解：
    1. @SpringBootApplication
    2. @ServletComponentScan
    3. public class Application {
    4.     public static void main(String[] args) {
    5.         SpringApplication.run(Application.class, args);
    6.     }
    7. }
    复制代码
3.2 注册Bean方式


  • 创建实现Filter接口的过滤器类：
    1. public class MyCustomFilter2 implements Filter {
    3.     @Override
    4.     public void init(FilterConfig filterConfig) throws ServletException { }
    6.     @Override
    7.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
    8.                          FilterChain filterChain) {
    9.         //TODO...
    10.     }
    12.     @Override
    13.     public void destroy() { }
    14. }
    复制代码
  • 创建过滤器配置类，注册过滤器：
    1. @Configuration
    2. public class FilterConfig {
    3.     @Bean
    4.     public FilterRegistrationBean customFilter(){
    5.         FilterRegistrationBean<MyCustomFilter2> filterBean = new FilterRegistrationBean<>();
    6.         filterBean.setFilter(new MyCustomFilter2());
    7.         filterBean.setName("myFilter");
    8.         filterBean.addUrlPatterns("/*");
    9.         return filterBean;
    10.     }
    11. }
    复制代码
四、注解方式

4.1 参数说明

@WebFilter可配置多个参数，部分参数说明如下：
参数名称参数类型参数描述descriptionString设置过滤器的描述信息displayNameString要显示的过滤器名称initParamsWebInitParam[]你可以在初始化时配置一些参数filterNameString过滤器的名称servletNamesString[]设置要过滤的ServletsvalueString[]urlPatterns属性与urlPatterns属性的作用相同，两者都指定要拦截的路径urlPatternsString[]指定要拦截的路径dispatcherTypesDispatcherType[]设置过滤器过滤的请求类型。
支持以下属性：REQUEST（默认情况下，它过滤所有类型的请求）,
ASYNC, ERROR, FORWARD, INCLUDEasyncSupportedboolean设置过滤器是否支持异步模式4.2 使用示例

(1) 创建Controller类
  1. @RestController
  2. public class TestController {
  4.     @GetMapping("/a/hello")
  5.     public String hello1() {
  6.         return "hello world! a";
  7.     }
  9.     @GetMapping("/b/hello")
  10.     public String hello2() {
  11.         return "hello world! b";
  12.     }
  14.     @GetMapping("/c/hello")
  15.     public String hello3() {
  16.         return "hello world! c";
  17.     }
  18. }
复制代码
(2) 创建过滤器类
  1. @Order(1)
  2. @WebFilter(filterName = "myFilter", urlPatterns = {"/a/*", "/b/*"}, description = "自定义过滤器")
  3. public class MyCustomFilter2 implements Filter {
  5.     @Override
  6.     public void init(FilterConfig filterConfig) {
  7.         System.out.println("过滤器初始化");
  8.     }
  10.     @Override
  11.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
  12.             throws IOException, ServletException {
  13.         System.out.println("请求处理前...");
  14.         chain.doFilter(request, response);  // 放行请求
  15.         System.out.println("请求处理后...");
  16.     }
  18.     @Override
  19.     public void destroy() {
  20.         System.err.println("过滤器销毁");
  21.     }
  22. }
复制代码
(3) 创建启动类
  1. @SpringBootApplication
  2. @ServletComponentScan
  3. public class Application {
  4.     public static void main(String[] args) {
  5.         SpringApplication.run(Application.class, args);
  6.     }
  7. }
复制代码
五、注册Bean方式

5.1 方法参数说明

方法名称方法描述setName()设置过滤器的名称。setFilter()设置要注册的过滤器。setOrder()设置过滤器的顺序位置。setAsyncSupported()设置过滤器是否支持异步模式。addUrlPatterns()添加拦截的路径。setUrlPatterns()设置拦截的路径。addServletNames()添加过滤器的servlet名称。setServletNames()设置注册过滤器的servlet名称。setInitParameters()设置初始化参数。addInitParameter()添加初始化参数。setMatchAfter()设置是否在Servlet上下文中声明的任何过滤器映射之后匹配过滤器映射。setDispatcherTypes()设置过滤器过滤的请求类型。
支持的属性如下：REQUEST（默认情况下，它过滤所有类型的请求）,
ASYNC, ERROR, FORWARD, INCLUDE。5.2 使用示例

(1) 创建Controller类
  1. @RestController
  2. public class TestController {
  4.     @GetMapping("/a/hello")
  5.     public String hello1(){
  6.         return"hello world! a";
  7.     }
  9.     @GetMapping("/b/hello")
  10.     public String hello2(){
  11.         return"hello world! b";
  12.     }
  14.     @GetMapping("/c/hello")
  15.     public String hello3(){
  16.         return"hello world! c";
  17.     }
  18. }
复制代码
(2) 创建过滤器类
  1. public class MyCustomFilter1 implements Filter {
  3.     @Override
  4.     public void init(FilterConfig filterConfig) {
  5.         System.out.println("过滤器初始化");
  6.     }
  8.     @Override
  9.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
  10.             throws IOException, ServletException {
  11.         System.out.println("请求处理前...");
  12.         chain.doFilter(request, response);  // 放行请求
  13.         System.out.println("请求处理后...");
  14.     }
  16.     @Override
  17.     public void destroy() {
  18.         System.err.println("过滤器销毁");
  19.     }
  20. }
复制代码
(3) 创建过滤器配置类
  1. @Configuration
  2. public class FilterConfig {
  3.     @Bean
  4.     public FilterRegistrationBean customFilter() {
  5.         FilterRegistrationBean<MyCustomFilter1> filterBean = new FilterRegistrationBean<>();
  6.         filterBean.setFilter(new MyCustomFilter1());
  7.         filterBean.setName("FilterController");
  8.         filterBean.addUrlPatterns("/c/*", "/b/*");
  9.         return filterBean;
  10.     }
  11. }
复制代码
(4) 创建启动类
  1. @SpringBootApplication
  2. @ServletComponentScan
  3. public class Application {
  4.     public static void main(String[] args) {
  5.         SpringApplication.run(Application.class, args);
  6.     }
  7. }
复制代码
六、使用场景


  • 日志记录
    过滤器可记录请求和响应的关键信息，便于排查问题和分析系统运行状态。例如记录请求URL、参数、响应状态码等。
  • 数据统计
    用于采集各类数据指标，如统计请求次数、响应时间分布等，为系统优化提供依据。
  • 数据格式转换
    不同系统交互时，过滤器可转换数据格式，例如将JSON转为XML。
  • 为数据设置默认值
    检查输入数据，为缺失字段设置默认值，保证数据完整性。
  • 权限认证、黑白名单
    实现用户权限认证和访问控制，限制特定IP或用户的访问。
  • 数据加解密、签名验证
    对敏感数据加解密以保证安全，同时进行签名验证确保数据完整性。

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

使用道具 举报
相关推荐
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册
发帖
孜稞
2025-5-29 10:50:23

0

粉丝关注

8

主题发布

板块介绍填写区域，请于后台编辑
微信扫一扫