【JavaEE】SpringBoot 拦截器详解 （统⼀功能处理）

Spring Boot 统⼀功能处理，也就是上一节 Spring AOP 的实战应用环节，本节要实现的目标有以下 3 个：

1. 统⼀⽤户登录权限验证；
2. 统⼀数据格式返回；
3. 统⼀异常处理。

这三个应用基本涵盖了企业开发中需要实现的需求，所以把这三个操作弄懂弄熟是很有必要的！

1. 用户登录权限效验

在实现进行用户是否登录了的校验时，学习了spring AOP 之后，我们就可以实现统一的用户登录验证处理了，具体实现是应用到了springboot的拦截器，下面就来进行详细的使用讲解：

1.1 Spring AOP 用户统⼀登录验证的问题

在讲解spring拦截器之前，我们需要知道为什么要使用拦截器，而不是使用前面spring AOP中的前置通知或者环绕通知：
这两个方案具体代码如下：

@Component
@Aspect
public class UserAspect {

    // 定义切点方法 controller 包下，子孙包下所有类的所有方法
    @Pointcut("execution(* com.example.demo.controller..*.*(..))")
    public void pointcut(){}

    // 前置方法
    @Before("pointcut()")
    public void doBefore(){
        System.out.println("这里执行前置方法逻辑");
    }

    @Around("pointcut()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint){
        Object obj=null;
        System.out.println("Around 方法开始执行");
        try {
            // 执行拦截方法
            obj=proceedingJoinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        System.out.println("Around 方法结束执行");
        return obj;
    }
}

如果要在以上 Spring AOP 的切⾯中实现⽤户登录权限效验的功能，有以下两个问题：

1. 没办法获取到 HttpSession 对象。（判断用户是否登录用到）
2. 我们要对⼀部分⽅法进⾏拦截，⽽另⼀部分⽅法不拦截，如注册⽅法和登录⽅法是不拦截的，这样的话排除⽅法的规则很难定义，甚⾄没办法定义。（除了登录注册不拦截，静态资源不拦截，其余基本都要拦截）

为了解决以上使用spring AOP 没法实现的地方，我们就需要使用到 spring 拦截器，以下是拦截器的详细用法：

1.2 Spring 拦截器

对于以上问题 Spring 中提供了具体的实现拦截器：HandlerInterceptor，拦截器的实现分为以下两个步骤：

1. 创建⾃定义拦截器，实现 HandlerInterceptor 接⼝的 preHandle（执⾏具体⽅法之前的预处理，拦截逻辑就写在这）⽅法。
2. 将⾃定义拦截器加⼊ WebMvcConfigurer 的 addInterceptors ⽅法中（加入系统配置，定义拦截规则）

具体实现如下：

1.2.1 自定义拦截器

接下来使用代码来实现⼀个⽤户登录的权限效验，⾃定义拦截器是⼀个普通类，具体实现代码如下：

/**
 * 自定义用户登录的拦截器
 */
@Component // 需要用到属性注入此类时候加
public class LoginIntercept implements HandlerInterceptor {
    /**
     * 返回TRUE表示拦截判断通过，可以访问后面的接口，如果返回FALSE表示拦截未通过，直接返回结果给前端
     * 
     * */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 1.得到 httpsession 对象
        HttpSession session=request.getSession(false);
        if (session!=null && session.getAttribute("userinfo")!=null){
            // 表示已登录
            return true;
        }
        // 执行到此行代码表示未登录，跳转到登录页面
        response.sendRedirect("/login.html");
        return false;
    }
}

1.2.2 将自定义拦截器加入到系统配置

将上⼀步中的⾃定义拦截器加⼊到系统配置信息中，具体实现代码如下：

@Configuration // 一定不要写错
public class AppConfig implements WebMvcConfigurer {

    @Autowired
    private LoginIntercept loginIntercept;

    @Override
    public void addInterceptors(InterceptorRegistry registry) { // 将自定义拦截器注册
        registry.addInterceptor(loginIntercept)
                .addPathPatterns("/**"). // 拦截所有的url
                excludePathPatterns("/user/login"). // 排除哪些不拦截，其余都拦截
                excludePathPatterns("/user/reg").
                excludePathPatterns("/login.html").
                excludePathPatterns("/reg.html").
                excludePathPatterns("/**/*.js").
                excludePathPatterns("/**/*.css").
                excludePathPatterns("/**/*.png").
                excludePathPatterns("/**/*.jpg");
    }

//    @Override
//    public void configurePathMatch(PathMatchConfigurer configurer) {
//        configurer.addPathPrefix("api",c -> true);
//    }
}

其中：

• addPathPatterns：表示需要拦截的 URL，“**”表示拦截任意⽅法（也就是所有⽅法）。
• excludePathPatterns：表示需要排除的 URL。

注意：以上定义拦截规则时候记得排除拦截此项⽬中的使⽤的静态资源 URL，包括静态⽂件（图⽚⽂件、JS 和 CSS 等⽂件）

此时在没有登录时候访问 index.html 就是发现没法访问的：（因为在拦截逻辑中实现了没有登录的话直接跳转到登录页面，所以此时访问index.html后自动跳转到了login.html），fiddler抓包如下：

一次性抓到了两个请求，其中对index.html的访问需要注意虽然不能成功访问，但是响应状态码依旧是正常的200（此处我设置了请求重定向，所以抓到的状态码是302）：

访问登录页面就不会触发拦截，可以正常访问，且只有一个包：

1.3 拦截器实现原理

正常情况下的调⽤顺序：

然而有了拦截器之后，会在调⽤ Controller 之前进⾏相应的业务处理，执⾏的流程如下图所示 ：

实现原理源码分析结果如下：
所有的 Controller 执⾏都会通过⼀个调度器 DispatcherServlet 来实现，这⼀点可以从 Spring Boot 控制台的打印信息看出，如下图所示：

所有⽅法都会执行 DispatcherServlet （调度器）中的 doDispatch 调度⽅法，从源码（篇幅有限，就不在此展示）可以分析出在开始执⾏ Controller 之前，会先调⽤ 预处理⽅法 applyPreHandle，⽽applyPreHandle ⽅法的实现源码如下：

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse
response) throws Exception {
    for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex
= i++) {
        // 获取项⽬中使⽤的拦截器 HandlerInterceptor
        HandlerInterceptor interceptor =
(HandlerInterceptor)this.interceptorList.get(i);
        if (!interceptor.preHandle(request, response, this.handler)) {
            this.triggerAfterCompletion(request, response,
(Exception)null);
            return false;
       }
   }
    return true;
}

从上述源码可以看出，在 applyPreHandle 中会获取所有的拦截器 HandlerInterceptor 并执⾏拦截器中的 preHandle ⽅法，这样就和前⾯定义的拦截器对应上了，如下图所示：

此时⽤户登录权限的验证⽅法就会执⾏，这就是拦截器的实现原理~

通过上⾯的源码分析，可以看出，Spring 中的拦截器也是通过动态代理和环绕通知的思想实现的，⼤体的调⽤流程如下：

1.4 扩展：统⼀访问前缀添加

给所有请求地址添加 api 前缀：

@Configuration // 一定不要写错
public class AppConfig implements WebMvcConfigurer {

    @Autowired
    private LoginIntercept loginIntercept;
    
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("api",c -> true); // 所有的接⼝添加 api 前缀
    }
}

其中第⼆个参数是⼀个表达式，设置为 true 表示启动前缀。

此时访问所有的接口都需要加上设置的 api 前缀 ：
接口：

访问：

2. 统一异常处理

统⼀异常处理使⽤的是 @ControllerAdvice + @ExceptionHandler 来实现的，@ControllerAdvice 表示控制器通知类（增强类），@ExceptionHandler 是异常处理器，两个结合表示当出现异常的时候执⾏某个通知，也就是执⾏某个⽅法事件，具体实现代码如下：

因为不确定代码中会触发哪个具体的异常，（异常不可控），所以使用异常（除了自定义异常）的父类 Exception.class来实现统一的异常处理：

@RestControllerAdvice // 组合注解，responsebody+controller ，允许返回一个json格式的信息给前端
public class MyExceptionAdvice {

    @ExceptionHandler(Exception.class)
    public HashMap<String,Object> exceptionAdvice(Exception e){
        HashMap<String,Object> result=new HashMap<>();
        result.put("state",-1);
        result.put("data",null);
        result.put("meg","异常:"+e.getMessage());
        return result;
    }
}

PS：⽅法名和返回值可以⾃定义，其中最重要的是 @ExceptionHandler(Exception.class) 注解。

此时如果访问 controller 中的会触发异常的接口：

代码就会自动进行统一的异常处理，避免出现错误导致程序奔溃（并返回统一异常处理返回的结果）：

以上⽅法表示，如果出现了异常就返回给前端⼀个 HashMap 的对象（json数据），其中包含的字段如代码中定义的那样。

可以针对不同的异常，返回不同的结果，如以下代码所示：

@RestControllerAdvice // 组合注解，responsebody+controller ，允许返回一个json格式的信息给前端
public class MyExceptionAdvice {

    @ExceptionHandler(Exception.class)
    public HashMap<String,Object> exceptionAdvice(Exception e){
        HashMap<String,Object> result=new HashMap<>();
        result.put("state",-1);
        result.put("data",null);
        result.put("meg","总的异常:"+e.getMessage());
        return result;
    }

    @ExceptionHandler(NullPointerException.class)
    public HashMap<String,Object> nullPointerExceptionAdvice(NullPointerException e){
        HashMap<String,Object> result=new HashMap<>();
        result.put("state",-1);
        result.put("data",null);
        result.put("meg","空指针异常:"+e.getMessage());
        return result;
    }
}

此时访问一个空指针异常：


得出结论：当有多个异常通知时，匹配顺序为当前类及其⼦类向上依次匹配：

3. 统一数据返回格式

3.1 为什么需要统⼀数据返回格式？

统⼀数据返回格式的优点有很多，⽐如以下⼏个：

1. ⽅便前端程序员更好的接收和解析后端数据接⼝返回的数据。
2. 降低前端程序员和后端程序员的沟通成本，按照某个格式实现就⾏了，因为所有接⼝都是这样返回
   的。
3. 有利于项⽬统⼀数据的维护和修改。
4. 有利于后端技术部⻔的统⼀规范的标准制定，不会出现稀奇古怪的返回内容。

3.2 统⼀数据返回格式的实现

统⼀的数据返回格式可以使⽤ @ControllerAdvice + ResponseBodyAdvice 的⽅式实现，具体实现代码如下：

@ControllerAdvice
public class MyResponseAdvice implements ResponseBodyAdvice {

    /**
     * 返回一个布尔值，true表示返回数据之前对数据进行重写，也就是会进入到 beforeBodyWrite 方法，再返回
     * 如果返回false，表示对结果不做任何处理直接返回
     * @param returnType
     * @param converterType
     * @return
     */
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        HashMap<String,Object> result=new HashMap<>();
        result.put("state",1);
        result.put("data",body);
        result.put("msg","");
        return result;
    }
}

此时访问登录方法，要是登录成功，则返回这个设置的统一格式：

3.3 注意特例：返回String类型数据

如果要使用统一数据返回返回String类型的数据，需要在统一处理前面做一个判断（instanceof）。如果不做这个判断，程序是无法正常返回的，会报错，报错信息如下：
controller代码：

此时进行访问：
发现data数据是异常的：

因为前面做了统一异常处理，看到的信息就是一个200的正常返回信息，如果不做统一异常处理，就会报500的错误提示了，导致程序崩溃无法正常执行：

此时如果我们要返回一个string类型数据，需要做如下判断：

完整代码如下：

@ControllerAdvice
public class MyResponseAdvice implements ResponseBodyAdvice {
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true; // 当出现了返回数据 事件 时候执行次通知，true为所有返回数据事件都执行下面方法
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
                                  Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof String){
            return body;
        }
        HashMap<String,Object> result=new HashMap<>();
        result.put("state",1);
        result.put("data",body);
        result.put("msg","");
        return result;
    }
}

此时再去进行访问，就能看到单独返回了string，程序不会报错崩溃了：

我们一般不需要返回 String ，因为操作无非就是四种：增删查改（CRUD），前三种返回的一般都是受影响的行数，是int类型的，可以正常返回；而查询一般返回的都是对象，单独返回string的一般用不到；

4. 总结

• 统⼀⽤户登录权限的效验使⽤ WebMvcConfigurer+ HandlerInterceptor来实现
• 统⼀异常处理使⽤ @ControllerAdvice + @ExceptionHandler 来实现
• 统⼀返回值处理使⽤ @ControllerAdvice+ ResponseBodyAdvice 来处理

补充：以上测试spring统一功能处理的代码目录结构如下：

• 这三个统一功能的处理需要我们多加练习才能更好的掌握

• over ~ ✨