拦截器Interceptor

1、简要介绍

• 拦截器是Spring中的概念，和过滤器类似，可以对用户的请求进行拦截过滤处理。但是相对于过滤器而言，拦截器要控制得更加细节，拦截器可以在三个地方进行执行：

1. 在请求到达Controller控制器之前，通过拦截器执行一段代码
2. 在控制器执行之后，通过拦截器执行一段代码（此时只是Controller执行完毕，视图还没有开始渲染）
3. 在整个请求结束的时候还可以通过拦截器执行一段代码

• 使用方法：

1. 创建支持它的@Component类，它应该实现HandlerInterceptor接口
2. 实现WebMVCConfigure配置器，注册到Spring容器中，添加拦截路径和放行路径

2、与过滤器的区别

• 拦截器类似于Servlet中的过滤器，主要用于拦截客户请求并做出响应。与过滤器主要有以下区别：

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

• 拦截器是在DispatcherServlet这个servlet中执行的，因此所有请求最先进入Filter，最后离开Filter。顺序如下：
• Filter -->Interceptor.preHandle -->Handler -->Interceptor.postHandle -->Interceptor.afterCompletion -->Filter.

3、应用场景

• 拦截器本质上是面向切面编程（AOP），符合横切关注点的功能都可以放在拦截器中来实现，主要的应用场景包括：

1. 登录验证，判断用户是否登录
2. 权限验证，判断用户是否有权限访问资源，如校验token
3. 日志记录，记录请求操作日志（用户ip，访问时间等），一边统计请求访问量
4. 处理cookie、本地化、国际化、主题等
5. 性能监控，监控请求处理时长等

4、实现流程

自定义拦截器

package com.example.interceptor.interceptor;

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

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

@Component
public class SampleInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,Object handler){
        System.out.println("\n已进入拦截器");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView){
        System.out.println("拦截器执行完毕");
    }

    @Override
    public void afterCompletion(HttpServletRequest request,HttpServletResponse response,Object handler,Exception exception){
        System.out.println("得到返回结果："+response);
        System.out.println("请求完毕\n");
    }
}

注入适配器并设置拦截路径

package com.example.interceptor.interceptor;

import org.springframework.beans.factory.annotation.Autowired;
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 InterceptorConfig implements WebMvcConfigurer {
    @Autowired
    SampleInterceptor sampleInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(sampleInterceptor).addPathPatterns("/**").excludePathPatterns("/**/LoginController/**/*,*/**/error")
        .excludePathPatterns("/error");
        WebMvcConfigurer.super.addInterceptors(registry);
    }
}

多个拦截器顺序：

• 先注册的拦截器先执行
• 可以通过Order方法来设置执行的顺序，值越小越先执行

测试接口

package com.example.interceptor.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/interceptor")
public class DemoController {


    @GetMapping("/demo")
    public String demoAction() {
        System.out.println("interceptor-demo......");
        return "success";
    }

}