Spring boot与HandlerInterceptor

• HandlerInterceptor
  • 拦截器中的方法
• Spring boot 定制 Interceptor

HandlerInterceptor

Spring提供的拦截器Interceptor与Servlet中的Filter不同的是, Interceptor采用AOP的方式在Servlet的service方法执行之前进行拦截, 可以进行更精细的控制.

在Spring中定义一个Interceptor只需要实现HandlerInterceptor接口, Spring已经为我们提供了一个HandlerInterceptorAdapter, 我们只需要继承它, 覆盖想要重写的方法.

拦截器中的方法

Interceptor中有如下方法:

• preHandle: 在Controller处理之前调用, 返回false时整个请求结束
• postHandle: 在Controller调用之后执行, 但它会在DispatcherServlet进行视图的渲染之前执行, 也就是说在这个方法中你可以对ModelAndView进行操作
• afterCompletion: 在整个请求完成之后执行, 也就是DispatcherServlet已经渲染了视图之后执行; 这个方法的主要作用是用于清理资源的
• afterConcurrentHandlingStarted: 这个方法是AsyncHandlerInterceptor接口中添加的. 当Controller中有异步请求方法的时候会触发该方法, 异步请求先支持preHandle、然后执行afterConcurrentHandlingStarted, 异步线程完成之后执行会再执行preHandle、postHandle、afterCompletion

关于最后那个方法, 举个列子:

@RestController
public class ExampleController {
    @RequestMapping("/")
    DeferredResult<String> home() {
        DeferredResult<String> dr = new DeferredResult<String>();
        dr.setResult("成功");
        return dr;
    }
}

上面这样的Controller里面有个异步结果, 则拦截器的执行顺序将是: preHandle -> afterConcurrentHandlingStarted -> preHandle -> postHandle -> afterCompletion.

如果把dr.setResult("成功"); 这句删掉, 将只执行preHandle -> afterConcurrentHandlingStarted

可以认为, afterConcurrentHandlingStarted是返回异步结果时调用(此时异步结果里不需要有数据), 而postHandle必须是返回的结果执行完, 异步结果中有数据了(dr.setResult)才调用.

Spring boot 定制 Interceptor

首先我们先定义我们自己的拦截器, 方式还是继承HandlerInterceptorAdapter, 覆盖想要的方法:

@Component
public class MyInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }
    // ...
}

像这样我们把MyInterceptor作为一个Bean, Spring boot并不会帮我们注册到拦截器列表中. 就像添加消息转换器一样, 我们可以在继承WebMvcConfigurerAdapter的配置类里, 通过覆盖方法来添加:

@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
      // 拦截器需要手动加入到调用链中
      @Override
      public void addInterceptors(InterceptorRegistry registry) {
          registry.addInterceptor(new MyInterceptor());
      }
}