Spring拦截器

一、简介：

Spring Boot 拦截器是面向切面编程-----AOP 的具体实现，用于对请求做预处理。

1.1.什么是拦截器：在AOP（Aspect-Oriented Programming）中用于在某个方法或字段被访问之前，进行拦截然后在之前或之后加入某些操作。拦截是AOP的一种实现策略
1.2.为什么需要拦截器：在做身份认证或者是进行日志的记录时，我们需要通过拦截器达到我们的目的。最常用的登录拦截、或是权限校验、或是防重复提交、或是根据业务像12306去校验购票时间,总之可以去做很多的事情
1.3.如何用拦截器：在spring中用拦截器需要实现HandlerInterceptor接口或者它的实现子类：HandlerInterceptorAdapter，同时在applicationContext.xml文件中配置拦截器。
拦截器可以做什么？
1.4.用拦截器做很多事情：

日志记录：记录请求信息的日志，以便进行信息监控、信息统计等；
权限检查：如登录校验，在处理器处理之前先判断是否已经登录；
性能监控：通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间。
通用行为：读取 Cookie 得到用户信息并将用户对象放入请求，从而方便后续流程使用。还有如提取 Locale、Theme 信息等，只要是多个处理器都需要的都可以用拦截器来实现。

1.5.拦截器的执行时机：

1.6.拦截器的分类：

spring中拦截器主要分两种，一个是HandlerInterceptor，一个是MethodInterceptor。 

二、登录案例：

2.1.拦截器类：

package day0505intercepter;

//import org.apache.log4j.Logger;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
public class LoginCheckInterceptor  implements HandlerInterceptor {
//    private Logger log=Logger.getLogger(LoginCheckInterceptor.class);//结合import org.apache.log4j.Logger;使用

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, 
   Object handler) throws Exception{
        String userId=request.getHeader("userId");
        if(StringUtils.isEmpty(userId)){
            response.setStatus(401);
            response.getWriter().print("please login");
            response.getWriter().flush();
            return false;
        }
        return true;
    }


    public void postHandle(HttpServletRequest request, HttpServletResponse response, 
   Object handler, ModelAndView mav)throws Exception{
        log.info("execute LoginCheckInterceptor's postHandle method");
    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, 
   Object handler, Exception e)throws Exception{
        log.info("execute LoginCheckInterceptor's afterCompletion method");
    }
}

 方法介绍： Controller之前执行preHandle()、 之后执行postHandle、 preHandle()返回true时在视图解析器渲染视图之后执行afterCompletion()用于进行资源清理工作（不管处理器是否抛出异常，该方法都将执行。）。

• preHandle

用来拦截处理器的执行，preHandle方法将在Controller处理之前调用的。SpringMVC里可以同时存在多个interceptor，它们基于链式方式调用，每个interceptor都根据其声明顺序依次执行。这种链式结构可以中断，当方法返回false时整个请求就结束了。

方法的返回值是布尔类型，方法如果返回false，那后面的interceptor和Controller都不会执行(通常都会响应一个自定义的 Http 错误码给客户端)。如果返回值为true，则接着调用下一个interceptor的preHandle方法。如果当前是最后一个interceptor，接下来就会直接调用Controller的处理方法。

• postHandle：

postHandle 会在Controller方法调用之后，但是在DispatcherServlet 渲染视图之前调用。因此我们可以在这个阶段，对将要返回给客户端的ModelAndView进行操作。

• afterCompletion：

afterCompletion在当前interceptor的preHandle方法返回true时才执行。该方法会在整个请求处理完成后被调用，就是DispatcherServlet渲染视图完成以后，主要是用来进行资源清理工作。需要注意的是，afterCompletion在interceptor链式结构中以相反的顺序执行，也就是说先申明的interceptor返回会后调用，不管处理器是否抛出异常，该方法都将执行。。

• 拦截器内方法的执行顺序依次是：preHandle ---> postHandle ---> afterCompletion。

注意：

实现一个HandlerInterceptor拦截器可以直接实现HandlerInterceptor接口，也可以继承HandlerInterceptorAdapter类。这两种方法殊途同归，其实HandlerInterceptorAdapter也就是声明了HandlerInterceptor接口中所有方法的默认实现，而我们在继承他之后只需要重写必要的方法。 

下面就是HandlerInterceptorAdapter的代码，可以看到一个方法只是默认返回true，另外两个是空方法：

public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {  
  
    public boolean preHandle(HttpServletRequest request, HttpServletResponse 
    response, Object handler)  
        throws Exception {  
        return true;  
    }  
 
    public void postHandle(  
            HttpServletRequest request, HttpServletResponse 
    response, Object handler, ModelAndView modelAndView)  
            throws Exception {  
    }  
  
    public void afterCompletion(  
            HttpServletRequest request, HttpServletResponse 
    response, Object handler, Exception ex)  
            throws Exception {  
    }  
}  

注意： 初学建议掌握第一点和第二点即可。

三、总结：

3.1.springmvc的执行流程：

当浏览器发起的请求到达 Servlet 容器，DispatcherServlet 先根据处理器映射器 HandlerMapping 获取处理器，这时候获取到的是一个包含处理器和拦截器的处理器执行链，处理器执行之前将会先执行拦截器。

3.2.添加拦截器执行流程：

不包含拦截器的情况下，DispatcherServlet 处理请求的流程可以简化如下。

添加了拦截器做登录检查后，DispatcherServlet 请求处理的流程可以简化如下。

注意：自从前后端分离之后，Spring MVC 中的处理器方法执行后通常不会再返回视图，而是返回表示 json 或 xml 的对象，@Controller 方法返回值类型如果为 ResponseEntity 或标注了 @ResponseBody 注解，此时处理器方法一旦执行结束，Spring 将使用 HandlerMethodReturnValueHandler 对返回值进行处理，具体来说会将返回值转换为 json 或 xml，然后写入响应，后续也不会进行视图渲染，这时postHandle 将没有机会修改响应体内容。

如果需要更改响应内容，可以定义一个实现 ResponseBodyAdvice 接口的类，然后将这个类直接定义到 RequestMappingHandlerAdapter 中的 requestResponseBodyAdvice 或通过 @ControllerAdvice 注解添加到 RequestMappingHandlerAdapter。

3.3.多个拦截器：

通常情况下，我们并不需要关心多个拦截器的执行顺序，然而，如果一个拦截器依赖于另一个拦截器的执行结果，那么就需要注意了。使用多个拦截器后的 DispatcherServlet 请求处理流程可以简化为如下的流程图:

多个拦截器方法执行顺序如下。

1.preHandle 按照拦截器的顺序先后执行。如果任意一次调用返回 false 则直接跳到拦截器的 afterCompletion 执行。
2.postHandle 按照拦截器的逆序先后执行，也就说后面的拦截器先执行 postHandle。
3.afterCompletion 也按照拦截器的逆序先后执行，后面的拦截器先执行 afterCompletion。
那么拦截器的顺序是如何指定的呢？

1.对于 xml 配置来说，Spring 将记录 bean 声明的顺序，先声明的拦截器将排在前面。
2.对于注解配置来说，由于通过反射读取方法无法保证顺序，因此需要在方法上添加@Order注解指定 bean 的声明顺序。
3.对应API配置来说，拦截器的顺序并非和添加顺序完全保持一致，为了控制先后顺序，需要自定义的拦截器实现Ordered接口。

注解配置指定顺序示例如下。

@Configuration
public class MvcConfig {

    @Order(2)
    @Bean
    public MappedInterceptor loginInterceptor() {
        return new MappedInterceptor(new String[]{"/**"}, new String[]{"/login"}, new LoginInterceptor());
    }
    
    @Order(1)
    @Bean
    public MappedInterceptor logInterceptor() {
        return new MappedInterceptor(null, new LoginInterceptor());
    }
    
}

此时虽然登录拦截器写在前面，但因为 @Order 注解指定的值较大，因此将排在日志拦截器的后面。

API配置指定顺序示例如下。

public class LoginInterceptor implements HandlerInterceptor, Ordered {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("已登录");
        return true;
    }

    @Override
    public int getOrder() {
        return 2;
    }
}

public class LogInterceptor implements HandlerInterceptor, Ordered {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("请求来了");
        return true;
    }

    @Override
    public int getOrder() {
        return 1;
    }
}