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

最新推荐文章于 2023-03-02 11:12:28 发布

weixin_39673742

最新推荐文章于 2023-03-02 11:12:28 发布

阅读量78

点赞数

作者：写代码的木公

出处：https://www.cnblogs.com/54chensongxia/p/12187036.html

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

org.springframework.web.util.WebAppRootListenerorg.springframework.web.context.ContextLoaderListenerfilter1com.csx.MyFilterfilter1/url/a/*filter1/url/b/*springmvcorg.springframework.web.servlet.DispatcherServletcontextConfigLocationclasspath:springmvc.spring.xml1springmvc/

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文件中做如下配置即可：

@Configurationpublic class WebConfig {    private static Logger logger = LoggerFactory.getLogger(WebConfig.class);    @Bean    public Filter filter1(){        return new TimeConsumingCalculationFilter();    }}

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

@Configurationpublic 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能进行细粒度的进行配置，比上面的方式更加灵活。

@Configurationpublic 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配置

@Configurationpublic class WebConfig {    private static Logger logger = LoggerFactory.getLogger(WebConfig.class);    @Bean        public FilterRegistrationBean filter1() {            FilterRegistrationBean registrationBean = new FilterRegistrationBean<>();            registrationBean.setName("filter1");            registrationBean.setOrder(Ordered.LOWEST_PRECEDENCE - 2);            registrationBean.setFilter(new TimeConsumingCalculationFilter());            registrationBean.addUrlPatterns("/foo/*");            return registrationBean;        }                @Bean        public FilterRegistrationBean filter2() {            FilterRegistrationBean 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方式

@Configurationpublic 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的代理对象。