拦截器 过滤器

Filter的使用

首先,要使用Filter,必须实现javax.servlet.Filter接口:

  1. public interface Filter {
  2. //web应用加载进容器,Filter对象创建之后,执行init方法初始化,用于加载资源,只执行一次。
  3. public default void init(FilterConfig filterConfig) throws ServletException {}
  4. //每次请求或响应被拦截时执行,可执行多次。
  5. public void doFilter(ServletRequest request, ServletResponse response,
  6. FilterChain chain) throws IOException, ServletException;
  7. //web应用移除容器,服务器被正常关闭,则执行destroy方法,用于释放资源,只执行一次。
  8. public default void destroy() {}
  9. }
  • init和destroy是default方法,实现类可以不用实现。
  • doFilter必须实现,也就是说,作为一个过滤器,doFilter必须要定义。
  • doFlilter方法中传进来的FilterChain对象用来调用下一个过滤器。

    拦截器的使用

    1. public interface HandlerInterceptor {
    2. //拦截handler的执行 --> 在HanlerMapping决定适合的handler之后,[在HandlerAdater调用handler之前执行。]
    3. default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    4. throws Exception {
    5. return true;
    6. }
    7. //拦截handler的执行 --> [在HandlerAdapter调用handler之后],在DispatcherServlet渲染视图之前执行
    8. default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
    9. @Nullable ModelAndView modelAndView) throws Exception {
    10. }
    11. //视图渲染后调用,且只有preHandle结果为true,才会调用
    12. default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
    13. @Nullable Exception ex) throws Exception {
    14. }
    15. }
    1. //DispatcherServlet
    2. if (!mappedHandler.applyPreHandle(processedRequest, response)) {
    3. return; //遍历所有的interceptors,调用preHandle方法,只有返回true,才能进行下去
    4. }
    5. // 这里也就是处理Contrller
    6. mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
    7. //视图渲染
    8. applyDefaultViewName(processedRequest, mv);
    9. //视图渲染之后调用
    10. mappedHandler.applyPostHandle(processedRequest, response, mv);

    过滤器与拦截器的区别

    一、实现原理不同

  • 过滤器的实现基于回调函数

  • 拦截器基于Java的反射机制【动态代理】实现。

    二、使用范围不同

  • 过滤器是Servlet的规范,需要实现javax.servlet.Filter接口,Filter使用需要依赖于Tomcat等容器。

  • 拦截器是Spring组件,定义在org.springframework.web.servlet包下,由Spring容器管理【有更加丰富的生命周期处理方法,细粒度,且能够使用Spring中的资源】,不依赖Tomcat等容器。

    三、触发时机不同

    这一段在HandlerInterceptor类的注释上可以发现,两者的触发时机是不同的:
    过滤器和拦截器的区别 - 图1

  • 过滤器:对请求在进入后Servlet之前或之后进行处理。

  • 拦截器:对请求在handler【Controller】前后进行处理。

过滤器和拦截器的区别 - 图2

四、执行顺序不同

同时配置了过滤器和拦截器的情形:

  1. MyFilter1
  2. MyFilter2
  3. MyInterceptor1 Controller前执行
  4. MyInterceptor2 Controller前执行
  5. controller方法执行...
  6. MyInterceptor2 Controller之后,视图渲染之前
  7. MyInterceptor1 Controller之后,视图渲染之前
  8. MyInterceptor2 视图渲染完成之后执行
  9. MyInterceptor1 视图渲染完成之后执行
  10. MyFilter2
  11. MyFilter1
  • 过滤器的顺序

每一次都将chain对象传入,达到最后接口回调的效果:
过滤器和拦截器的区别 - 图3

  • 拦截器的顺序

preHandle1 -> preHande2 -> 【Controller】 -> postHandle2 -> postHandle1 -> afterCompletion2 -> afterComplention1 preHandle按照注册顺序,后两个与注册顺序相反。

  • 一个拦截器的preHandle为false,则之后的所有拦截器都不会执行。
  • 一个拦截器的preHandle为true,则这个拦截器的triggerAfterCompletion一定会执行。
  • 只有所有的拦截器preHandler都为true,也就是正常执行,postHandle才会执行。

    1. boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
    2. HandlerInterceptor[] interceptors = getInterceptors();
    3. if (!ObjectUtils.isEmpty(interceptors)) {
    4. for (int i = 0; i < interceptors.length; i++) {
    5. HandlerInterceptor interceptor = interceptors[i];
    6. //一旦当前拦截器preHandle的返回值为false,那么从上一个可用的拦截器的afterCompletion开始
    7. if (!interceptor.preHandle(request, response, this.handler)) {
    8. triggerAfterCompletion(request, response, null);
    9. return false; //这里返回false意为 后续不进行下去了。
    10. }
    11. this.interceptorIndex = i;//interceptorIndex初始化为-1,只有当前拦截器preHandle为true,才会赋值当前的i。
    12. }
    13. }
    14. return true;
    15. }
    16. void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv)
    17. throws Exception {
    18. HandlerInterceptor[] interceptors = getInterceptors();
    19. if (!ObjectUtils.isEmpty(interceptors)) {
    20. for (int i = interceptors.length - 1; i >= 0; i--) {
    21. HandlerInterceptor interceptor = interceptors[i];
    22. interceptor.postHandle(request, response, this.handler, mv);
    23. }
    24. }
    25. }
    26. void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex)
    27. throws Exception {
    28. HandlerInterceptor[] interceptors = getInterceptors();
    29. for (int i = this.interceptorIndex; i >= 0; i--)
    30. }

    五、控制执行顺序方式不同

    两者默认都是使用注册顺序,如果想要认为控制执行的顺序,方式略有不同:

  • 过滤器

    • 如果想要强制改变,可以使用@Order注解。
  • 拦截器

    • 如果使用order()方法
      1. @Order(2)
      2. @Component
      3. public class MyFilter1 implements Filter {}
      1. @Component
      2. public class WebAdapter implements WebMvcConfigurer {
      3. @Autowired
      4. MyInterceptor1 myInterceptor1;
      5. @Autowired
      6. MyInterceptor2 myInterceptor2;
      7. @Override
      8. public void addInterceptors(InterceptorRegistry registry) {
      9. registry.addInterceptor(myInterceptor1).addPathPatterns("/**").order(2);
      10. registry.addInterceptor(myInterceptor2).addPathPatterns("/**").order(1);
      11. }
      12. }

      总结

  • 原理实现上:过滤器基于回调实现,而拦截器基于动态代理。

  • 控制粒度上:过滤器和拦截器都能够实现对请求的拦截功能,但是在拦截的粒度上有较大的差异,拦截器对访问控制的粒度更细。
  • 使用场景上:拦截器往往用于权限检查、日志记录等,过滤器主要用于过滤请求中无效参数,安全校验。
  • 依赖容器上:过滤器依赖于Servlet容器,局限于web,而拦截器依赖于Spring框架,能够使用Spring框架的资源,不仅限于web。
  • 触发时机上:过滤器在Servlet前后执行,拦截器在handler前后执行,现在大多数web应用基于Spring,拦截器更细。