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