SpringBoot 中Filter的作用以及使用

最新推荐文章于 2025-04-12 10:36:17 发布
转载 最新推荐文章于 2025-04-12 10:36:17 发布
· 902 阅读 · 3 ·
版权
原文链接：https://blog.youkuaiyun.com/qq_43483502/article/details/107733067
文章标签：

#java

本文详细介绍了SpringBoot中Filter的作用和使用方法，包括@WebFilter注解和@Bean注解的配置方式。通过实例展示了如何设置过滤规则，实现请求预处理和响应后处理，以及过滤器的优先级控制。同时还提供了过滤器的初始化、执行和销毁过程的代码示例。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

SpringBoot 中Filter的作用以及使用
1、Filter的作用

Filter使用户可以改变一个 request和修改一个response.
Filter 不是一个servlet,它不能产生一个response,它能够在一个request到达servlet之前预处理request,也可以在离开 servlet时处理response.
换种说法,filter其实是一个”servlet chaining”(servlet 链).
通俗点说法filter相当于加油站，request是条路，response是条路，
目的地是servlet，这个加油站设在什么地方对什么数据操作可以由你来控制。
1
2
3
4
5
Filter过滤器实现的是javax.servlet.Filter接口的类，而在javax.servlet.Filter中定义了以下三个方法：

init(FilterConfig fConfig)
init()方法用来初始化过滤器，可以在init()方法中获取Filter中的初始化参数。
@Override
public void init(FilterConfig filterConfig) throws ServletException {
//用来获取Filter中初始化的参数
}
1
2
3
4
doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
doFilter()方法完成过滤操作。当请求发过来的时候，过滤器将执行doFilter方法。
在HttpServletRequest 执行doFilter()之前，根据需要检查 HttpServletRequest ，同时也可以修改HttpServletRequest 请求头和数据。
在HttpServletResponse 执行doFilter()之后，根据需要检查 HttpServletResponse ，同时也可以修改HttpServletResponse响应头和数据。
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println(“进行过滤以及逻辑判断操作”);
filterChain.doFilter(servletRequest,servletResponse);
}

1
2
3
4
5
6
destroy()
Filter对象创建后会驻留在内存，当web应用移除或服务器停止时调用destroy()方法进行销毁。在Web容器卸载 Filter 对象之前被调用。destroy()方法在Filter的生命周期中仅执行一次。通过destroy()方法，可以释放过滤器占用的资源。
@Override
public void destroy() {
//销毁Filter对象,Filter生命周期结束
}
1
2
3
4
上来我们先创建一个小demo 然后我们再讲解其中的原理
我们在IDEA中创建一个SpringBoot的基础项目（这里不介绍这么创建了）

一、这里采用的@WebFilter注解过滤
目录结构

@Order(x)x越小优先级 越高
@WebFilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。**该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性，但是 value、urlPatterns、servletNames 三者必需至少包含一个，且 value 和 urlPatterns 不能共存，如果同时指定，通常忽略 value 的取值 )

package cn.tll.config;

import org.springframework.core.annotation.Order;

import javax.servlet.*;
import javax.servlet.FilterConfig;
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**

  • @author tll

  • @create 2020/8/1 12:41

  • @Order(x) 里面的数越小 越优先执行

  • @WebFilter() 代表着这是个Filter类 并把它注入到容器中
    */
    @Order(1)
    @WebFilter(initParams = {@WebInitParam(name = “nofilter”,value = “/one,/two”)})
    public class FirstFilter implements Filter {

    /**

    • 不过滤的资源
      */
      private String[] nofilter;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    //将不过滤的资源存入数组中
    String nofilterString = filterConfig.getInitParameter(“nofilter”);
    if (nofilterString!=null&&nofilterString.length()>0){
    nofilter = nofilterString.split(",");
    }

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    HttpServletRequest request = (HttpServletRequest) servletRequest;
    boolean flag = isNofilter(request);
    if (flag){
    filterChain.doFilter(servletRequest,servletResponse);
    }else {
    request.getRequestDispatcher("/forword").forward(servletRequest,servletResponse);
    }

    }

    @Override
    public void destroy() {

    }
    /**
    *isNofilter 判断路径是否不需要过滤
    */
    public boolean isNofilter(HttpServletRequest request){
    String requestURI = request.getRequestURI();
    System.out.println(requestURI);
    for (String s : nofilter) {
    if (requestURI.contains(s)){
    return true;
    }
    }
    return false;
    }
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
Controller中的代码
这里的@RestController注解作用就不用多说了

package cn.tll.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**

  • @author tll

  • @create 2020/8/1 12:48
    */
    @RestController
    public class IndexController {

    @RequestMapping({"/","/index"})
    public String index(){
    return “访问成功”;
    }

    @RequestMapping("/forword")
    public String forword(){
    return “请先登录”;
    }

    @RequestMapping("/one")
    public String one(){
    return “one”;
    }

    @RequestMapping("/two")
    public String two(){
    return “two”;
    }
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
最后千万不要忘了在启动类上加上@ServletComponentScan
注：@ServletComponentScan注解的含义在SpringBootApplication(启动类)上使用@ServletComponentScan注解后，Servlet、Filter(过滤器)、Listener(监听器)可以直接通过@WebServlet、@WebFilter、@WebListener注解自动注册，无需其他代码！

package cn.tll;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

/**

  • 因为使用的是注解Filter 所以需要在程序入口加入@ServletComponentScan

*/
@SpringBootApplication
@ServletComponentScan
public class SpringbootFilterApplication {

public static void main(String[] args) {
    SpringApplication.run(SpringbootFilterApplication.class, args);
}

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
二，@Bean注解方式
我们还是先创建一个干净的SpringBoot项目吧

首先把Controller写好 先测试一下有无问题

package cn.tll.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**

  • @author tll

  • @create 2020/8/2 8:51
    */
    @RestController
    public class IndexController {

    @RequestMapping({"/","/index"})
    public String index(){
    return “欢迎进入首页”;
    }

    @RequestMapping(“noRoot”)
    public String noRoot(){
    return “对不起,请先登录”;
    }

    @RequestMapping("/one")
    public String one(){
    return “one”;
    }

    @RequestMapping("/two")
    public String two(){
    return “two”;
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

好的没问题
再创建一个WebConfig

package cn.tll.config;

import cn.tll.filter.FirstFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**

  • @author tll

  • @create 2020/8/2 8:57
    */
    @Configuration
    public class WebConfig {

    @Bean
    public FilterRegistrationBean filterRegistrationBean(){
    FilterRegistrationBean registrationBean = new FilterRegistrationBean(new FirstFilter());
    //过滤所有路径
    registrationBean.addUrlPatterns("/*");
    //添加不过滤路径
    registrationBean.addInitParameter(“noFilter”,"/one,/two");
    registrationBean.setName(“firstFilter”);
    registrationBean.setOrder(1);
    return registrationBean;
    }

    @Bean
    public FilterRegistrationBean twoFilterRegistrationBean(){
    FilterRegistrationBean registrationBean = new FilterRegistrationBean(new TwoFilter());
    registrationBean.setOrder(2);
    registrationBean.addUrlPatterns("/*");
    registrationBean.setName(“TwoFilter”);
    return registrationBean;
    }
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
接着就是创建Filter了
这里创建两个Filter主要是用于查看setOrder优先级是否有用
Order(x) 里面的x数值越小优先级越高

package cn.tll.filter;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**

  • @author tll

  • @create 2020/8/2 9:00
    */
    public class FirstFilter implements Filter {

    private String[] noFilters;

    /**

    • 过滤器初始化
    • @param filterConfig
    • @throws ServletException
      */
      @Override
      public void init(FilterConfig filterConfig) throws ServletException {
      String noFilter = filterConfig.getInitParameter(“noFilter”);
      if (noFilter!=null&&noFilter.length()>0){
      noFilters = noFilter.split(",");
      }
      }

    /**

    • 过滤器方法
    • @param servletRequest
    • @param servletResponse
    • @param filterChain
    • @throws IOException
    • @throws ServletException
      */
      @Override
      public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
      System.out.println(“这里是FirstFilter”);
      HttpServletRequest request = (HttpServletRequest) servletRequest;
      boolean flag = isFilter(request);
      if (flag){
      System.out.println(“可以访问”);
      filterChain.doFilter(servletRequest,servletResponse);
      }else {
      System.out.println(“不可以访问”);
      //没有权限不可以访问，需要转发到友好界面
      request.getRequestDispatcher("/noRoot").forward(servletRequest,servletResponse);
      }
      }

    /**

    • 过滤器销毁
      */
      @Override
      public void destroy() {

    }

    /**

    • 判断URL是否包含不过滤的路径

    • @param request

    • @return
      */
      public boolean isFilter(HttpServletRequest request){
      String requestURI = request.getRequestURI();
      for (String noFilter : noFilters) {
      System.out.println(noFilter);
      if (requestURI.contains(noFilter)){
      return true;

       }

      }
      return false;
      }
      }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
package cn.tll.filter;

import javax.servlet.*;
import java.io.IOException;

/**

  • @author tll

  • @create 2020/8/2 9:23
    */
    public class TwoFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    System.out.println(“这里是TwoFiter”);
    filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {

    }
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
大功告成，你觉得那种方法简单呢？
源码地址
@WebFilter注解开发

@Bean注解开发源码
————————————————
版权声明：本文为优快云博主「天亮再出发」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.youkuaiyun.com/qq_43483502/article/details/107733067

SpringBoot之Filter详解
yyy0224的博客
03-16 786
上篇分析了Interceptor（拦截器），今天继续对Filter（过滤器）做一个分析。 何为过滤器 Filter是J2EE中来的，可以看做是Servlet的一种“加强版”，它主要用于对用户请求进行预处理和后处理，拥有一个典型的处理链。Filter也可以对用户请求生成响应，这一点与Servlet相同，但实际上很少会使用Filter向用户请求生成响应。使用Filter完整的流程是：Filter对用户...
SpringBoot中使用Filter和Interceptor的示例代码
08-25
SpringBoot中使用Filter和Interceptor的示例代码 在SpringBoot框架中，Filter和Interceptor是两个非常重要的概念，它们都可以用来拦截和处理HTTP请求，但是它们的实现机制和使用场景却有所不同。下面将详细介绍...
SpringBoot中Filter的作用和应用场景
全栈工程师，热爱编程，喜欢探索各种技术栈。分享前端、后端、数据库等技术学习心得，以及在项目开发中的实践经验。
04-27 514
Filter是Servlet规范中的一部分，它允许开发者在HTTP请求到达目标资源之前或者响应返回客户端之前对请求和响应进行预处理和后处理。在Spring Boot中，Filter可以通过简单的配置和自定义来添加到应用中。
【Spring Boot 过滤器】
最新发布
武帝为此的博客
04-12 1323
在Web开发中，我们常常需要对请求做一些统一的处理，例如：请求日志记录、权限验证、跨域处理等。Spring Boot 中除了可以使用拦截器（Interceptor）和AOP，还可以使用过滤器（Filter）。Filter是 Servlet 规范中的一个组件，用于在请求到达 Servlet 之前或响应返回客户端之前进行预处理或后处理。请求日志记录用户认证与权限检查参数过滤与包装编码设置防止 XSS 攻击等它的核心接口是。
SpringBoot中的Filter的作用以及使用@WebFilter注解过滤
weixin_51656756的博客
11-30 4841
过滤器的作用     通过这个图我们可以知道，浏览器对服务器的请求会先经过过滤器再到达服务器，服务器对浏览器的响应也会先经过过滤器，最后再响应给浏览器，基于过滤器的机制我们可以在过滤器中对请求和响应做一些处理，可以在过滤器中决定是否放行，例如：校验请求中有没有敏感字符串，校验请求中有没有Session。     Filter是依赖于Servlet容器，属于Servlet规范的一部分，Filter的执行由Servlet回调完成，.
SpringBoot_过滤器（Filter）
骑大马挎大刀
02-27 3960
通过过滤器（Filter），可以实现用户访问某个资源前，对访问的请求和响应进行过滤。 一：原理：在实现上基于函数回调，可以对几乎所有请求进行过滤，但是缺点是一个过滤器实例只能在容器初始化时调用一次。使用过滤器的目的是用来做一些过滤操作，获取我们想要的数据。比如在过滤器中修改字符编码；在过滤器中修改HttpServletRequest的一些参数，包括低俗文字，危险字段等。 二：过滤器调用顺序： Filter——>Interceptor——>Aspect——>Controller 当Contr
SpringBoot里面Filter讲解
nonpricklycactus的博客
08-26 538
filter简单理解： 过滤器实际上就是对web资源进行拦截，做一些处理后再交给下一个过滤器或servlet处理 通常都是用来拦截request进行处理的，也可以对返回的response进行拦截处理。 大概流程图如下: 应用场景: 自动登录 统一设置编码格式 访问权限控制 敏感字符过滤等 SpringBoot启动默认加载的Filter ...
springboot使用filter获取自定义请求头的实现代码
08-26
在 Spring Boot 中，可以使用 Filter 来获取自定义请求头。例如，下面是一个获取 token、id 和 role 的 Filter 实现： ```java public class TokenFilter implements Filter { @Override public void doFilter...
SpringBoot拦截器Filter的使用方法详解
08-19
本文主要介绍如何在SpringBoot中使用拦截器和过滤器，以及它们之间的区别。 首先，要使用拦截器或过滤器，需要在项目中添加对应的依赖。以Maven项目为例，pom.xml文件中需要添加Spring Boot Starter Web依赖，以及...
springboot中filter的用法详解
08-28
在 Spring Boot 中，Filter 的用法与传统的 Java Web 应用程序类似，但是在配置和使用上有一些差异。 一、Filter 的功能 Filter 的主要功能是对请求和响应进行过滤和修改。它可以在 Servlet 之前或之后执行某些...
SpringBoot的Filter过滤器
11-26
1. 使用`@WebFilter`注解：这是一个Servlet API中的注解，可以直接在`Filter`类上使用，指定过滤的URL模式。 ```java import javax.servlet.annotation.WebFilter; @WebFilter(filterName = "myFilter", ...
Springboot中使用过滤器映射访问路径
12-23
Springboot中使用过滤器映射访问路径，并对请求地址进行重定向。
Spring Boot：注册请求过滤器FilterRegistrationBean处理特定请求
Crane的博客
05-18 1万+
在SpringBoot中，FilterRegistrationBean类用来在Servlet容器执行请求过程中过滤一些特定的请求，并对请求的请求内容和响应结果做一些处理，例如权限拦截验证、访问日志、响应格式化等等。 你可以认为是在服务端接收到请求和返回请求结果到调用方这两个过程中间做一些自定义的操作。 下面的案例记录如何在原有请求中增加额外的请求参数。 1 添加请求包装类 先创建一个工具类RequestParameterWrapper继承自HttpServletRequestWrapper，并重写getPa
简单聊一下自定义的SpringBoot排除器
weixin_61350295的博客
11-03 309
这里简单说一下，大家都应该都用过SSM,也就是Spring,SpringMVC,Mybatis，那整合这三个就是大家所熟悉的SSM,所以里面会有很多的配置文件，Spring的配置文件----Spring.xml（名字不固定）,mybatis的配置文件,SpringMVC的配置文件，相信大家已经配到快奔溃了（我也是这么过来的）。
Spring Boot 过滤器Filter
KingCruel的专栏
01-14 908
过滤器（Filter） 过滤器Filter是依赖于Servlet容器，属于Servlet规范的一部分； 过滤器Filter的执行由Servlet容器回调完成； 过滤器Filter的生命周期由Servlet容器管理； 过滤器Filter可以拿到原始的http请求，但是拿不到请求的控制器和请求控制器中的方法的信息； 1、@Order(1)：表示过滤器的顺序； 2、@WebFilter：表示这个class是过滤器。 filterName：过滤器名字； urlPatterns：过滤器的范围； initParams：
Springboot中跳过指定过滤器
huanghong.top
03-13 2894
是过滤器定义，filterDef中的FilterClass和FilterName保存了过滤器类和过滤器名，可以根据过滤器类或名字找到要剔除的过滤器，然后将对应的ApplicationFilterConfig 从数组里剔除就可以了。)，filters中存放的是ApplicationFilterConfig 是FilterConfig的实现类，ApplicationFilterConfig中。filterChain有一个filters的属性数组(
springboot排除扫描包
热门推荐
做你想做的人，没有时间的限制，只要愿意，什么时候都可以start。
10-25 1万+
@SpringBootApplication @ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.REGEX,pattern = "com.action.other.*") }) public class Application { public static void ma...
Springboot配置过滤器&拦截器
aidiaotoufa_001的博客
07-05 649
Springboot配置过滤器和拦截器如下图，当请求过来后，首先会由tomcat接收，....
SpringBoot中Filter的使用和原理
qq_44918331的博客
05-18 837
​ 先把SpringBoot中filter的使用示例写出来，然后再解释下代码、说一下运行的顺序，最后讲一下filter的原理（其实就是责任链设计模式，从马士兵老师那里偷来的。。。） ​ 要想使用filter，需要写一个方法继承Filter类，我们写如下两个自己的Filter类，首先是FirstFilter类，其中@Order里边的数字越小代表越先被该Filter过滤，@WebFilter代表这是个Filter类并把这个类注入到容器中： package com.example.executor_test.fi
springboot中filter的使用
04-11
在Spring Boot中，可以使用Filter过滤器来处理HTTP请求和响应。Filter过滤器可以在请求被发送到Controller之前或响应返回给客户端之前拦截处理。例如，可以使用Filter过滤器进行身份验证、日志记录、异常处理等操作...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值