Java - Spring项目的统一功能处理

目标

Spring Boot 统⼀功能处理模块，也是 AOP 的实战环节，要实现的目标有以下 3 个：

1. 使用拦截器实现用户登录权限的统一验证；
2. 统⼀数据格式返回；
3. 统⼀异常处理。

---

用户登录权限效验

用户登录权限的发展从之前每个方法中自己验证用户登录权限，到现在统⼀的用户登录验证处理，它是⼀个逐渐完善和逐渐优化的过程。

每个方法中都有相同的用户登录验证权限，它的缺点是：

1. 每个方法中都要单独写用户登录验证的方法，即使封装成公共方法，也⼀样要传参调用和在方法中进行判断。
2. 添加控制器越多，调用用户登录验证的方法也越多，这样就增加了后期的修改成本和维护成本。
3. 这些用户登录验证的方法和接下来要实现的业务几何没有任何关联，但每个方法中都要写⼀遍。 所以提供⼀个公共的 AOP 方法来进行统⼀的用户登录权限验证迫在眉睫。

一个项目里面实现统一用户验证登录的处理, 一般有三种解决方案:

• 使用传统的 AOP,

• 使用拦截器,

• 使用过滤器.

说到统⼀的用户登录验证，我们想到的第⼀个实现方案是 Spring AOP 前置通知或环绕通知来实现

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

1. 定义拦截的规则(表达式)非常难。（我们要对⼀部分方法进行拦截，而另⼀部分方法不拦截，如注册方法和登录方法是不拦截的，这样 的话排除方法的规则很难定义，甚至没办法定义）。
2. 在切面类中拿到 HttpSession 比较难

使用过滤器.

对于过滤器 (web容器提供的), 因为它的执行时机太靠前了, Spring 框架还没初始化, 也就是说触发过滤器的时候, request, response 对象还没有实例化. 所以过滤器用的也比较少.

那如何解决呢？

Spring 拦截器

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

1. 创建自定义拦截器，实现 HandlerInterceptor 接口的 preHandle（执行具体方法之前的预处理方法。
2. 将自定义拦截器加入WebMvcConfigurer 的 addInterceptors 方法中。

实现拦截器

关键步骤:
a.实现 HandlerInterceptor 接口
b.重写 preHeadler 方法，在方法中编写自己的业务代码

package com.example.demo.config;

import org.springframework.web.servlet.HandlerInterceptor;

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

public class LoginInterceptor implements HandlerInterceptor {
    /**
     * 此方法返回一个 boolean，如果为 true 表示验证成功，可以继续执行后续流程如果是 false 表示验证失败，后面的流程不能执行了
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //用户登录业务判断
        HttpSession session=request.getSession(false);
        if (session != null && session.getAttribute("userinfo") != null) {
            // 说明用户已经登录
            return true;
        }
        // 可以调整到登录页面 or 返回一个 401/403 没有权限码
        response.sendRedirect("/login.html");
//        response.setStatus(403);
        return false;
    }
}

 

 将拦截器添加到配置文件中，并且设置拦截的规则

package com.example.demo.config;

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