Java EE 突击 15 - Spring Boot 统一功能处理

﹏ヽ暗。殇╰゛Y 2024-03-24 23:50 113阅读 0赞

#### Spring Boot 统一功能处理 ####

*  一 . 统一功能的处理
 *   *  1.1 初级阶段 : 不断重复
     *  1.2 中级阶段 : 集成方法
     *  1.3 高级阶段 : Spring AOP
     *  1.4 超高级阶段 : Spring 拦截器
     *   *  准备工作
         *  实现拦截器
         *   *  自定义拦截器
             *  将自定义拦截器加入到系统配置
         *  拦截器实现原理
         *  扩展 : 统一访问前缀添加
 *  二 . 统一异常的处理
 *   *  2.1 统一异常的处理的实现
     *  2.2 细化异常
 *  三 . 统一数据返回格式
 *   *  3.1 为什么需要统一数据返回格式？
     *  3.2 统一数据返回格式的实现
     *  3.3 @ControllerAdvice 源码分析

> 这个专栏给大家介绍一下 Java 家族的核心产品 - SSM 框架  
> [JavaEE 进阶专栏][JavaEE]
> 
> Java 语言能走到现在 , 仍然屹立不衰的原因 , 有一部分就是因为 SSM 框架的存在
> 
> 接下来 , 博主会带大家了解一下 Spring、Spring Boot、Spring MVC、MyBatis 相关知识点
> 
> 并且带领大家进行环境的配置 , 让大家真正用好框架、学懂框架
> 
> 来上一篇文章复习一下吧  
> [点击即可跳转到前置文章][Link 1]  
> CSDN 平台观感有限 , 可以私聊作者获取源笔记链接  
> ![在这里插入图片描述][81d4cbe2664c4deb8bdd90ecd189a2ad.png]

上一篇文章是 Spring AOP 理论阶段 , 这篇文章就进入了 Spring AOP 实战  
我们会讲解这三种功能 :

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

我们新创建一个项目来完成这三项功能  
![image.png][]  
![image.png][image.png 1]  
![image.png][image.png 2]  
![image.png][image.png 3]  
![image.png][image.png 4]  
![image.png][image.png 5]  
![image.png][image.png 6]  
![image.png][image.png 7]  
![image.png][image.png 8]  
![image.png][image.png 9]  
![image.png][image.png 10]

## 一 . 统一功能的处理 ##

### 1.1 初级阶段 : 不断重复 ###

我们先来回顾⼀下最初用户登录验证的实现方法 :

@RestController
    @RequestMapping("/user")
    public class UserController {
        
    	/**
    	 * 某⽅法 1
    	 */
    	@RequestMapping("/m1")
    	public Object method(HttpServletRequest request) {
        
    		// 有 session 就获取，没有不会创建
    		HttpSession session = request.getSession(false);
    		if (session != null && session.getAttribute("userinfo") != null) {
        
    			// 说明已经登录，业务处理
    			return true;
    		} else {
        
    			// 未登录
    			return false;
    		}
    	}
    
    	/**
    	 * 某⽅法 2
    	 */
    	@RequestMapping("/m2")
    	public Object method2(HttpServletRequest request) {
        
    		// 有 session 就获取，没有不会创建
    		HttpSession session = request.getSession(false);
    		if (session != null && session.getAttribute("userinfo") != null) {
        
    			// 说明已经登录，业务处理
    			return true;
    		} else {
        
    			// 未登录
    			return false;
    		}
    	}
    	// 其他⽅法...
    }

![image.png][image.png 11]

### 1.2 中级阶段 : 集成方法 ###

我发现我们每一个需要登录授权的地方都需要写重复的代码 , 那我们索性就直接封装成统一的方法  
但是在业务方法里面还是要调用公共方法的  
一旦公共方法增加了参数 , 那我们调用公共方法的位置还是需要进行更改 , 依然很麻烦

### 1.3 高级阶段 : Spring AOP ###

import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.*;
    import org.springframework.stereotype.Component;
    
    @Aspect
    @Component
    public class UserAspect {
        
        // 定义切点⽅法 controller 包下、⼦孙包下所有类的所有⽅法
        @Pointcut("execution(* com.example.demo.controller..*.*(..))")
        public void pointcut() {
        
        }
    
        // 前置⽅法
        @Before("pointcut()")
        public void doBefore() {
        
        }
    
        // 环绕⽅法
        @Around("pointcut()")
        public Object doAround(ProceedingJoinPoint joinPoint) {
        
            Object obj = null;
            System.out.println("Around ⽅法开始执⾏");
            try {
        
                // 执⾏拦截⽅法
                obj = joinPoint.proceed();
            } catch (Throwable throwable) {
        
                throwable.printStackTrace();
            }
            System.out.println("Around ⽅法结束执⾏");
            return obj;
        }
    }

![image2.png][]  
虽然环绕方法很香 , 但是我们也发现了两个问题 :

1.  我们拿不到 HttpSession 对象了
2.  拦截规则写起来还是比较复杂的 , 我们就是有一种需求 : controller 文件夹下 , 有的方法就是需要进行拦截的 , 而有的方法是不需要进行拦截的 , 那我们去写拦截表达式就会非常复杂

![image.png][image.png 12]

### 1.4 超高级阶段 : Spring 拦截器 ###

对于上面的两个问题 , Spring 官方也考虑到了这个问题 , 他们就推出了具体的实现拦截器 : HandlerInterceptor , 他是在 Spring AOP 上进行了封装 , 让拦截变得更加简单 , 功能更加丰富 .  
拦截器的实现分为以下两个步骤 :

1.  创建自定义拦截器 , 实现 HandlerInterceptor 接口 , 重写 preHandle ( 执行具体方法之前的预处理 ) 方法 , 返回 boolean
2.  将自定义拦截器加入 WebMvcConfigurer 的 addInterceptors 方法中

接下来 , 我们就尝试一下 Spring 拦截器

#### 准备工作 ####

在 demo 底下新建一个包 controller , 里面写一个类 : UserController  
![image.png][image.png 13]  
![image.png][image.png 14]  
编写业务逻辑

package com.example.demo.controller;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.servlet.http.HttpServletRequest;
    
    @RestController
    @RequestMapping("/user")
    public class UserController {
        
        /**
         * 登录需要传入用户名密码
         * 验证用户名密码是否正确需要传入 request 对象
         * @param request
         * @param username
         * @param password
         * @return
         */
        @RequestMapping("login")
        public boolean login(HttpServletRequest request,
                             String username, String password) {
        
            // 1. 非空判断
            if(username != null && username != "" &&
               password != null && password != "") {
        
                // 2. 验证用户名和密码是否正确
            }
            
            return false;
        }
    }

但是非空判断这里 , 不太雅观 , Spring 就给我们提供了一种方式  
![image.png][image.png 15]  
千万千万不要选错 , 咱们这个是 Spring Boot 项目 , 当然要去找 Spring 提供的方法  
使用他的 hasLength() 方法就可以判定是不是空以及是不是空字符串  
![image.png][image.png 16]  
![image.png][image.png 17]  
然后继续完善我们的登录功能

package com.example.demo.controller;
    
    import org.springframework.util.StringUtils;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpSession;
    
    @RestController
    @RequestMapping("/user")
    public class UserController {
        
        /**
         * 登录需要传入用户名密码
         * 验证用户名密码是否正确需要传入 request 对象
         * @param request
         * @param username
         * @param password
         * @return
         */
        @RequestMapping("login")
        public boolean login(HttpServletRequest request,
                             String username, String password) {
        
            // 1. 非空判断
            // StringUtils.hasLength()
            // 有值 -> 返回 true
            // 为 null -> 返回 false
            if(StringUtils.hasLength(username) && StringUtils.hasLength(password)) {
        
                // 2. 验证用户名和密码是否正确(伪代码)
                if("admin".equals(username) && "admin".equals(password)) {
        
                    // 登陆成功
                    // 把登录信息放进 HttpSession 里面
                    HttpSession session = request.getSession();
                    session.setAttribute("userinfo","admin");
                    return true;
                } else {
        
                    // 登陆失败
                    // 用户名或密码错误
                    return false;
                }
            }
            return false;
        }
        
    }

接下来 , 我们再去实现获取个人信息方法

package com.example.demo.controller;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.util.StringUtils;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpSession;
    
    @RestController
    @RequestMapping("/user")
    @Slf4j
    public class UserController {
        
        /**
         * 登录需要传入用户名密码
         * 验证用户名密码是否正确需要传入 request 对象
         * @param request
         * @param username
         * @param password
         * @return
         */
        @RequestMapping("login")
        public boolean login(HttpServletRequest request,
                             String username, String password) {
        
            // 1. 非空判断
            // StringUtils.hasLength()
            // 有值 -> 返回 true
            // 为 null -> 返回 false
            if(StringUtils.hasLength(username) && StringUtils.hasLength(password)) {
        
                // 2. 验证用户名和密码是否正确(伪代码)
                if("admin".equals(username) && "admin".equals(password)) {
        
                    // 登陆成功
                    // 把登录信息放进 HttpSession 里面
                    HttpSession session = request.getSession();
                    session.setAttribute("userinfo","admin");
                    return true;
                } else {
        
                    // 登陆失败
                    // 用户名或密码错误
                    return false;
                }
            }
            return false;
        }
    
        /**
         * 获取个人信息(伪代码)
         * @return
         */
        @RequestMapping("/getinfo")
        public String getInfo() {
        
            // 使用日志,需要添加 @Slf4j 注解
            log.debug("执行了 getinfo 方法");
            return "执行了 getinfo 方法";
        }
    }

接下来 , 我们再去实现注册功能

package com.example.demo.controller;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.util.StringUtils;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpSession;
    
    @RestController
    @RequestMapping("/user")
    @Slf4j
    public class UserController {
        
        /**
         * 登录需要传入用户名密码
         * 验证用户名密码是否正确需要传入 request 对象
         * @param request
         * @param username
         * @param password
         * @return
         */
        @RequestMapping("/login")
        public boolean login(HttpServletRequest request,
                             String username, String password) {
        
            // 1. 非空判断
            // StringUtils.hasLength()
            // 有值 -> 返回 true
            // 为 null -> 返回 false
            if(StringUtils.hasLength(username) && StringUtils.hasLength(password)) {
        
                // 2. 验证用户名和密码是否正确(伪代码)
                if("admin".equals(username) && "admin".equals(password)) {
        
                    // 登陆成功
                    // 把登录信息放进 HttpSession 里面
                    HttpSession session = request.getSession();
                    session.setAttribute("userinfo","admin");
                    return true;
                } else {
        
                    // 登陆失败
                    // 用户名或密码错误
                    return false;
                }
            }
            return false;
        }
    
        /**
         * 获取个人信息
         * @return
         */
        @RequestMapping("/getinfo")
        public String getInfo() {
        
            // 使用日志,需要添加 @Slf4j 注解
            log.debug("执行了 getinfo 方法");
            return "执行了 getinfo 方法";
        }
    
        /**
         * 注册功能(伪代码)
         */
        @RequestMapping("/reg")
        public String reg() {
        
            // 使用日志,需要添加 @Slf4j 注解
            log.debug("执行了 reg 方法");
            return "执行了 reg 方法";
        }
    }

在 UserController 中 , 我们需要拦截 getInfo() 方法 , 而 login() reg() 方法是不需要拦截的

#### 实现拦截器 ####

##### 自定义拦截器 #####

接下来 , 我们再新建一个包去写拦截器 , 包名叫做 config , 再写一个类 : LoginInterceptor ( 登录拦截器 )  
![image.png][image.png 18]  
![image.png][image.png 19]  
自定义拦截器的步骤 : 创建自定义拦截器 , 实现 HandlerInterceptor 接口 , 重写 preHandle ( 执行具体方法之前的预处理 ) 方法 , 返回 boolean  
编写以下代码

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;
    
    /**
     * 登录拦截器
     */
    // 1. 创建自定义拦截器 , 实现 HandlerInterceptor 接口 , 重写 preHandle ( 执行具体方法之前的预处理 ) 方法 , 返回 boolean
    public class LoginInterceptor implements HandlerInterceptor {
        
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            // 登录判断的业务
            // false : 有 session 直接得到 session , 没有 session 就不需要再创建 session 了
            // 如果用在登录判断的业务上,一定要用 session
            HttpSession session = request.getSession(false);
            if(session != null && session.getAttribute("userinfo") != null) {
        
                return true;
            }
            // 非必须:可以设置状态码
            response.setStatus(401);//401代表没有权限
            // 也可以实现页面跳转
            // response.sendRedirect("xxx.html");
            // 默认不执行返回 false
            return false;
        }
    }

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

目前我们实现了第一步 : 创建自定义拦截器 , 接下来完成第二步 : 配置拦截规则

1.  创建一个类 , 实现 WebMvcConfigurer

![image.png][image.png 20]  
![image.png][image.png 21]

1.  重写 addInterceptors 方法

![image.png][image.png 22]

1.  为了想要拦截器在 Spring 程序启动时就生效 , 我们需要添加 @Configuration 注解

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.WebMvcConfigurer;
    
    @Configuration
    // 1. 实现 WebMvcConfigurer
    public class MyConfig implements WebMvcConfigurer {
        
        // 2. 重写 addInterceptors 方法
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            
        }
    }

1.  把自定义拦截器加载到拦截规则中 , 使用 registry

> 那为什么在 Spring 里面 , 我们还要 new 对象呢 ?  
> ![image.png][image.png 23]  
> 我们也可以不用 new , 在 登录拦截器的实现的类 (LoginInterceptor) 中添加 @Component 注解  
> 这就代表我们当前的类托管到 Spring 里面了 , 那我们就可以在配置拦截规则的类中把属性注入进来了  
> ![image.png][image.png 24]

这样写完之后 , 我们的拦截器就生效了 , 但是规则还未制指定 , 制定规则使用 addPathPatterns 代表全部拦截 , excludePathPatterns 代表不拦截谁

package com.example.demo.config;
    
    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
    // 1. 实现 WebMvcConfigurer
    public class MyConfig implements WebMvcConfigurer {
        
        @Autowired
        private LoginInterceptor loginInterceptor;
        // 2. 重写 addInterceptors 方法
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            registry.addInterceptor(loginInterceptor)
                    .addPathPatterns("/**") // 拦截所有请求
                    .excludePathPatterns("/user/login")  // 排除不拦截的 URL
                    .excludePathPatterns("/*.js") // 还可以使用表达式,拦截所有的js
                    .excludePathPatterns("/user/reg");
        }
    }

接下来齐活 , 我们就可以运行一下了  
reg 方法是不拦截的 , 那么我们访问一下 reg 方法看看  
![image.png][image.png 25]  
![image.png][image.png 26]  
再看一下 getinfo 方法  
![image.png][image.png 27]  
打开谷歌的开发者工具看看  
![image.png][image.png 28]  
![image.png][image.png 29]  
这就说明我们的拦截器起作用了  
我们可以通过打印日志更清晰地查看效果  
![image.png][image.png 30]  
重新运行  
![image.png][image.png 31]  
![image.png][image.png 32]

> 但是离谱的是 : 我们再访问 reg 方法 , 他仍然被拦截了  
> ![image.png][image.png 33]  
> 打开 reg 页面的开发者工具看一看是咋回事  
> ![image.png][image.png 34]  
> 那么这个 favicon.ico 是什么 , 他为什么会被拦截 ?  
> 比如我们访问百度页面  
> ![image.png][image.png 35]  
> 圈出来的部分就是一个小的百度图标 , 其实这就是我们的 favicon.ico  
> 我们设置拦截规则的时候也要把它排除在外 , 否则所有的页面都要被拦截的

package com.example.demo.config;
    
    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
    // 1. 实现 WebMvcConfigurer
    public class MyConfig implements WebMvcConfigurer {
        
        @Autowired
        private LoginInterceptor loginInterceptor;
        // 2. 重写 addInterceptors 方法
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            registry.addInterceptor(loginInterceptor)
                    .addPathPatterns("/**") // 拦截所有请求
                    .excludePathPatterns("/user/login")  // 排除不拦截的 URL
                    .excludePathPatterns("/favicon.ico") // 排除状态栏标签小图标;
                    .excludePathPatterns("/user/reg");
        }
    }

> 接下来 , 再运行  
> ![image.png][image.png 36]  
> ![image.png][image.png 37]  
> 还是一直被拦截 , 这时候 , 就需要考虑考虑是不是我们的缓存的问题呢 ?  
> ![image.png][image.png 38]  
> 再次运行  
> ![image.png][image.png 39]  
> ![image.png][image.png 40]  
> 再次失败 (图标这个问题真的很顽固)

但是 reg 方法是没有被拦截的  
![image.png][image.png 41]  
getinfo 方法  
![image.png][image.png 42]  
![image.png][image.png 43]  
接下来 , 我们挂载一下 session , 让他登陆成功  
我们直接访问 `login`  
![image.png][image.png 44]  
访问 `127.0.0.1:8080/user/login?username=admin&password=admin` , 就变成 true 了  
![image.png][image.png 45]  
接下来再去访问 getinfo 是什么场景呢 ?  
![image.png][image.png 46]  
说明 session 成功挂载 , 但是换个浏览器还是 bbq  
![image.png][image.png 47]  
这是因为 session 的实现是通过谷歌浏览器帮助的 , 存储在谷歌浏览器的 cookie 里面了 , 但是并未存储到 edge 浏览器的 cookie 里面

#### 拦截器实现原理 ####

正常情况  
![image.png][image.png 48]  
拦截器  
![image.png][image.png 49]  
从最开始的直接进入控制器层 , 到现在多了一层校验才能进入控制器层 , Spring AOP 帮我们实现了校验拦截的功能  
所有的 Controller 执行都会通过⼀个调度器 DispatcherServlet 来实现 , 可以从 Spring Boot 控制台的打印信息看出  
我们访问 controller 底下的 login 方法  
![image.png][image.png 50]  
就可以在 Spring Boot 的控制台下面 , 发现 DispatcherServlet 的身影  
![image.png][image.png 51]  
从源码角度来分析  
双击 shift 搜索 DispatchServlet  
![image.png][image.png 52]  
CTRL + F 搜索 doDispatch 就找到了

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
        
        HttpServletRequest processedRequest = request;
        HandlerExecutionChain mappedHandler = null;
        boolean multipartRequestParsed = false;
    
        WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
    
        try {
        
            ModelAndView mv = null;
            Exception dispatchException = null;
    
            try {
        
                processedRequest = checkMultipart(request);
                multipartRequestParsed = (processedRequest != request);
    
                mappedHandler = getHandler(processedRequest);
                if (mappedHandler == null) {
        
                    noHandlerFound(processedRequest, response);
                    return;
                }
    
                HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
    
                String method = request.getMethod();
                boolean isGet = "GET".equals(method);
                if (isGet || "HEAD".equals(method)) {
        
                    long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
                    if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
        
                        return;
                    }
                }
                
                // 调用预处理[重要]
                if (!mappedHandler.applyPreHandle(processedRequest, response)) {
        
                    return;
                }
    
                // 执行 controller 里面的业务
                mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
                if (asyncManager.isConcurrentHandlingStarted()) {
        
                    return;
                }
                applyDefaultViewName(processedRequest, mv);
                mappedHandler.applyPostHandle(processedRequest, response, mv);
            }
            catch (Exception ex) {
        
                dispatchException = ex;
            }
            catch (Throwable err) {
        
                dispatchException = new NestedServletException("Handler dispatch failed", err);
            }
            
            processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
        }
        catch (Exception ex) {
        
            triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
        }
        catch (Throwable err) {
        
            triggerAfterCompletion(processedRequest, response, mappedHandler,
                                   new NestedServletException("Handler processing failed", err));
        }
        finally {
        
            if (asyncManager.isConcurrentHandlingStarted()) {
        
                if (mappedHandler != null) {
        
                    mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
                }
            }
            else {
        
                if (multipartRequestParsed) {
        
                    cleanupMultipart(processedRequest);
                }
            }
        }
    }

我们再看一下源码里面的核心方法  
![image.png][image.png 53]  
![image.png][image.png 54]  
![image.png][image.png 55]  
通过上面的源码分析 , 我们可以看出 , Spring 中的拦截器也是通过动态代理和环绕通知的思想实现的 , 大体的调用流程如下 :  
![image.png][image.png 56]

#### 扩展 : 统一访问前缀添加 ####

在 MyConfig 类中重写 configurePathMatch 方法 , 然后使用他的 addPathPrefix 方法

package com.example.demo.config;
    
    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.PathMatchConfigurer;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    @Configuration
    // 1. 实现 WebMvcConfigurer
    public class MyConfig implements WebMvcConfigurer {
        
        @Autowired
        private LoginInterceptor loginInterceptor;
        // 2. 重写 addInterceptors 方法
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            registry.addInterceptor(loginInterceptor)
                    .addPathPatterns("/**") // 拦截所有请求
                    .excludePathPatterns("/user/login")  // 排除不拦截的 URL
                    .excludePathPatterns("/favicon.ico") // 排除状态栏标签小图标;
                    .excludePathPatterns("/user/reg");
        }
    
        @Override
        public void configurePathMatch(PathMatchConfigurer configurer) {
        
            configurer.addPathPrefix("api",c -> true);
        }
    }

其中第⼆个参数是⼀个表达式 , 设置为 true 表示启动前缀  
它的作用就是 , 我们在地址栏输入的时候 , 需要在前面加上 api (其实很鸡肋)  
![image.png][image.png 57]

> 想要成功访问 , 还要修改一下拦截路径  
> ![image.png][image.png 58]

## 二 . 统一异常的处理 ##

我们在 reg 方法里构造一个异常 , 当这个异常发生了 , 原本的期望是发生异常返回信息给前端 , 让前端知道出现问题了 .  
但是我们目前程序的健壮性并不是很强 , 当我们制造出一个异常之后 , 目前的程序并不能返回错误给前端

package com.example.demo.controller;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.util.StringUtils;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpSession;
    
    @RestController
    @RequestMapping("/user")
    @Slf4j
    public class UserController {
        
        /**
         * 登录需要传入用户名密码
         * 验证用户名密码是否正确需要传入 request 对象
         * @param request
         * @param username
         * @param password
         * @return
         */
        @RequestMapping("login")
        public boolean login(HttpServletRequest request,
                             String username, String password) {
        
            // 1. 非空判断
            // StringUtils.hasLength()
            // 有值 -> 返回 true
            // 为 null -> 返回 false
            if(StringUtils.hasLength(username) && StringUtils.hasLength(password)) {
        
                // 2. 验证用户名和密码是否正确(伪代码)
                if("admin".equals(username) && "admin".equals(password)) {
        
                    // 登陆成功
                    // 把登录信息放进 HttpSession 里面
                    HttpSession session = request.getSession();
                    session.setAttribute("userinfo","admin");
                    return true;
                } else {
        
                    // 登陆失败
                    // 用户名或密码错误
                    return false;
                }
            }
            return false;
        }
    
        /**
         * 获取个人信息
         * @return
         */
        @RequestMapping("/getinfo")
        public String getInfo() {
        
            // 使用日志,需要添加 @Slf4j 注解
            log.debug("执行了 getinfo 方法");
            return "执行了 getinfo 方法";
        }
    
        /**
         * 注册功能(伪代码)
         */
        @RequestMapping("/reg")
        public String reg() {
        
            int num = 10 / 0;
            log.debug("执行了 reg 方法");
            return "执行了 reg 方法";
        }
    
    }

![image.png][image.png 59]  
接下来 , 我们就去浏览器看看效果  
![image.png][image.png 60]  
后端这里就报错了  
![image.png][image.png 61]  
那前端就蒙了 , 我还在这等着你呢 , 你这头自己就偷摸报错了  
那我们就需要通过 Spring AOP 统一异常的处理 , 来加强程序的鲁棒性

### 2.1 统一异常的处理的实现 ###

我们在 config 包底下新创建一个类 , 叫做 ErrorAdvice  
![image.png][image.png 62]  
![image.png][image.png 63]  
统一异常的处理分为以下几步 :

1.  新建一个类 , 加上 @ControllerAdvice 注解

package com.example.demo.config;
    
    /**
     * 统一处理异常
     */
    
    import org.springframework.web.bind.annotation.ControllerAdvice;
    
    @ControllerAdvice 
    public class ErrorAdvice {
        
    }

1.  编写具体的方法 , 在方法上面加上注解 : @ExceptionHandler(Exception.class)

1.  要修改状态码 , 以及把错误信息添加进去

package com.example.demo.config;
    
    /**
     * 统一处理异常
     */
    
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    import java.util.HashMap;
    
    @ControllerAdvice
    public class ErrorAdvice {
        
        // 企业级要求:返回对象(返回HashMap)
        // 添加注解:@ExceptionHandler(Exception.class)
        @ExceptionHandler(Exception.class)
        @ResponseBody // 返回的是数据而不是页面
        public HashMap<String, Object> exAdvice(Exception e) {
        
            HashMap<String, Object> result = new HashMap<>();
            result.put("code","-1");// 出现异常,状态码改成-1
            result.put("msg",e.getMessage());// 把报错信息添加进去,需要在方法参数加上Exception e
            return result;
        }
    }

这就完成了统一异常的处理  
接下来 , 我们再去运行一下  
![image.png][image.png 64]

### 2.2 细化异常 ###

目前我们是实现了大异常 , 我们还可以去实现更细级别的小异常

![image.png][image.png 65]  
![image.png][image.png 66]  
那我们再制造个空指针异常 , 状态码就应该为 -1  
![image.png][image.png 67]  
![image.png][image.png 68]  
前端程序员收到错误信息之后 , 前端程序员就可以进行处理了 , 可以给用户一个页面或者弹窗提示运行失败

## 三 . 统一数据返回格式 ##

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

本质就是降低双方沟通成本

### 3.2 统一数据返回格式的实现 ###

1.  在类上添加 @ControllerAdvice 注解
2.  实现 ResponseBodyAdvice
3.  重写两个方法 :
    
    1.  supports : 固定返回 true
    2.  beforeBodyWrite : 在此方法内构造统一返回对象

我们可以实现一下  
![image.png][image.png 69]  
![image.png][image.png 70]

package com.example.demo.config;
    
    import org.springframework.core.MethodParameter;
    import org.springframework.http.MediaType;
    import org.springframework.http.server.ServerHttpRequest;
    import org.springframework.http.server.ServerHttpResponse;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
    
    import java.util.HashMap;
    
    /**
     * 统一返回数据的处理
     */
    @ControllerAdvice
    public class ResponseAdvice implements ResponseBodyAdvice {
        
    
        @Override
        public boolean supports(MethodParameter returnType, Class converterType) {
        
            // 固定返回 true,这样才能调用下面的方法
            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("code", 200);// 状态码
            result.put("msg", "");// 状态的描述信息
            result.put("data", body);// 数据
            return result;
        }
    }

![image.png][image.png 71]  
运行查看效果  
之前我们登录返回的是布尔值  
![image.png][image.png 72]  
现在就变成了 JSON 数据  
![image.png][image.png 73]  
![image.png][image.png 74]  
![image.png][image.png 75]  
但是统一数据返回格式的方法过于霸道 , 他把所有的对象都进行封装  
比如我们的 getinfo 以及 reg , 已经报错了 , 然后统一异常处理就给他们封装成一个 HashMap 了  
![image.png][image.png 65]  
但是统一数据返回格式又把这个已经封装好的对象又抓过来了 , 进行再次封装 , 所以就会像图片里那样 , data 里面又包含了 code 以及 msg

### 3.3 @ControllerAdvice 源码分析 ###

我们在统一异常的处理和统一数据返回格式之中 , 都用到了 @ControllerAdvice 注解  
![image.png][image.png 76]  
![image.png][image.png 77]  
那这个 @ControllerAdvice 到底是怎么回事呢 ? 我们可以通过源码来看一下  
![image.png][image.png 78]  
@ControllerAdvice 注解也是来自于 @Component 注解的 , 他就相当于 Java 中的 “Object”  
![image.png][image.png 79]  
@ControllerAdvice 派生于 @Component 组件 , 而所有组件初始化都会调用 InitalizingBean 接口  
所以接下来我们来看 InitializingBean 有哪些实现类 ? 在查询的过程中我们发现了 , 其中 Spring MVC  
中的实现子类是 RequestMappingHandlerAdapter , 他里面有⼀个 afterPropertiesSet() 方法 , 表  
示所有的参数设置完成之后执行的方法 (来源于 @Component 注解的其他注解都会使用 afterPropertiesSet() 方法 )  
在 afterPropertiesSet() 方法 中 , 有这样一句代码  
![image.png][image.png 80]  
这个方法是干什么的呢 ?  
![image.png][image.png 81]

> 事件 : 到了某个时间点干什么事

[JavaEE]: https://blog.csdn.net/m0_53117341/category_12149596.html
[Link 1]: https://blog.csdn.net/m0_53117341/article/details/132509645
[81d4cbe2664c4deb8bdd90ecd189a2ad.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/cf02e955bccd49f1a9ed585d8b230490.png
[image.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e88408013bf0463eb281685d15fe9875.png
[image.png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/dddddb7bc3864d3785160cc8533f59a4.png
[image.png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/6ba06b3aec1244969502588d1a08e230.png
[image.png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/9acca97bff5a42eba68b07fc15920168.png
[image.png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/a042e77393504f82afe112efadeee6d6.png
[image.png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/509d1e314bfe415f8def98c04203c3e8.png
[image.png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/0db2c07513bc4e2099c917cdf5d075c6.png
[image.png 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/7c252cbf420f44078edf833e214afd50.png
[image.png 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/8d3b4977b90741308d3081a46adf4db6.png
[image.png 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/d99d1362e978478f85dc2e6d9595f1f9.png
[image.png 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/be884fa298f64f53930186d8cb7da904.png
[image.png 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/1c72753661c14bf59054eaf1aace36bf.png
[image2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/0d413a79967b4c4aa2173b5d41115cf1.png
[image.png 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/d2d06726794e4b28aebd97231814c92a.png
[image.png 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/d0898f07f85548bbae7d14c4c1e9048e.png
[image.png 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/a14118daed5347919ca12441d7ded826.png
[image.png 15]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/b8fcb32f2e5b48fbac1392aaab073b3f.png
[image.png 16]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/6a0054813f874bad95556f65ed24e675.png
[image.png 17]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/5ca9f75f446646729202f7509447ff66.png
[image.png 18]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/2dd3144b592d48daa9dd4b47086bd359.png
[image.png 19]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e1ac81634d384f91bf86d7df3c9f6782.png
[image.png 20]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e9f3d7ce4f1d45f582ae4098026cab11.png
[image.png 21]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/dae4cde573a14827a66e02dc4335906e.png
[image.png 22]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/be7898db01274340a7f1f14fc8693d12.png
[image.png 23]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/65c7254f8fdb40cb8d448cfa14a530b7.png
[image.png 24]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e666268ad4334c34abff3c5600cd40b9.png
[image.png 25]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/57c85f7c5ae4466c9cd1a74d690bd1b6.png
[image.png 26]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/261017ebd0da4112ab62d69eba0f91d6.png
[image.png 27]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/dbdda5933ea04aee94fc2aef40e5a538.png
[image.png 28]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/309bbaf8b0e943928a95035b016dc1d9.png
[image.png 29]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/4cea85e64cc9452e9f9a992af1dc49dc.png
[image.png 30]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/f4f2ff734e6e49c2a47e9cd390d8a119.png
[image.png 31]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/69b06263362d45dd87da51f9dc8dd832.png
[image.png 32]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/a4426fab45bd494b9102a22403ec0dec.png
[image.png 33]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/60d2c26505484b6788cbd587821c62ea.png
[image.png 34]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/7e025b4737ff42c8b923fe3af40eea74.png
[image.png 35]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/dc6907c4bdfd4fa1b780a6c7228ea930.png
[image.png 36]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/1c8c63477cdf4d73992d88dab997cc2d.png
[image.png 37]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/407ba9e47494451e9f7932d30cfe9d42.png
[image.png 38]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/87ac98fbe1934736ab61e4ffd4a7cecb.png
[image.png 39]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/11cc0751d01442f8aa30908b2602e6e5.png
[image.png 40]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e5345c97bb3c46d1a9532f9c58f5f6e7.png
[image.png 41]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/21b1891b0b81489b8c90a5121a7a2173.png
[image.png 42]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/94819b28a50a48d4acf08273961a385b.png
[image.png 43]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/01993ab10fba453a9f286717cc885650.png
[image.png 44]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/8396a27bf00d4738974784f911288ab7.png
[image.png 45]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/66a905f5f3d3455dae31ed895c8bcfbf.png
[image.png 46]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/89c0521f17af4fe2b80383cfdf8bde05.png
[image.png 47]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/2eb7c9dcab124f8eaf03fa25153c15b2.png
[image.png 48]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/691faa8dc199434ba35c0d7958b01cde.png
[image.png 49]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/986ac1ef9f7a49bfb262d122cd8ac3aa.png
[image.png 50]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e5c4f72f735548cea5d89b44e8b70f91.png
[image.png 51]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/5a5f3177d9f1426fb51cdfe0329900b4.png
[image.png 52]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/b9c39bf77528480bb38abf8214ce97cf.png
[image.png 53]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/5caf371dd994436fb1358899e399ba58.png
[image.png 54]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/8d9bde11fec047dd825585ef9c90ffb6.png
[image.png 55]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/18dc85c191e3440e90db23868fd01927.png
[image.png 56]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/1cf66f72133146c499d9ff9448f3dfa8.png
[image.png 57]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/3cf500493f9a41d891422b5f229afdaf.png
[image.png 58]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/0f16f9b3bf0342d6889d2c20adca8998.png
[image.png 59]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/ac1e905373d04e49b8fa10b64592a9a2.png
[image.png 60]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/86e327e6cf9a4a9aade0f9e429d73c23.png
[image.png 61]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/24c0d78d7d8545a18c3e205ecbc59a79.png
[image.png 62]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/7b69af670626404bb92e027adf2e15be.png
[image.png 63]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/0bce728a151c4ae9845021b467a34bf5.png
[image.png 64]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/235b97c9c5474d4b9b91320d36cf879b.png
[image.png 65]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/cfe35838ba094c54b5ca322ae49710d2.png
[image.png 66]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/44bb74ad86084b84a8be60634a70f7f8.png
[image.png 67]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/1c08a454da1c450891d894e2cc99f65c.png
[image.png 68]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/54735ae99c3348f49bc9ced0fe54b3ee.png
[image.png 69]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/7f32409169e14cec9bb1475bd11ddf2e.png
[image.png 70]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/da9ff8303cec4d15be285245e6834209.png
[image.png 71]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/7e6a53b191034be99fb5cb8ef95eaf89.png
[image.png 72]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/6bb829bf0ab8485ea804a006917c9559.png
[image.png 73]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/b710e0925d9443ffa0b84e0a1763b9a1.png
[image.png 74]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/9390e42ace8b41f2bc91ac1bfce452ee.png
[image.png 75]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/6a3e35324fde4acea5f29a539c2eca84.png
[image.png 76]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/2ed93bb9b398464a84b7506c8dc4c9bc.png
[image.png 77]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/365b8bed6291411cac4b77e72b70e2e8.png
[image.png 78]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/978dd78c139f480293def17c863a9ecb.png
[image.png 79]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/032226c5fe8a45cdbc6896ba70268cf4.png
[image.png 80]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/9950d221450642bdbd48d3681a5ee563.png
[image.png 81]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/fd5c7a3cd6cd4bc0a8141c9f9dffac97.png