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

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 进阶专栏

Java 语言能走到现在 , 仍然屹立不衰的原因 , 有一部分就是因为 SSM 框架的存在

接下来 , 博主会带大家了解一下 Spring、Spring Boot、Spring MVC、MyBatis 相关知识点

并且带领大家进行环境的配置 , 让大家真正用好框架、学懂框架

来上一篇文章复习一下吧
点击即可跳转到前置文章
CSDN 平台观感有限 , 可以私聊作者获取源笔记链接
在这里插入图片描述

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

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

我们新创建一个项目来完成这三项功能
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png

一 . 统一功能的处理

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

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

1.4 超高级阶段 : Spring 拦截器

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

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

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

准备工作

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

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
千万千万不要选错 , 咱们这个是 Spring Boot 项目 , 当然要去找 Spring 提供的方法
使用他的 hasLength() 方法就可以判定是不是空以及是不是空字符串
image.png
image.png
然后继续完善我们的登录功能

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 -> 返回 falseif(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 -> 返回 falseif(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 -> 返回 falseif(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
自定义拦截器的步骤 : 创建自定义拦截器 , 实现 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 {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// 登录判断的业务// false : 有 session 直接得到 session , 没有 session 就不需要再创建 session 了// 如果用在登录判断的业务上,一定要用 sessionHttpSession session = request.getSession(false);if(session != null && session.getAttribute("userinfo") != null) {return true;}// 非必须:可以设置状态码response.setStatus(401);//401代表没有权限// 也可以实现页面跳转// response.sendRedirect("xxx.html");// 默认不执行返回 falsereturn false;}
}

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

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

  1. 创建一个类 , 实现 WebMvcConfigurer

image.png
image.png

  1. 重写 addInterceptors 方法

image.png

  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 方法@Overridepublic void addInterceptors(InterceptorRegistry registry) {}
}
  1. 把自定义拦截器加载到拦截规则中 , 使用 registry
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 方法@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(new LoginInterceptor());}
}

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

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 {@Autowiredprivate LoginInterceptor loginInterceptor;// 2. 重写 addInterceptors 方法@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(loginInterceptor);}
}

这样写完之后 , 我们的拦截器就生效了 , 但是规则还未制指定 , 制定规则使用 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 {@Autowiredprivate LoginInterceptor loginInterceptor;// 2. 重写 addInterceptors 方法@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(loginInterceptor).addPathPatterns("/**") // 拦截所有请求.excludePathPatterns("/user/login")  // 排除不拦截的 URL.excludePathPatterns("/*.js") // 还可以使用表达式,拦截所有的js.excludePathPatterns("/user/reg");}
}

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

但是离谱的是 : 我们再访问 reg 方法 , 他仍然被拦截了
image.png
打开 reg 页面的开发者工具看一看是咋回事
image.png
那么这个 favicon.ico 是什么 , 他为什么会被拦截 ?
比如我们访问百度页面
image.png
圈出来的部分就是一个小的百度图标 , 其实这就是我们的 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 {@Autowiredprivate LoginInterceptor loginInterceptor;// 2. 重写 addInterceptors 方法@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(loginInterceptor).addPathPatterns("/**") // 拦截所有请求.excludePathPatterns("/user/login")  // 排除不拦截的 URL.excludePathPatterns("/favicon.ico") // 排除状态栏标签小图标;.excludePathPatterns("/user/reg");}
}

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

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

拦截器实现原理

正常情况
image.png
拦截器
image.png
从最开始的直接进入控制器层 , 到现在多了一层校验才能进入控制器层 , Spring AOP 帮我们实现了校验拦截的功能
所有的 Controller 执行都会通过⼀个调度器 DispatcherServlet 来实现 , 可以从 Spring Boot 控制台的打印信息看出
我们访问 controller 底下的 login 方法
image.png
就可以在 Spring Boot 的控制台下面 , 发现 DispatcherServlet 的身影
image.png
从源码角度来分析
双击 shift 搜索 DispatchServlet
image.png
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
image.png
通过上面的源码分析 , 我们可以看出 , Spring 中的拦截器也是通过动态代理和环绕通知的思想实现的 , 大体的调用流程如下 :
image.png

扩展 : 统一访问前缀添加

在 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 {@Autowiredprivate LoginInterceptor loginInterceptor;// 2. 重写 addInterceptors 方法@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(loginInterceptor).addPathPatterns("/**") // 拦截所有请求.excludePathPatterns("/user/login")  // 排除不拦截的 URL.excludePathPatterns("/favicon.ico") // 排除状态栏标签小图标;.excludePathPatterns("/user/reg");}@Overridepublic void configurePathMatch(PathMatchConfigurer configurer) {configurer.addPathPrefix("api",c -> true);}
}

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

想要成功访问 , 还要修改一下拦截路径
image.png

二 . 统一异常的处理

我们在 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 -> 返回 falseif(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
后端这里就报错了
image.png
那前端就蒙了 , 我还在这等着你呢 , 你这头自己就偷摸报错了
那我们就需要通过 Spring AOP 统一异常的处理 , 来加强程序的鲁棒性

2.1 统一异常的处理的实现

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

  1. 新建一个类 , 加上 @ControllerAdvice 注解
package com.example.demo.config;/*** 统一处理异常*/import org.springframework.web.bind.annotation.ControllerAdvice;@ControllerAdvice 
public class ErrorAdvice {
}
  1. 编写具体的方法 , 在方法上面加上注解 : @ExceptionHandler(Exception.class)
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() {HashMap<String, Object> result = new HashMap<>();return result;}
}
  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");// 出现异常,状态码改成-1result.put("msg",e.getMessage());// 把报错信息添加进去,需要在方法参数加上Exception ereturn result;}
}

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

2.2 细化异常

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

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");// 出现异常,状态码改成-1result.put("msg",e.getMessage());// 把报错信息添加进去,需要在方法参数加上Exception ereturn result;}@ExceptionHandler(ArithmeticException.class)@ResponseBodypublic HashMap<String, Object> arithmeticAdvice(ArithmeticException e) {HashMap<String, Object> result = new HashMap<>();result.put("code",-2);result.put("msg",e.getMessage());return result;}
}

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

三 . 统一数据返回格式

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

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

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

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

我们可以实现一下
image.png
image.png

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 {@Overridepublic boolean supports(MethodParameter returnType, Class converterType) {// 固定返回 true,这样才能调用下面的方法return true;}@Overridepublic 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
现在就变成了 JSON 数据
image.png
image.png
image.png
但是统一数据返回格式的方法过于霸道 , 他把所有的对象都进行封装
比如我们的 getinfo 以及 reg , 已经报错了 , 然后统一异常处理就给他们封装成一个 HashMap 了
image.png
但是统一数据返回格式又把这个已经封装好的对象又抓过来了 , 进行再次封装 , 所以就会像图片里那样 , data 里面又包含了 code 以及 msg

3.3 @ControllerAdvice 源码分析

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

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

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/60287.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

leetcode 2483. Minimum Penalty for a Shop（商店的最少代价）

leetcode 2483. Minimum Penalty for a Shop（商店的最少代价）

字符串customers只包含’Y’和’N’两种字母, 表示 i 时刻商店是否有客人来。 如果商店在 i 时刻处于开门状态&#xff0c;Y’的代价是0&#xff0c;N’的代价是1.&#xff08;开门了却没有客人就算损失&#xff09;。 反之&#xff0c;在 i 时刻处于关门状态&#xff0c;N’的…
阅读更多...
AssemblyManager 程序集管理器

AssemblyManager 程序集管理器

AssemblyManager 程序集管理器 程序执行中使用反射对框架的搭建有着强大的影响&#xff0c;如何管理程序集方便使用反射获取类型操作对象是本文章的重点 1.AssemblyInfo 对于一个程序集这里使用一个AssemblyInfo对象进行管理 Assembly &#xff1a;对应的程序集AssemblyTyp…
阅读更多...
QT（8.30）常用类与组件,实现登录界面

QT（8.30）常用类与组件,实现登录界面

1.作业&#xff1a; 完成一个登录界面(图片未附带): 头文件: #ifndef WIDGET_H #define WIDGET_H#include <QWidget>#include <QLineEdit>//行编辑器#include<QIcon>//图标#include<QLabel>//标签#include<QPushButton>//按钮#include<QIc…
阅读更多...
如何在Spring Boot应用中使用Nacos实现动态更新数据源

如何在Spring Boot应用中使用Nacos实现动态更新数据源

&#x1f337;&#x1f341; 博主猫头虎 带您 Go to New World.✨&#x1f341; &#x1f984; 博客首页——猫头虎的博客&#x1f390; &#x1f433;《面试题大全专栏》 文章图文并茂&#x1f995;生动形象&#x1f996;简单易学&#xff01;欢迎大家来踩踩~&#x1f33a; &a…
阅读更多...
Prometheus监控（三）架构

Prometheus监控（三）架构

文章目录 Prometheus架构图Prometheus生态圈组件Prometheus Serverclient librariesPushgatewayexporterAlartmanager Prometheus架构理解存储计算层采集层应用层 Prometheus架构图 Prometheus生态圈组件 Prometheus Server 主服务器&#xff0c;负责收集和存储时间序列数据 …
阅读更多...
发布自己的npm包

发布自己的npm包

1.初始化npm包 npm init 输入npm init后&#xff0c;一路默认即可初始化成功&#xff0c;如下&#xff1a; 初始化成功后会生成一个package.json文件 n&#xff08;以我的文件夹demo-npm-dir为例&#xff09; package.json配置如下&#xff1a; {"name": "n…
阅读更多...
容器技术,1. Docker,2. Kubernetes（K8s）：

容器技术,1. Docker,2. Kubernetes（K8s）：

目录 容器技术 1. Docker&#xff1a; 2. Kubernetes&#xff08;K8s&#xff09;&#xff1a; Docker和Kubernetes 容器的主要应用场景有哪些&#xff1f; 容器技术 有效的将单个操作系统的资源划分到孤立的组中&#xff0c;以便更好的在孤立的组之间平衡有冲突的资源使…
阅读更多...
对于论文Semi-Supervised Classification with Graph Convolutional Networks，小白的学习理解

对于论文Semi-Supervised Classification with Graph Convolutional Networks，小白的学习理解

参考笔记&#xff1a;论文笔记&#xff1a;Semi-Supervised Classification with Graph Convolutional Networks_hongbin_xu的博客-CSDN博客 论文笔记&#xff1a;SEMI-SUPERVISED CLASSIFICATION WITH GRAPH CONVOLUTIONAL NETWORKS_semi supervised classification_饮冰l的博…
阅读更多...
IO模型：阻塞和非阻塞

IO模型：阻塞和非阻塞

一、五种IO模型------读写外设数据的方式 阻塞: 不能操作就睡觉 非阻塞&#xff1a;不能操作就返回错误 多路复用&#xff1a;委托中介监控 信号驱动&#xff1a;让内核如果能操作时发信号&#xff0c;在信号处理函数中操作 异步IO&#xff1a;向内核注册操作请求&…
阅读更多...
【微服务部署】08-监控与告警

【微服务部署】08-监控与告警

文章目录 1. PrometheusOperator1.1 优势1.2 配置脚本1.3 部署脚本 2. Granfana实现监控看板2.1 Granfana核心特性2.2 部署文件 目前Kubernetes中最流行的监控解决方案是使用Prometheus和AlertManager 1. PrometheusOperator 1.1 优势 自动化安装将配置资源化灵活的扩展能力 …
阅读更多...
ctfshow—萌新—杂项1

ctfshow—萌新—杂项1

0x00 前言 CTF 加解密合集CTF Web合集 0x01 题目 0x02 Write Up ed400fbcff269bd9c65292a97488168a 首先这是一个md5&#xff0c;然后在线解密一下&#xff0c;解密站点 https://www.somd5.com/ 解密出来的内容是helloctf 然后去掉ctf就是最终的答案 结果就是flag{hello}…
阅读更多...
023 - STM32学习笔记 - 扩展外部SDRAM（二） - 扩展外部SDRAM实验

023 - STM32学习笔记 - 扩展外部SDRAM（二） - 扩展外部SDRAM实验

023- STM32学习笔记 - 扩展外部SDRAM&#xff08;一&#xff09; - 扩展外部SDRAM实验 本节内容中要配置的引脚很多&#xff0c;如果你用的开发板跟我的不一样&#xff0c;请详细参照STM32规格书中说明对相关GPIO引脚进行配置。 先提前对本届内容的变成步骤进行总结如下&…
阅读更多...
supervisorctl（-jar）启动配置设置NACOS不同命名空间

supervisorctl（-jar）启动配置设置NACOS不同命名空间

背景 由于需要在上海服务器上面配置B测试环境&#xff0c;原本上面已有A测试环境&#xff0c;固需要将两套权限系统分开 可以使用不同的命名空间来隔离启动服务 注&#xff1a;本文章均不涉及公司机密 1、新建命名空间 命名空间默认会有一个public&#xff0c;并且不能删除&a…
阅读更多...
【QT】信号和槽（15）

【QT】信号和槽（15）

前面的内容说了很多不同的控件如何使用&#xff0c;今天来看下QT的核心&#xff0c;信号与槽&#xff08;Signals and slots&#xff09;&#xff01; 简单理解一下&#xff0c;就是我们的信号与槽连接上了之后&#xff0c;发射一个信号给到槽&#xff0c;槽函数接收到了这个信…
阅读更多...
数据库(一) 基础知识

数据库(一) 基础知识

概述 数据库是按照数据结构来组织,存储和管理数据的仓库 数据模型 数据库系统的核心和基础是数据模型&#xff0c;数据模型是严格定义的一组概念的集合。因此数据模型一般由数据结构、数据操作和完整性约束三部分组成。数据模型主要分为三种:层次模型&#xff0c;网状模型和关…
阅读更多...
docker linux（centos 7） 安装

docker linux（centos 7） 安装

这是个目录 1:安装1:手动安装(适用于centos7)之一2:手动安装(适用于centos7)之二3&#xff1a;一键安装docker4:二进制安装1&#xff1a;下载二进制包2&#xff1a;解压3&#xff1a;移动文件4&#xff1a;后台运行docker5&#xff1a;测试 dicker命令表999&#xff1a;遇到的问…
阅读更多...
java解析html

java解析html

目录 场景描述一.引入依赖二.调用接口响应回来的html三.测试代码 场景描述 我调用外部接口&#xff0c;但是返回来的数据是html的格式&#xff0c;所以我就需要进行处理来获得我想要的数据。我使用的是jsoup。 一.引入依赖 <dependency><groupId>org.jsoup</gr…
阅读更多...
Go 使用 Gorm 将操作信息集成到链路跟踪 Jaeger，进行增删改查使用举例，并做可视化UI界面展示（附源码）

Go 使用 Gorm 将操作信息集成到链路跟踪 Jaeger，进行增删改查使用举例，并做可视化UI界面展示（附源码）

Go 使用 Gorm 将操作信息集成到链路跟踪 Jaeger，进行增删改查使用举例（附源码）。 为了增强程序的可观测性，方便问题定位，在发起数据库操作请求时我们也可以调用代码统一集成链路跟踪的能力，Jaeger 是当今比较流行的选择。使用 Gorm 来将操作信息集成到 Jaeger 中。 全面…
阅读更多...
C++笔记之临时变量与临时对象与匿名对象

C++笔记之临时变量与临时对象与匿名对象

C笔记之临时变量与临时对象与匿名对象 code review! 文章目录 C笔记之临时变量与临时对象与匿名对象1.C中的临时变量指的是什么&#xff1f;2.C中的临时对象指的是什么&#xff1f;3.C中临时对象的作用是什么&#xff1f;什么时候要用到临时对象?4.给我列举具体的例子说明临…
阅读更多...
回归预测 | MATLAB实现CSO-ELM布谷鸟算法优化极限学习机多输入单输出回归预测（多指标，多图）

回归预测 | MATLAB实现CSO-ELM布谷鸟算法优化极限学习机多输入单输出回归预测（多指标，多图）

回归预测 | MATLAB实现CSO-ELM布谷鸟算法优化极限学习机多输入单输出回归预测&#xff08;多指标&#xff0c;多图&#xff09; 目录 回归预测 | MATLAB实现CSO-ELM布谷鸟算法优化极限学习机多输入单输出回归预测&#xff08;多指标&#xff0c;多图&#xff09;效果一览基本介…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023