正文 

当前位置： 首页 > java > java框架

springboot使用嵌入式容器，自定义filter如何配置？

     2022-05-17     674

关键词：

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

重学springboot系列之嵌入式容器的配置与应用(代码片段)

重学SpringBoot系列之嵌入式容器的配置与应用嵌入式容器的运行参数配置调整SpringBoot应用容器的参数两种配置方法配置文件方式常用配置参数tomcat性能优化核心参数自定义配置类方式为Web容器配置HTTPS如何生成自签名证书将SSL应... 查看详情

嵌入式servlet容器自动配置启动自定义配置原理(代码片段)

SpringBoot中提供了自动配置功能，嵌入式Servlet容器也是通过自动配置完成配置的。默认使用tomcat。我们可以通过starter-web的依赖窥见。一、EmbeddedServletContainerAutoConfiguration@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)@Configuration 查看详情

嵌入式servlet容器自动配置启动自定义配置原理(代码片段)

SpringBoot中提供了自动配置功能，嵌入式Servlet容器也是通过自动配置完成配置的。默认使用tomcat。我们可以通过starter-web的依赖窥见。一、EmbeddedServletContainerAutoConfiguration@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)@Configuration@... 查看详情

spring-boot使用嵌入式容器，那怎么配置自定义filter呢

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

springboot起飞系列-配置嵌入式servlet容器

一、前言springboot中默认使用的是tomcat容器，也叫做嵌入式的servlet容器。因为它和我们平常使用的tomcat容器不一样，这个tomcat直接嵌入到的springboot，平常我们使用tomcat容器是一个独立的应用，配置的时候需要在tomcat中的xml中配置... 查看详情

springboot应用使用自定义的applicationcontext实现类

欢迎访问我的GitHub为什么要自定义applicationcontext在学习spring容器初始化的过程中，发现spring容器预留了一些扩展点，我们可以写子类来做功能扩展，例如AbstractApplicationContext类的initPropertySources、postProcessBeanFactory、onRefresh等方法... 查看详情

如何在 iOS 5 中使用故事板创建自定义视图控制器容器

】如何在iOS5中使用故事板创建自定义视图控制器容器【英文标题】：HowtocreatecustomviewcontrollercontainerusingstoryboardiniOS5【发布时间】：2011-12-2816:13:26【问题描述】：在使用故事板功能的iOS5中，我想创建一个自定义容器，其中嵌入了... 查看详情

21springboot——使用外置的tomcat服务器

嵌入式Servlet容器：应用打成可执行的jar优点：简单、便携；缺点：默认不支持JSP、优化定制比较复杂      使用定制器【ServerProperties、自定义      EmbeddedServletContainerCustomizer】， &nb... 查看详情

springboot整合rabbitmq自定义消息监听容器来实现消息批量处理(代码片段)

SpringBoot整合RabbitMq自定义消息监听容器来实现消息批量处理前言添加依赖配置文件编写监听器创建SimpleRabbitListenerContainerFactory发送消息前言RabbitMQ是一种常用的消息队列，SpringBoot对其进行了深度的整合，可以快速地实现... 查看详情

springboot源码学习系列之嵌入式servlet容器

1、前言简单介绍SpringBoot的自动配置就是SpringBoot的精髓所在；对于SpringBoot项目是不需要配置Tomcat、jetty等等Servlet容器，直接启动application类既可，SpringBoot为什么能做到这么简捷？原因就是使用了内嵌的Servlet容器，默认是使用Tomc... 查看详情

springboot源码学习系列之嵌入式servlet容器

1、前言简单介绍SpringBoot的自动配置就是SpringBoot的精髓所在；对于SpringBoot项目是不需要配置Tomcat、jetty等等Servlet容器，直接启动application类既可，SpringBoot为什么能做到这么简捷？原因就是使用了内嵌的Servlet容器，默认是使用Tomc... 查看详情

Spring Boot 为嵌入式服务器配置自定义 jsessionid

】SpringBoot为嵌入式服务器配置自定义jsessionid【英文标题】：Springbootconfigurecustomjsessionidforembeddedserver【发布时间】：2014-11-1303:24:03【问题描述】：我想配置我的servlet上下文，例如设置自定义jsessionId键（请参阅ChangingcookieJSESSIONIDn... 查看详情

如何使用 Spring 嵌入式 ActiveMQ 代理指定自定义 activemq.xml？

...iveMQbroker?【发布时间】：2021-05-3004:02:35【问题描述】：在SpringBoot应用程序中，我使用嵌入式ActiveMQ代理。我可以配置它：SpringBootActiveMQproperties,Brok 查看详情

springboot----嵌入式servelt容器(代码片段)

嵌入式Servelt容器SpringBoot默认使用tomcat作为嵌入式的Servlet容器定制和修改Servelt容器的相关配置1.修改和Server有关的配置，去找对应绑定的类(ServerProperties)通用的Servlet设置和tomcat相关设置编写一个嵌入式的容器定制器（Embe... 查看详情

Spring Boot 关闭钩子

】SpringBoot关闭钩子【英文标题】：SpringBootshutdownhook【发布时间】：2014-12-2723:34:29【问题描述】：如何注册/添加一个自定义关闭例程，该例程在我的SpringBoot应用程序关闭时触发？场景：我将SpringBoot应用程序部署到Jettyservlet容器... 查看详情

使用外置的servlet容器

嵌入式Servlet容器：优点：简单、便捷缺点：默认不支持JSP、优化定制比较复杂（使用定制器【ServerProperties、自定义EmbeddedServletContainerCustomizer】）,自己编写嵌入式Servlet容器的创建工厂【EmbeddedServletContainerFactory】；外置的Servlet... 查看详情

springboot2---web原生组件注入（servletfilterlistener）和嵌入式servlet容器(代码片段)

Web原生组件注入使用ServletAPI@ServletComponentScan注解Servlet的使用Filter的使用Listener的使用使用RegistrationBean这里需要注意一个小细节:组件是单实例，还是多实例的，这里建议还是使用默认的单实例，防止每一次请求访... 查看详情

使用基本身份验证配置 Spring Boot 的嵌入式 tomcat 容器

】使用基本身份验证配置SpringBoot的嵌入式tomcat容器【英文标题】：ConfiguringSpringBoot\'sembeddedtomcatcontainerwithbasicauth【发布时间】：2018-03-2805:46:50【问题描述】：我使用的是SpringBoot1.5.7，没有SpringSecurity。我的目标是试验嵌入式tomcat... 查看详情