SpringBoot自定义过滤器Filter使用详解

JavaWeb组件Servlet提供了filter过滤功能，其功能是对目标资源的请求和响应进行拦截，对拦截到的请求和响应做出特殊的功能处理，比如我们请求中有一些敏感信息过滤就是利用过滤器过滤

1. Filter的原理
Java Servlet API中提供了Filter接口，编写Filter的实现类，从而实现自定义过滤器。Filter的请求流程为：

客户端发起请求
服务容器判断当前请求资源是否有过滤器，有则执行过滤器
过滤器过滤通过后请求到Servlet服务器
返回结果通过过滤器返回给请求方
Filter接口源码：

package javax.servlet;

import java.io.IOException;

public interface Filter {
    default void init(FilterConfig filterConfig) throws ServletException {
    }

    void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;

    default void destroy() {
    }
}

init()： 此方法在只在过滤器创建的时候执行一次，用于初始化过滤器的属性
doFilter()： 该方法会对请求进行拦截，用户需要在该方法中自定义对请求内容以及响应内容进行过滤的，调用该方法的入参 FilterChain对象的 doFilter 方法对请求放行执行后面的逻辑，若未调用 doFilter 方法则本次请求结束，并向客户端返回响应失败

destroy()： 此方法用于销毁过滤器，过滤器被创建以后只要项目一直运行，过滤器就会一直存在，在项目停止时，会调用该方法销毁过滤器

2. SpringBoot中Filter的实现

在SpringBoot中有两种方式实现自定义Filter，一种是使用 @WebFilter 和 @ServletComponentScan 组合注解，另一种是通过配置类注入 FilterRegistrationBean对象

2.1 @WebFilter注解方式（具体实战可见黑马程序员的Springboot项目实战瑞吉外卖中）

过滤器具体的处理逻辑如下:

1、获取本次请求的URI

2、判断本次请求是否需要处理

3、如果不需要处理，则直接放行

4、判断登录状态，如果已登录，则直接放行

5、如果未登录则返回未登录结果

@WebFilter源码如下：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebFilter {
    String description() default "";

    String displayName() default "";

    WebInitParam[] initParams() default {};

    String filterName() default "";

    String smallIcon() default "";

    String largeIcon() default "";

    String[] servletNames() default {};

    String[] value() default {};

    String[] urlPatterns() default {};

    DispatcherType[] dispatcherTypes() default {DispatcherType.REQUEST};

    boolean asyncSupported() default false;
}

几个重要参数详解：

urlPatterns：自定义需要拦截的URL，可以使用正则匹配，若没指定该参数值，则默认拦截所有请求
filterName：自定义过滤器的名称
initParams：自定义过滤器初始化参数的数组，此参数可以通过自定义过滤器 init() 的入参FilterConfig对象的 getInitParameter() 方法获取；（由于过滤器没有直接排除自定义URL不拦截的设定，如果我们需要在自定义拦截的URL中排除部分不需要拦截的URL，可以通过将需要排除的URL放到initParams参数中再在doFilter方法中排除）
如下自定义个一个拦截所有URL除了带有 “/test” 的片段名称为testFilter的过滤器：

@WebFilter(filterName = "testFilter", urlPatterns = "/*", 
        initParams = @WebInitParam(name = "noFilterUrl", value = "/test"))
public class TestFilter implements Filter {
    private List<String> noFilterUrls; 
    
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 从过滤器配置中获取initParams参数
        String noFilterUrl = filterConfig.getInitParameter("noFilterUrl");
        // 将排除的URL放入成员变量noFilterUrls中
        if (StringUtils.isNotBlank(noFilterUrl)) {
            noFilterUrls = new ArrayList<>(Arrays.asList(noFilterUrl.split(",")));
        }
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        // 若请求中包含noFilterUrls中的片段则直接跳过过滤器进入下一步请求中
        String url = ((HttpServletRequest)servletRequest).getRequestURI();
        Boolean flag = false;
        if (!CollectionUtils.isEmpty(noFilterUrls)) {
            for (String noFilterUrl : noFilterUrls) {
                if (url.contains(noFilterUrl)) {
                    flag = true;
                    break;
                }
            }
        }
        if (!flag) {
            ......    //过滤请求响应逻辑
        } 
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {

    }
}

在启动类上需要添加@ServletComponentScan注解才能使过滤器生效

@SpringBootApplication
@ServletComponentScan
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class);
    }
}

这里需要注意的是，如果实现多个FIlter功能的过滤器。使用@WebFilter注解的方式只能根据过滤器名的类名顺序执行，添加@Order注解是无效的，因为@WebFilter在容器加载时，不会使用@Order注解定义的顺序，而是默认直接使用类名排序。所以使用这种方式实现多个过滤器，且有顺序要求，则需要注意类名的定义。

有关@Order注解定义的顺序可以参考：

(66条消息) SpringBoot中filter的使用详解及原理_ssystc的博客-CSDN博客_filter springboot

2.2 通过自定义配置类注入FilterRegistrationBean对象配置Filter（这种我没怎么用过）

这种方式和上面哪种方式类似。其实就是将上面那种方式的配置改为创建一个配置类对象，同时也支持配置过滤器执行的先后顺序
如上面举例的过滤器使用该方式配置如下：

@Configuration
public class FilterConfig {

    @Autowired
    private TestFilter testFilter;

    @Bean
    public FilterRegistrationBean requestFilterRegistration() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        // 将过滤器配置到FilterRegistrationBean对象中
        registration.setFilter(testFilter);
        // 给过滤器取名
        registration.setName("requestFilter");
        // 设置过滤器优先级，该值越小越优先被执行
        registration.setOrder(1);
        Map<String, Object> paramMap = new HashMap<>();
        paramMap.put("noFilterUrl", "/test");
        // 设置initParams参数
        registration.setInitParameters(paramMap);
        List<String> urlPatterns = new ArrayList<>();
        urlPatterns.add("/*");
        // 设置urlPatterns参数
        registration.setUrlPatterns(urlPatterns);
        return registration;
    }
}

在实现多个过滤器并按照自定义顺序，只需对配置文件注册FilterRegistrationBean对象中的Order属性改变顺序。注册多个过滤器，只需要在配置类中创建多个Bean。

ref:(66条消息) SpringBoot自定义过滤器Filter使用详解_Fly丶X的博客-CSDN博客_springboot自定义过滤器