SpringBoot系列之如何使用过滤器

1 过滤器式是什么

在Spring Boot开发中，我们一般会有三种方式对达到controller层之前的请求进行处理，分别是：过滤器、拦截器和切面。如果三种处理方式都存在，则按照如下顺序对传进的请求进行处理：过滤器、拦截器及切面。这篇博文，主要讲一下如何使用过滤器。

在了解过滤器是什么之前，我们不妨想一下，为什么需要在请求到达Controller之前对请求进行处理。对request请求处理一般无非是对url进行辨别，并重定向。或参数进行再处理，以便符合业务需求。过滤器对request可处理，也可以对response处理，处理顺序刚好和处理request的顺序相反。

2 使用

2.1 定义一个过滤器类

实现Filter接口，并根据自己的业务需求重写doFilter()、init()及destroy()方法，就实现了一个过滤器类。例如一个很简单的对前端传过来的url进行重定向的过滤器。这个过滤器主要是解决tomcat托管前端代码时，前端请求访问静态资源的需求。

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import javax.servlet.FilterConfig;

/**
 * change URL from "/*" to "/" when URL don't start with "/api"
 **/
public class UrlFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String path = httpRequest.getRequestURI();
        if (path.startsWith("/api")) {
            chain.doFilter(request, response);
        } else {
            path = "/";
            httpRequest.getRequestDispatcher(path).forward(request, response);
        }
        return;
    }

    @Override
    public void init(FilterConfig filterConfig) {

    }

    @Override
    public void destroy() {
    }
}

2.2 注册过滤器到容器

在SpringBoot当中，@Configuration用于定义配置类，可替换Spring xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。例如上面定义的过滤器可通过如下配置类注册到容器到中，后续应用启动便可正常使用。

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

@Configuration
public class MdxWebRegistry {

    @Bean
    public FilterRegistrationBean registFilter() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new UrlFilter());
        registration.addUrlPatterns("/*");
        registration.setName("UrlFilter");
        registration.setOrder(1);
        return registration;
    }

}