一文贯通→过滤器与拦截器详解

一、过滤器Filter

过滤器英文叫 Filter，是 JavaEE 的标准，依赖于 Servlet 容器，可以按照指定顺序配置多个。常用来配置请求编码以及过滤一些非法参数，垃圾信息或者是网站登录验证码。

目前主要有三种实现方式

1、基于SpringMVC的实现方式

主要分为两步

自定义过滤器，实现javax.servlet.Filter接口

public class JavaEncodeFilter implements Filter {
    private String encoding = "UTF-8";

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        servletRequest.setCharacterEncoding(encoding);
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {

    }
}

在web.xml 文件中配置，可以配置多个，执行的顺序是根据配置顺序从上到下

    <!-- filter -->
    <filter>
        <filter-name>javaEncodeFilter</filter-name>
        <filter-class>edu.jiahui.convertlabgateway.service.filter.JavaEncodeFilter</filter-class>
        <init-param>
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>javaEncodeFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    <!-- filter end -->

2、基于SpringBoot的实现方式

主要分为三步

添加配置@ServletComponentScan

@SpringBootApplication
@ServletComponentScan(basePackages = "edu.jiahui.convertlabgateway")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);;
    }
}

自定义过滤器，实现javax.servlet.Filter接口
在自定义类上面添加@WebFilter、@Order，其中@Order注解表示执行过滤顺序，值越小，越先执行

@Order(1)
@WebFilter(filterName = "sprintBootEncodeFilter", urlPatterns = {"/*"})
public class SprintBootEncodeFilter implements Filter {
    private String encoding = "UTF-8";

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        servletRequest.setCharacterEncoding(encoding);
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {

    }
}

WebFilter由Servlet3.0提供，用来代替在web.xml文件中的配置，WebFilter 的常用属性介绍:

filterName 指定过滤器的 name 属性，等价于<filter-name>
value 该属性等价于 urlPatterns 属性，但是两者不应该同时使用。
urlPatterns 指定一组过滤器的 URL 匹配模式，等价于 <url-pattern>标签。
servletNames 指定过滤器将应用于哪些 Servlet，取值是 @WebServlet 中的 name 属性的取值，或者是web.xml中<servlet-name> 的取值。

3、基于Spring的OncePerRequestFilter的实现方式

Spring的OncePerRequestFilter类实际上是一个实现了Filter接口的抽象类。spring对Filter进行了一些封装处理。 顾名思义，它能够确保在一次请求中只通过一次filter，而需要重复的执行，主要是为了解决servlet不同版本的差异：

在servlet-2.3中，Filter会过滤一切请求，包括服务器内部使用forward转发请求和<%@ include<file=”/index.jsp”%>的情况。
到了servlet-2.4中Filter默认下只拦截外部提交的请求，forward和include这些内部转发都不会被过滤，但是有时候我们需要forward的时候也用到Filter。
实现方法同SpringBoot的实现方式，只是把实现javax.servlet.Filter改为继承org.springframework.web.filter.OncePerRequestFilter即可

@Order(5)
@WebFilter(filterName = "sprintEncodeFilter", urlPatterns = {"/*"})
public class SprintEncodeFilter extends OncePerRequestFilter {
    private String encoding = "UTF-8";
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        request.setCharacterEncoding(encoding);
        filterChain.doFilter(request, response);
    }
}

二、拦截器 Interceptor

拦截器 Interceptor 不依赖 Servlet 容器，依赖 Spring 等 Web 框架，在 SpringMVC 框架中是配置在SpringMVC 的配置文件中，在 SpringBoot 项目中也可以采用注解的形式实现。
拦截器是 AOP 的一种应用，底层采用 Java 的反射机制来实现的。与过滤器一个很大的区别是在拦截器中可以注入 Spring 的 Bean，能够获取到各种需要的 Service 来处理业务逻辑，而过滤器则不行。

1、实现方式

主要分为两步
1.自定义类继承org.springframework.web.servlet.handler.HandlerInterceptorAdapter

@Service
public class TestInterceptor extends HandlerInterceptorAdapter {
    private String encoding = "UTF-8";
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        request.setCharacterEncoding(encoding);
        return true;
    }
}

2.添加拦截器的配置信息

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    /**
     * 不需要登录拦截的url
     */
    final String[] notLoginInterceptPaths = {
            "/home",
            "rpc/**"

    };

    @Resource
    private TestInterceptor testInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(testInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns(notLoginInterceptPaths);
          // 可以添加多个拦截器的配置
//        registry.addInterceptor(pageInterceptor)
//                .addPathPatterns("/**");
    }
}

三、过滤器和拦截器的区别

1.拦截器是基于java的反射机制的，而过滤器是基于函数回调。
2.拦截器不依赖与servlet容器，过滤器依赖与servlet容器。
3.拦截器只能对Controller请求起作用，而过滤器则可以对几乎所有的请求起作用。
4.拦截器可以访问Controller上下文、值栈里的对象，而过滤器不能访问。
5.在Controller的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次。
6.拦截器可以获取IOC容器中的各个bean，而过滤器就不行，这点很重要，在拦截器里注入一个service，可以调用业务逻辑。
层次图解：

执行顺序图解：

小结：Filter是在Servlet规范规定的，只能用于Web程序中，只在Servlet前后起作用。而拦截器是基于Spring的AOP，能够深入到方法前后，异常抛出前后等，因此拦截器的使用具有更大的弹性，在Spring框架的程序中，优先考虑使用拦截器。