spring boot 拦截器实现

Interceptor 应用场景

拦截器本质上是面向切面编程（AOP），符合横切关注点的功能都可以放在拦截器中来实现。

1. 日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算 PV（Page View）等。
2. 权限检查：判断用户是否有权限访问资源，如校验token。
3. 性能监控：通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间。（反向代理，如 Apache 也可以自动记录）
4. 通用行为：读取 Cookie 得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取 Locale、Theme 信息等，只要是多个处理器都需要的即可使用拦截器实现。
5. 登录验证：判断用户是否登录。
6. 其他：处理cookie、本地化、国际化、主题等。

自定义 Intercepted

Spring MVC 拦截器对应 HandlerInterceptor 接口，该接口定义了三个方法，若要实现该接口，就要实现其三个方法：
1. 前置处理（preHandle()方法）：该方法在执行控制器方法之前执行。返回值为Boolean类型，如果返回false，表示拦截请求，不再向下执行，如果返回true，表示放行，程序继续向下执行（如果后面没有其他Interceptor，就会执行controller方法）。所以此方法可对请求进行判断，决定程序
是否继续执行，或者进行一些初始化操作及对请求进行预处理。
2. 后置处理（postHandle()方法）：该方法在执行控制器方法调用之后，且在返回ModelAndView
之前执行。由于该方法会在DispatcherServlet进行返回视图渲染之前被调用，所以此方法多被用于
处理返回的视图，可通过此方法对请求域中的模型和视图做进一步的修改。
3. 已完成处理（afterCompletion()方法）：该方法在执行完控制器之后执行，由于是在Controller
方法执行完毕后执行该方法，所以该方法适合进行一些资源清理，记录日志信息等处理操作。

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        /*
            业务逻辑
        */
        System.out.println("preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        /*
            业务逻辑
        */
        System.out.println("postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        /*
            业务逻辑
        */
        System.out.println("afterCompletion");
    }
}

注册 Intercepted

创建一个配置类并继承了 WebMvcConfigurer，重写 addInterceptors 这个方法，进行拦截器的配置，主要配置项就两个，一个是指定拦截器，第二个是指定拦截的URL。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class MyConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //连接所有
        registry.addInterceptor(new MyIntercepor());
    }
}

结果

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class TestController {
    @RequestMapping("/")
    void test() {
        System.out.println("test");
    }
}

问题

1. 在配置拦截器的注册时，如果不加拦截路径，则默认配置拦截所有请求。
2. addPathPatterns：表示需要拦截的 URL，“**”表示拦截任意方法（也就是所有方法）。
3. excludePathPatterns：表示需要排除的 URL。
4. 配置拦截的uri做配置match时是不包含这个server.servlet.context-path项目父路径的。