Spring-Boot使用嵌入式容器，那怎么配置自定义Filter呢

Listener、Filter和Servlet是Java Web开发过程中常用的三个组件，其中Filter组件的使用频率最高，经常被用来做简单的权限处理、请求头过滤和防止XSS攻击等。如果我们使用的是传统的Spring MVC进行开发，那么只需要在Tomcat的web.xml文件中进行如下配置即可：

<!-- 配置Listener -->
<listener>
    <listener-class>org.springframework.web.util.WebAppRootListener</listener-class>
</listener>
<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener> 

<!--配置Filter，这边配置了一个Filter，但是匹配了多个url-pattern-->
<!-- 以url-partern方式配置的filter中，如果有多个与当前请求匹配，则按web.xml中filter-mapping出现的顺序来运行-->
<filter>
    <filter-name>filter1</filter-name>
    <filter-class>com.csx.MyFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>filter1</filter-name>
    <url-pattern>/url/a/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>filter1</filter-name>
    <url-pattern>/url/b/*</url-pattern>
</filter-mapping>

<!--配置Servlet-->
<servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:springmvc.spring.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <!-- 这边不建议写成/* -->
    <url-pattern>/</url-pattern>
</servlet-mapping>

PS：在容器启动的时候，上面三个组件启动的顺序是Listener --> Filter --> Servlet，这边安利一个记忆的方法：把启动顺序记忆成“理（Listener）发（Filter）师（Servlet）”即可。

在web.xml中配置这三个组件比较简单，但是使用Spring-Boot开发时使用的是嵌入式容器，并没有web.xml文件让我们进行配置。那么在Spring-Boot中到底要怎么配置Listener、Filter和Servlet等组件呢？

本篇博客以Filter为列，介绍下在Spring-Boot中怎么配置Listener、Filter和Servlet等组件。

方式一：将Filter声明为bean

这边我们先来自定义一个Filter，这个Filter的作用是统计一个接口的调用时间。

public class TimeConsumingCalculationFilter implements Filter {

        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            HttpServletRequest httpRequest=(HttpServletRequest)request;
            long startTime = System.nanoTime();
            logger.info(">>>>>>> Begin ["+httpRequest.getRequestURI()+"]...");
            try{
                chain.doFilter(request, response);
            }finally {
                long endTime = System.nanoTime();
                logger.info(">>>>>>> End ["+httpRequest.getRequestURI()+"]["+(endTime-startTime)/1000/1000.0+"ms].");
            }
        }

    }

在Spring-Boot中配置上面的Filter，我们只需要在@Configuration文件中做如下配置即可：

@Configuration
public class WebConfig {

    private static Logger logger = LoggerFactory.getLogger(WebConfig.class);

    @Bean
    public Filter filter1(){
        return new TimeConsumingCalculationFilter();
    }
}

上面的Filter默认会拦截所有请求。假如我们想要配置多个拦截器的话，只要再加一个Bean方法就可以了。

@Configuration
public class WebConfig {

    private static Logger logger = LoggerFactory.getLogger(WebConfig.class);

    @Bean
    public Filter filter1(){
        return new TimeConsumingCalculationFilter();
    }

    @Bean
    public Filter filter2() {
        return new TimeConsumingCalculationFilter2();
    }
}

上面的配置代码配置了两个Filter，两个Filter默认都会拦截所有请求，拦截的顺序是：filter1-->filter2。这边的逻辑是先配置的Filter先拦截，后配置的Filter后拦截。当然，如果我们想明确指定拦截顺序的话可以借助@Order注解。但是需要注意的是这个注解一定要加在定义的类上面。

@Order(Ordered.LOWEST_PRECEDENCE - 2)
public class TimeConsumingCalculationFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
       //your logic
    }

}
@Order(Ordered.LOWEST_PRECEDENCE - 1)
public class TimeConsumingCalculationFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
       //your logic
    }

}

PS: @Order中的value值越大，执行的优先级越小。值越小，优先级越大。当我们自定义执行顺序的时候，建议使用@Order(Ordered.LOWEST_PRECEDENCE - 1)这种形式配置，Ordered.LOWEST_PRECEDENCE减去的值越大，优先级越高，这样看起来比较直观。

另外，Spring还提供了一个OrderedFilter接口，这个接口是Filter和Ordered的组合接口，原理和上面的是一样的。大家可以看情况使用。

上面的这种配置方式优点是配置起来非常简单，但是缺点也比较明显，就是配置不够灵活，默认会拦截所有请求。

方式二：@WebFilter方式

@WebFilter注解是Servlet中提供的注解，Spring也支持这个注解。@WebFilter能进行细粒度的进行配置，比上面的方式更加灵活。

@Configuration
public class WebConfig {
    //可以自定义url-pattern
    @WebFilter(urlPatterns="/*")
    @Order(Ordered.LOWEST_PRECEDENCE - 2)
    //这边如果不加`@Configuration`,需要通过`@ServletComponentScan`扫描`Listener`、`Filter`和`Servlet`这三个组件
    @Configuration
    public class TimeConsumingCalculationFilter implements Filter {

        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            //your logic
        }
    }   

    @WebFilter(urlPatterns="/*")
    @Order(Ordered.LOWEST_PRECEDENCE - 2)
    //这边如果不加`@Configuration`,需要通过`@ServletComponentScan`扫描`Listener`、`Filter`和`Servlet`这三个组件
    @Configuration
    public class TimeConsumingCalculationFilter2 implements Filter {

        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            //your logic
        }
    }   

}

通过 @WebFilter 注解的方式配置Filter简单，而且能够自定义url-pattern和拦截顺序。

方式三：使用FilterRegistrationBean配置

@Configuration
public class WebConfig {

    private static Logger logger = LoggerFactory.getLogger(WebConfig.class);

    @Bean
        public FilterRegistrationBean<Filter> filter1() {
            FilterRegistrationBean<Filter> registrationBean = new FilterRegistrationBean<>();
            registrationBean.setName("filter1");
            registrationBean.setOrder(Ordered.LOWEST_PRECEDENCE - 2);
            registrationBean.setFilter(new TimeConsumingCalculationFilter());
            registrationBean.addUrlPatterns("/foo/*");
            return registrationBean;
        }

        @Bean
        public FilterRegistrationBean<Filter> filter2() {
            FilterRegistrationBean<Filter> registrationBean = new FilterRegistrationBean<>();
            registrationBean.setName("filter2");
            registrationBean.setOrder(Ordered.LOWEST_PRECEDENCE - 3);
            registrationBean.setFilter(new TimeConsumingCalculationFilter1());
            registrationBean.addUrlPatterns("/*");
            registrationBean.addInitParameter("key1","value1");
            registrationBean.addInitParameter("key2","value2");
            //通过Servlet name匹配Filter，不建议使用
            registrationBean.addServletNames("name1");
            return registrationBean;
        }

}

注意点：

  • FilterRegistrationBean 与 Filter 之间是一对一关系。
  • 如果存在多个 FilterRegistrationBean 需要调用其 setName(String name) 为其声明唯一名称，否则只有第一个注册成功的有效。
  • 如果需要保证调用顺序可通过调用其 setOrder(int order) 方法进行设置。

方式四：使用DelegatingFilterProxyRegistrationBean方式

@Configuration
public class WebConfig {

    @Bean("myFilter")
    //配置了DelegatingFilterProxyRegistrationBean后,这种方式配置的Filter不会生效了，只会拦截/foo/*的请求
    public Filter myFilter(){
        return new TimeConsumingCalculationFilter();
    }

    @Bean
    public DelegatingFilterProxyRegistrationBean delegatingFilterProxyRegistrationBean(){
        DelegatingFilterProxyRegistrationBean filterProxy = new DelegatingFilterProxyRegistrationBean("myFilter");
        filterProxy.addUrlPatterns("/foo/*");
        filterProxy.addInitParameter("targetFilterLifecycle","true");
        filterProxy.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico");
        filterProxy.setDispatcherTypes(DispatcherType.REQUEST);
        return filterProxy;
    }

}

FilterRegistrationBean和DelegatingFilterProxyRegistrationBean区别：

  • FilterRegistrationBean通过onStartup方法直接注册filter。
  • DelegatingFilterProxyRegistrationBean是将DelegatingFilterProxy注册到Servlet3.0+的容器中，同时实现了ApplicationContextAware接口，实例ApplicationContext通过通过传入自定义filter的名称查找对应的bean，并生成相应bean的代理对象。

触类旁通

  • 添加自定义Servlet 也可采用方法一@WebServlet 或者ServletRegistrationBean
  • 添加自定义Listener也可以采用方法一 @WebListener或者ServletListenerRegistrationBean ,注意监听事件是泛型

其他相关类

  • ServletComponentRegisteringPostProcessor
  • ServletComponentHandler
  • WebListenerHandler
  • WebFilterHandler
  • WebServletHandler

参考

  • https://blog.csdn.net/loveForever_xiang/article/details/101270633
  • https://www.liangzl.com/get-article-detail-121998.html
  • https://mp.weixin.qq.com/s/t8WdKEkYJuRApeEEOvXR_A
  • https://blog.csdn.net/andy_zhang2007/article/details/90399870

原文地址：https://www.cnblogs.com/54chensongxia/p/12177784.html

时间： 2024-08-30 14:07:40

Spring-Boot使用嵌入式容器，那怎么配置自定义Filter呢的相关文章

Spring Boot使用嵌入式容器，自定义Filter如何配置？

Listener.Filter和Servlet是Java Web开发过程中常用的三个组件,其中Filter组件的使用频率最高,经常被用来做简单的权限处理.请求头过滤和防止XSS***等.如果我们使用的是传统的Spring MVC进行开发,那么只需要在Tomcat的web.xml文件中进行如下配置即可: <!-- 配置Listener --> <listener> <listener-class>org.springframework.web.util.WebAppRoo

Spring Boot 多模块项目创建与配置 (一) （转）

最近在负责的是一个比较复杂项目,模块很多,代码中的二级模块就有9个,部分二级模块下面还分了多个模块.代码中的多模块是用maven管理的,每个模块都使用spring boot框架.之前有零零散散学过一些maven多模块配置的知识,但没自己从头到尾创建和配置过,也快忘得差不多了.这次正好对照着这个项目,动手实践一下,下面我们就开始吧. maven多模块项目通常由一个父模块和若干个子模块构成,每个模块都对应着一个pom.xml.它们之间通过继承和聚合(也称作多模块)相互关联.多模块适用于一些比较大的项

Spring Boot 2.x Redis多数据源配置(jedis,lettuce)

Spring Boot 2.x Redis多数据源配置(jedis,lettuce) 96 不敢预言的预言家 0.1 2018.11.13 14:22* 字数 65 阅读 727评论 0喜欢 2 多数据源最终表现其实就是 redis connection factory 不同 springboot 默认的redis配置维护了一套 connection factory 自己维护一套 connection factory 即可实现 application.yml spring: redis: # 默

Spring Boot 基础概述与相关约定配置

这系列的文章是我业余时间来写的,起源于之前对微服务比较感兴趣,就简单了解了下 Spring Boot 与 Spring Cloud,因为相对生态与成熟性都比较完善,站在巨人的肩膀上嘛:所以文章都是想到哪个主题写哪一篇,并没有什么顺序,这几天我在构思我一直在构思基础篇怎么去写,基本概述性质性的文章,Google 一下 N 篇,这里我想简述一些演变的过程与一些实用性比较强的知识点来讲好了.学习新技术最快方式就是先阅读下官方的文档然后参考 github 上的例子,后面就是善用 Google 搜索问题.

阿里微服务专家手写Spring Boot 实现一个简单的自动配置模块

为了更好的理解 Spring Boot 的 自动配置和工作原理,我们自己来实现一个简单的自动配置模块. 假设,现在项目需要一个功能,需要自动记录项目发布者的相关信息,我们如何通过 Spring Boot 的自动配置,更好的实现功能呢? 实战的开端 – Maven搭建 先创建一个Maven项目,我来手动配置下 POM 文件. 参数的配置 - 属性参数类 首先,我们定义一个自定义前缀,叫做 custom 吧.之前说到,这里的配置参数,可以通过 application.properties 中直接设置

Spring Boot实战系列(7)集成Consul配置中心

本篇主要介绍了 Spring Boot 如何与 Consul 进行集成,Consul 只是服务注册的一种实现,还有其它的例如 Zookeeper.Etcd 等,服务注册发现在微服务架构中扮演这一个重要的角色,伴随着服务的大量出现,服务与服务之间的配置管理.运维管理也变的难以维护,通过 Consul 可以解决这些问题,实现服务治理.服务监控. 关于 Consul 的更多知识点不在这里赘述,但是在学习本节之前还是希望您能先了解下,请移步我之前写的 微服务服务注册发现之 Consul 系列 快速导航

Spring Boot 多模块项目创建与配置[转]

一.父模块创建 1.创建一个spring boot项目  名称为demo 2.在上面创建好的工程名demo上,点击右键,选择New–>Module,进入New Module页面   name为dubbo-server 3,再创建另一个Module,name为dubbo-client 4.删除无用的文件及文件夹,包括三个模块的mvnw.mvnw.cmd文件及.mvn文件夹,src目录,父模块只做依赖管理 5.配置父pom.xml <?xml version="1.0" enc

spring boot 添加mybatis，以及相关配置

首先在pom.xml文件里加入 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.3.2</version> </dependency> 我不习惯用,xml文件的方式写sql语句,用的是注解的方式. 所以要在启动类中加入注解

Spring学习记录(二)---容器和属性配置

下载spring包,在eclipse搭建spring环境. 这步我在eclipse中无法导入包,看网上的: http://sishuok.(和谐)com/forum/blogPost/list/2428.html 建一个java project 三个java文件,一个xml文件 1 package com.guigu.spring.beans; 2 3 public class HelloWord { 4 private String name; 5 public String getName(