SpringBoot配置过滤器的方式

╰+攻爆jí腚メ 2024-02-24 08:09 7阅读 0赞

来源：[https://www.cnblogs.com/Timeouting-Study/p/16078773.html][https_www.cnblogs.com_Timeouting-Study_p_16078773.html]

在Spring中，过滤器是配置声明在web.xml文件中的，所有的过滤器在web.xml（web容器的配置文件）中定义，springboot中，web.xml文件消失。各种配置被Java类取代。@Configuration注解标记配置类，代替xml配置文件。

filter的配置也不用在web.xml中。

### 1. 过滤器简介 ###

#### 1. 过滤器是什么？ ####

**Filter**也称之为过滤器,过滤器是对数据进行过滤，预处理。开发人员可以对客户端提交的数据进行过滤处理，比如敏感词，也可以对服务端返回的数据进行处理。还有就是可以验证用户的登录情况，权限验证，对静态资源进行访问控制，没有登录或者是没有权限时是不能让用户直接访问这些资源的。类似的过滤器还有很多的功能，比如说编码，压缩服务端给客户端返回的各种数据，等等。

#### 2. 过滤器的运作原理？ ####

过滤器这么牛逼，那么它的**运作**原理是什么呢？  
 java为我们提供了一个**Filter**接口，我们只需要实现这个接口就能实现自定义过滤器，然后添加一些必要的配置让过滤器生效。过滤器只能初始化一次，并且过滤器只会在项目停止或者是重新部署的时候才销毁。我们可以实现的这个Filter接口，里面最重要的是一个**doFilter**方法，当我们编写好Filter，并配置好对那个URL资源进行拦截时，每一次请求这个资源之前就会调用这个doFilter方法。并且在这个doFilter方法里面也有着一个**FilterChain**的对象参数 ,这个对象里面也有一个doFilter方法，是否调用这个方法决定了这个过滤器是否能调用后面的资源或者是执行后面的过滤器。也就是相当于目标资源。所以在过滤器里面可以进行一些什么操作呢？可以在调用目标资源之前，进行权限等的处理；判断是否调用目标资源；也可以在调用目标资源之后进行一些响应消息进行处理。

### 2. 过滤器配置的两种方法 ###

#### 1. 注解配置 @WebFilter+包扫描**@ServletComponentScan("com.example.demofilter.filter")**， ####

首先我们定义一个MyFilter 实现Filter接口。重写里面的三个方法

@Order(1)
    @WebFilter(filterName = "myFilter1",urlPatterns = {"/*"})
    public class MyFilter implements Filter {
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
            System.out.println("初始化过滤器");
        }
    
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
            System.out.println("进入目标资源之前先干点啥");
            filterChain.doFilter(servletRequest,servletResponse);
            System.out.println("处理一下服务端返回的response");
        }
    
        @Override
        public void destroy() {
            System.out.println("过滤器被销毁了");
        }

代码说明：

1.**@WebFilter**注解，**filterName**属性表示filter的名称，**urlPatter**表示要拦截的URL资源，可以是一个或者多个。用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性，但是 value、urlPatterns、servletNames 三者必需至少包含一个，且 value 和 urlPatterns 不能共存，如果同时指定，通常忽略 value 的取值 )

2.**@Order(1)**表示如果有多个拦截器的话就是设置这个拦截器的运行等级，数字越小，越先执行

3.**init()**方法只会执行一次，初始化过滤器。

4.**doFilter()**核心方法，配置过滤器的逻辑代码。

5.**destroy()**只会在项目停止或者是项目重新部署的时候才会执行。

配置完上面的之后我们还需要在启动类加上一个扫描包的注解，开启包扫描。**@ServletComponentScan("com.example.demofilter.filter")**，当然你也可以不用写包的具体地址，不传参数，但是建议是传参数，并且这个采参数也可以传多个的。

以上就完成了一个Filter的基本配置，运行项目即可看到效果，还有一种非注解形式的配置方式。

#### 2. java配置 ####

我们可以通过自己定义一个java配置文件，将自定义的Filter 注册到到**FilterRegistrationBean**里面。

@Configuration
    public class FilterConfig {
        @Bean
        public FilterRegistrationBean registFilter(){
            FilterRegistrationBean registrationBean = new FilterRegistrationBean();
            registrationBean.setFilter(new MyFilter());
            registrationBean.addUrlPatterns("/*");
            registrationBean.setName("Filter1");
            registrationBean.setOrder(1);
            return registrationBean;
        }
    }

这个配置和上面的注解配置类似。上面注解实现的原理也是这样的，虽然是两种不同的方法，但是是一样的原理。

### 3. 测试编写与结果 ###

controller代码编写

@RestController
    @RequestMapping("/Filter")
    public class FilterController {
        @RequestMapping("/testFilter")
        public String testFilter(){
            System.out.println("filter执行成功");
            return "filter";
        }
    }
    
    完成之后启动项目，访问接口：localhost:8098/Filter/testFilter,观察控制台运行结果。

![a802ad0e641a66d3d3733baf107a2bd2.png][]

[https_www.cnblogs.com_Timeouting-Study_p_16078773.html]: https://www.cnblogs.com/Timeouting-Study/p/16078773.html
[a802ad0e641a66d3d3733baf107a2bd2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/24/09f43be8ed73464281172047830b3842.png