Spring Boot 之FilterRegistrationBean --支持web Filter 排序的使用

Spring Boot 之FilterRegistrationBean  –支持web Filter 排序的使用

Spring 提供了FilterRegistrationBean类，此类提供setOrder方法，可以为filter设置排序值，

让spring在注册web filter之前排序后再依次注册。

  写一个普通的filter：

[java] view plain copy

print ?

1. package com.sdcuike.practice.web2;  
2.   
3. import java.io.IOException;  
4.   
5. import javax.annotation.Resource;  
6. import javax.servlet.Filter;  
7. import javax.servlet.FilterChain;  
8. import javax.servlet.FilterConfig;  
9. import javax.servlet.ServletException;  
10. import javax.servlet.ServletRequest;  
11. import javax.servlet.ServletResponse;  
12.   
13. import org.slf4j.Logger;  
14. import org.slf4j.LoggerFactory;  
15.   
16. import com.sdcuike.practice.config.CommonConfig;  
17.   
18. public class FilterDemo3 implements Filter {  
19.     private final Logger log = LoggerFactory.getLogger(getClass());  
20.   
21.     @Resource  
22.     private CommonConfig commonConfig;  
23.   
24.     @Override  
25.     public void destroy() {  
26.         log.info(”“ + getClass() + “ destroy”);  
27.   
28.     }  
29.   
30.     @Override  
31.     public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2) throws IOException, ServletException {  
32.         log.info(”“ + getClass() + “ doFilter ” + commonConfig);  
33.         arg2.doFilter(arg0, arg1);  
34.   
35.     }  
36.   
37.     @Override  
38.     public void init(FilterConfig arg0) throws ServletException {  
39.         log.info(”“ + getClass() + “ init”);  
40.   
41.     }  
42.   
43. }  

package com.sdcuike.practice.web2;

import java.io.IOException;

import javax.annotation.Resource;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.sdcuike.practice.config.CommonConfig;

public class FilterDemo3 implements Filter {
    private final Logger log = LoggerFactory.getLogger(getClass());

    @Resource
    private CommonConfig commonConfig;

    @Override
    public void destroy() {
        log.info("" + getClass() + " destroy");

    }

    @Override
    public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2) throws IOException, ServletException {
        log.info("" + getClass() + " doFilter " + commonConfig);
        arg2.doFilter(arg0, arg1);

    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        log.info("" + getClass() + " init");

    }

}

配置如下：

[java] view plain copy

print ?

1. package com.sdcuike.practice.web2;  
2.   
3. import javax.servlet.Filter;  
4.   
5. import org.springframework.boot.web.servlet.FilterRegistrationBean;  
6. import org.springframework.context.annotation.Bean;  
7. import org.springframework.context.annotation.Configuration;  
8.   
9. import com.sdcuike.spring.extend.web.MvcConfigurerAdapter;  
10.   
11. /** 
12.  * web 组件配置 
13.  *  
14.  * @author sdcuike 
15.  *         <p> 
16.  *         Created on 2017-02-10 
17.  *         <p> 
18.  *         自定义注入，并支持依赖注入，组件排序 
19.  */  
20. @Configuration  
21. public class WebComponent2Config   {  
22.   
23.     @Bean  
24.     public FilterRegistrationBean filterDemo3Registration() {  
25.         FilterRegistrationBean registration = new FilterRegistrationBean();  
26.         registration.setFilter(filterDemo3());  
27.         registration.addUrlPatterns(”/*”);  
28.         registration.addInitParameter(”paramName”, “paramValue”);  
29.         registration.setName(”filterDemo3”);  
30.         registration.setOrder(6);  
31.         return registration;  
32.     }  
33.   
34.     @Bean  
35.     public FilterRegistrationBean filterDemo4Registration() {  
36.         FilterRegistrationBean registration = new FilterRegistrationBean();  
37.         registration.setFilter(filterDemo4());  
38.         registration.addUrlPatterns(”/*”);  
39.         registration.addInitParameter(”paramName”, “paramValue”);  
40.         registration.setName(”filterDemo4”);  
41.         registration.setOrder(7);  
42.         return registration;  
43.     }  
44.   
45.     @Bean  
46.     public Filter filterDemo3() {  
47.         return new FilterDemo3();  
48.     }  
49.   
50.     @Bean  
51.     public Filter filterDemo4() {  
52.         return new FilterDemo4();  
53.     }  
54.   
55. }  

package com.sdcuike.practice.web2;

import javax.servlet.Filter;

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.sdcuike.spring.extend.web.MvcConfigurerAdapter;

/**
 * web 组件配置
 * 
 * @author sdcuike
 *         <p>
 *         Created on 2017-02-10
 *         <p>
 *         自定义注入，并支持依赖注入，组件排序
 */
@Configuration
public class WebComponent2Config   {

    @Bean
    public FilterRegistrationBean filterDemo3Registration() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(filterDemo3());
        registration.addUrlPatterns("/*");
        registration.addInitParameter("paramName", "paramValue");
        registration.setName("filterDemo3");
        registration.setOrder(6);
        return registration;
    }

    @Bean
    public FilterRegistrationBean filterDemo4Registration() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(filterDemo4());
        registration.addUrlPatterns("/*");
        registration.addInitParameter("paramName", "paramValue");
        registration.setName("filterDemo4");
        registration.setOrder(7);
        return registration;
    }

    @Bean
    public Filter filterDemo3() {
        return new FilterDemo3();
    }

    @Bean
    public Filter filterDemo4() {
        return new FilterDemo4();
    }

}

利用这种方式，我们可以对filter排序，可自行测试，源码:

https://github.com/sdcuike/spring-boot-practice/tree/master/src/main/java/com/sdcuike/practice/web2

<spring-boot.version>1.5.1.RELEASE</spring-boot.version>