聚合统一,SpringBoot实现全局响应和全局异常处理
目录
前言
全局响应
数据规范
状态码(错误码)
全局响应类
使用
优化
全局异常处理
为什么需要全局异常处理
业务异常类
全局捕获
使用
优化
总结
前言
在悦享校园1.0版本中的数据返回采用了以Map对象返回的方式,虽然较为便捷但也带来一些问题。一是在Controller中所有方法均需要实例化一个Map对象。二是当返回数据较多时使用put方式添加信息会容易出现遗漏的问题。在异常处理方面,虽然该版本中对所有异常通过继承RuntimeException的方式来进行封装,但业务异常较多时这一操作就显得冗余,且需要使用上述提到的Map对象包装异常信息。对于以上问题在2.0版本中通过结合SpringBoot来进行优雅的解决。
全局响应
数据规范
一般来讲我们提供给前端接口调用的返回值为如下的JSON格式,其包含结果状态,状态码,响应信息和响应数据。通常会使用@ResponseBody注解配合一个响应类来实现这一功能。但需要注意的是,当方法返回值为String类型时,@ResponseBody注解并不会将其转为JSON格式,需要手动进行转换。
{"success": true,"code": 0,"message": "操作成功","data": "Hello"
}
状态码(错误码)
通过第一步数据规范可知,当接口被调用后会返回对应信息,若调用成功时返回固定的状态码即可,但调用失败时则需要不同的状态码来标识。为解决这个问题这里使用枚举的方式来定义出现异常时的错误信息。(此处的枚举对象名称可以自定义)
块的错误。(此处的枚举对象名称可以自定义)
@AllArgsConstructor
@Getter
public enum ExceptionCodeEnum {// 操作成功EC0(0,"操作成功"),// 通用模块错误EC10000(10000,"系统内部错误"),EC10001(10001,"参数错误"),EC10002(10002,"资源不存在"),// 用户模块错误EC20000(20000,"用户名已被占用"),EC20001(20001,"用户不存在"),EC20002(20002,"用户名或密码错误"),// 其它模块..../*** 异常代码*/private Integer code;/*** 描述信息*/private String message;
}
全局响应类
此处创建一个泛型类来实现全局返回信息的格式统一,并且提供返回结果不同状态下的构造方法。
@Data
@Builder
@AllArgsConstructor
public class ResultDataVO<T> {/*** 调用结果状态*/private Boolean success;/*** 响应代码*/private Integer code;/*** 详细信息*/private String message;/*** 返回数据,数据为空则不返回*/@JsonInclude(JsonInclude.Include.NON_NULL)private T data;/*** 操作成功时返回的数据* @param result* @param <T>* @return*/public static <T> ResultDataVO<T> success(T result) {return ResultDataVO.<T>builder().success(true).code(ExceptionCodeEnum.EC0.getCode()).message(ExceptionCodeEnum.EC0.getMessage()).data(result).build();}/*** 操作失败* @param <T>* @param exceptionCodeEnum 错误类型枚举* @return*/public static <T> ResultDataVO<T> failure(ExceptionCodeEnum exceptionCodeEnum){return ResultDataVO.<T>builder().success(false).code(exceptionCodeEnum.getCode()).message(exceptionCodeEnum.getMessage()).data(null).build();}/*** 操作失败,返回信息* @param exceptionCodeEnum 错误信息列表* @param result 对应失败信息对象* @param <T>* @return*/public static <T> ResultDataVO<T> failure(ExceptionCodeEnum exceptionCodeEnum, T result){return ResultDataVO.<T>builder().success(false).code(exceptionCodeEnum.getCode()).message(exceptionCodeEnum.getMessage()).data(result).build();}
}
使用
通过以上操作已经实现了一个基础的全局数据响应处理,可以通过如下方式来使用。
@GetMapping("/{id}")public ResultDataVO getMsg(@RequestParam(required = false) String name,@Max(value = 10,message = "最大值不能超过10")@PathVariable(name = "id") int uid) {String result = "Hello,"+name+" id "+uid;return ResultDataVO.success(result);}

优化
虽然到这里我们已经基本实现了全局响应,但如果不想要在每个方法中调用ResultDataVO的success方法,可以通过如下方式解决。这里新建处理类实现了ResponseBodyAdvice接口,该接口包含三个方法,supports、beforeBodyWrite、handleEmptyBody。
supports用于指明方法是否需要对进入的方法进行后续包装处理,默认返回true,即对所有方法处理。
beforeBodyWrite用于在控制器方法返回结果后,但在响应体写入之前调用。可以在此方法中修改body对象,如包装、添加元数据等。在该方法中将使用ResultDataVO的success方法进行包装,由此将可以省去在Controller方法中重复调用success方法。
handleEmptyBody用于处理null值,由于ResultDataVO类中已经对null值进行了处理,因此无需重写该方法。
注意:即使在全异处理添加了@RestControllerAdvice注解后,仍需要在Controller类上添加@ResponseBody注解,或者直接使用@RestController注解。因为方法返回值经过invokeAndHandle处理后已经确定,若没有以上注解则默认会按照String类型进行路径映射查找视图,进而返回404错误,而@RestControllerAdvice的相关方法会在invokeAndHandle处理后再进行调用。
@RestControllerAdvice
@Slf4j
public class GlobalExceptionAdvice implements ResponseBodyAdvice<Object> {/*** json格式化操作*/@Resourceprivate ObjectMapper objectMapper;/*** 是否开启对所有方法的处理,可以在此方法中添加条件使其支持对特定方法的处理。*/@Overridepublic boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {return true;}/*** 用于在控制器方法返回结果后,但在响应体写入之前调用。可以此处对数据进行包装等操作*/@SneakyThrows@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {/*** 未被捕获的错误进行拦截*/if(body == null){log.error("未处理的异常信息,请检查错误日志");return ResultDataVO.failure(ExceptionCodeEnum.EC10000);}/*** 返回类型为String则需要手动序列化*/if (body instanceof String) {return objectMapper.writeValueAsString(ResultDataVO.success(body));}/*** 已被包装为全局VO对象直接返回*/if (body instanceof ResultDataVO) {return body;}/*** 判断是否为404,500等错误类型*/if (body instanceof LinkedHashMap) {LinkedHashMap<String, Object> httpErrorCode = (LinkedHashMap<String, Object>) body;Integer code = (Integer) httpErrorCode.get("status");String message = (String) httpErrorCode.get("error");return new ResultDataVO(false, code, message, null);}return ResultDataVO.success(body);}
}
全局异常处理
为什么需要全局异常处理
使用全局异常处理更加灵活和规范化, 所有错误信息会被封装后返回给前端,避免暴露业务细节。
业务异常类
由于代码在运行过程中会出现异常,通常我们会使用 try...catch 方式来捕获并处理,在此之后我们需要返回错误信息知调用者当前状况。由于我们处理的异常多为RuntimeException的子类,因此可以通过编写一个业务异常类来实现总的异常信息处理,与以往不同在这里并不会为所有的业务异常创建具体的异常类,将使用前文中的错误码来配合使用。
@Getter
public class BusinessException extends RuntimeException {/*** 错误对象枚举*/private ExceptionCodeEnum codeEnum;/*** 根据传入的异常枚举解析异常相关信息。* @param codeEnum*/public BusinessException(ExceptionCodeEnum codeEnum){this.codeEnum = codeEnum;}
}
全局捕获
由于已经定义了总的异常处理类,因此在使用时只需要通过抛出 BusinessException 对象即可。但我们需要在代码中写入大量的try-catch语句来捕获处理异常。并且对于错误信息的返回需要符合在全局响应中的数据规范,也就是说需要像全局响应一样统一调用ResultDataVO的failure方法。
在前文创建的GlobalExceptionAdvice类上有一个@RestControllerAdvice注解,该注解将使所有的异常都进入到此处被处理,同时也可以用于全局的数据绑定、格式化等。
既然所有的异常都进入该类处理,那么如何处理呢?这里使用@ExceptionHandler注解,使用它可以指定当前方法处理哪种类型的异常,示例代码如下。通过在方法体内调ResultDataVO的failure方法来完成返回数据格式的规范,这里仅列举了三个异常处理,可自行添加更多的异常类。
/*** 数据格式转换错误*/@ExceptionHandler(DataFormatException.class)@ResponseBodypublic ResultDataVO dataFormatExceptionHandler(DataFormatException e) {log.error("捕获数据格式转换错误异常", e);return ResultDataVO.failure(ExceptionCodeEnum.EC10001);}/*** 业务异常捕获** @param businessException* @return*/@ExceptionHandler(value = BusinessException.class)public ResultDataVO handleBusinessException(BusinessException businessException) {log.error("捕获业务异常", businessException);return ResultDataVO.failure(businessException.getCodeEnum());}/*** 系统级异常** @param throwable*/@ExceptionHandler(value = Throwable.class)public ResultDataVO handleThrowable(Throwable throwable) {log.error("捕获系统级异常", throwable);return ResultDataVO.failure(ExceptionCodeEnum.EC10000);}
使用
通过上述操作可以实现一定程度上对try-catch的消除,示例代码如下
/*** 统一异常处理* @return*/@GetMapping("/error")public ResultDataVO getError(){// try...catchint res = 1 / 0;return ResultDataVO.success(res);}

优化
虽然采用上述方式已经实现了对异常的统一拦截处理并返回,但若异常产生的源头并非Crontroller中出现而是在系统内部时则有可能导致返回结果出现问题,该问题已经在GlobalExceptionAdvice类的beforeBodyWrite方法中做了处理,当body对象为空时则仍然会调用ResultDataVO的failure方法。
// 用于处理未被正常捕获的异常if(body == null){log.error("未处理的异常信息,请检查错误日志");return ResultDataVO.failure(ExceptionCodeEnum.EC10000);}// ......
总结
通过使用@RestControllerAdvice和@ExceptionHandler注解和错误码以及对应处理/响应类即可实现全局异常的统一处理,其中GlobalExceptionAdvice类对全局响应和异常处理做了合并,可按照业务需求自行拆分。
相关文章:
聚合统一,SpringBoot实现全局响应和全局异常处理
目录 前言 全局响应 数据规范 状态码(错误码) 全局响应类 使用 优化 全局异常处理 为什么需要全局异常处理 业务异常类 全局捕获 使用 优化 总结 前言 在悦享校园1.0版本中的数据返回采用了以Map对象返回的方式,虽然较为便捷但也带来一些问题。一是在…...
【C/C++笔试练习】——数组名和数组名、switch循环语句、数据在计算机中的存储顺序、字符串中找出连续最长的数字串、数组中出现次数超过一半的数字
文章目录 C/C笔试练习1.数组名和&数组名(1)数组名和&数组名的差异(2)理解数组名和指针偏移(3)理解数组名代表的含义(4)理解数组名代表的含义 2.switch循环语句(6…...
力扣每日一题(+日常水题|树型dp)
740. 删除并获得点数 - 力扣(LeetCode) 简单分析一下: 每一个数字其实只有2个状态选 or 不 可得预处理每一个数初始状态(不选为0,选为所有x的个数 * x)累加即可 for(auto &x : nums)dp[x][1] x;每选一个树 i 删去 i 1 和 i - 1 故我们可以将 i…...
使用perming加速训练可预测的模型
监督学习模型的训练流程 perming是一个主要在支持CUDA加速的Windows操作系统上架构的机器学习算法,基于感知机模型来解决分布在欧式空间中线性不可分数据集的解决方案,是基于PyTorch中预定义的可调用函数,设计的一个面向大规模结构化数据集的…...
【数据库】存储引擎InnoDB、MyISAM、关系型数据库和非关系型数据库、如何执行一条SQL等重点知识汇总
目录 存储引擎InnoDB、MyISAM的适用场景 关系型和非关系型数据库的区别 MySQL如何执行一条SQL的 存储引擎InnoDB、MyISAM的适用场景 InnoDB 是 MySQL 默认的事务型存储引擎,只有在需要它不支持的特性时,才考虑使用其它存储引擎。实现了四个标准的隔…...
车道线分割检测
利用opencv,使用边缘检测、全局变化梯度阈值过滤、算子角度过滤、HLS阈值过滤的方法进行车道线分割检测,综合多种阈值过滤进行检测提高检测精度。 1.利用cv2.Sobel()计算图像梯度(边缘检测) import cv2 import numpy as np import matplotlib.pyplot a…...
树莓集团又一力作,打造天府蜂巢成都直播产业园样板工程
树莓集团再次推出惊艳之作,以打造成都天府蜂巢直播产业园为目标。该基地将充分展现成都直播产业园的巨大潜力与无限魅力,成为一个真正的产业园样板工程。 强强联手 打造未来 成都天府蜂巢直播产业园位于成都科学城兴隆湖高新技术服务产业园内࿰…...
ubuntu 软件包管理之二制作升级包
Deb 包(Debian 软件包)是一种用于在 Debian 及其衍生发行版(例如 Ubuntu)中分发和安装软件的标准包装格式。它们构成了 Debian Linux 发行版中的软件包管理系统的核心组成部分,旨在简化软件的分发、安装、更新和卸载流程。在本篇文章中,我们将深入探讨以下内容: Deb 包基…...
TCP/IP网络江湖——数据链路层的防御招式(数据链路层下篇:数据链路层的安全问题)
目录 引言 一、 数据链路层的隐私与保密 二、数据链路层的安全协议与加密...
ios项目安装hermes-engine太慢问题
问题说明 ios工程,在使用"pod install"安装依赖的时候,由于超时总是报错 $ pod install ... Installing hermes-engine (0.71.11)[!] Error installing hermes-engine [!] /usr/bin/curl -f -L -o /var/folders/4c/slcchpy55s53ysmz_1_q_gzw…...
构建个人云存储:本地电脑搭建SFTP服务器,开启公网访问,轻松共享与管理个人文件!
本地电脑搭建SFTP服务器,并实现公网访问 文章目录 本地电脑搭建SFTP服务器,并实现公网访问1. 搭建SFTP服务器1.1 下载 freesshd 服务器软件1.3 启动SFTP服务1.4 添加用户1.5 保存所有配置 2. 安装SFTP客户端FileZilla测试2.1 配置一个本地SFTP站点2.2 内…...
springboot 下载文件为excel数据,中文自定义单元格宽度
/**2 * Description:表格自适应宽度(中文支持)3 * Author: 4 * param sheet sheet5 * param columnLength 列数6 */7 private static void setSizeColumn(HSSFSheet sheet, int columnLength) {8 for (int columnNum 0; columnNum < …...
机器学习 面试/笔试题
1. 生成模型 VS 判别模型 生成模型: 由数据学得联合概率分布函数 P ( X , Y ) P(X,Y) P(X,Y),求出条件概率分布 P ( Y ∣ X ) P(Y|X) P(Y∣X)的预测模型。 朴素贝叶斯、隐马尔可夫模型、高斯混合模型、文档主题生成模型(LDA)、限制玻尔兹曼机…...
某企查ymg_ssr列表详情
js篇— 今天来看下某企查的列表详情–侵删 header发现这个参数 先断点一下 然后上一步 就到了这个地方 就开始扣一下这个js 三大段,先不解混淆了, 给a粘贴出来 ,去掉自执行 给结果稍微改一下 缺windows,开始补环境 直接上…...
使用YOLOv5的backbone网络识别图像天气 - P9
目录 环境步骤环境设置包引用声明一个全局的设备 数据准备收集数据集信息构建数据集在数据集中读取分类名称划分训练、测试数据集数据集划分批次 模型设计编写维持卷积前后图像大小不变的padding计算函数编写YOLOv5中使用的卷积模块编写YOLOv5中使用的Bottleneck模块编写YOLOv5…...
TikTok海外扩张:亚马逊的新对手崛起
随着社交媒体和电子商务的融合,TikTok正迅速崭露头角,成为亚马逊等传统电商巨头的潜在竞争对手。这一新兴平台的快速发展引发了广泛的关注,特别是在全球范围内。 在这篇文章中,我们将探讨TikTok海外扩张的战略,以及它…...
CSS详细基础(五)选择器的优先级
本节介绍选择器优先级,优先级决定了元素最终展示的样式~ 浏览器是通过判断CSS优先级,来决定到底哪些属性值是与元素最为相关的,从而作用到该元素上。CSS选择器的合理组成规则决定了优先级,我们也常常用选择器优先级来合理控制元素…...
LLM-TAP随笔——有监督微调【深度学习】【PyTorch】【LLM】
文章目录 5、 有监督微调5.1、提示学习&语境学习5.2、高效微调5.3、模型上下文窗口扩展5.4、指令数据构建5.5、开源指令数据集 5、 有监督微调 5.1、提示学习&语境学习 提示学习 完成预测的三个阶段:提示添加、答案搜索、答案映射 提示添加 “[X] 我感到…...
kafka伪集群部署,使用docker环境拷贝模式
线上启动容器的方式是复制容器的运行环境出来,然后进行运行脚本的形式 1:在home/kafka目录下创建如下目录 2:复制kafka1容器内的数据/bitnami/kafka/data,直接放在1992_data里面,同理,复制kafka2容器内的数据/bitnami/…...
工业交换机一般的价格是多少呢?
工业交换机是一种应用于工业领域的网络设备。它的性能和所有安全指标都比一般商业交换机更加稳定。所以,工业级交换机的价格相对于普通的交换机要稍稍昂贵一些。工业交换机一般的价格是多少呢?每个厂家的交换机价格是不是都一样呢? 首先&…...
【Axure高保真原型】引导弹窗
今天和大家中分享引导弹窗的原型模板,载入页面后,会显示引导弹窗,适用于引导用户使用页面,点击完成后,会显示下一个引导弹窗,直至最后一个引导弹窗完成后进入首页。具体效果可以点击下方视频观看或打开下方…...
golang循环变量捕获问题
在 Go 语言中,当在循环中启动协程(goroutine)时,如果在协程闭包中直接引用循环变量,可能会遇到一个常见的陷阱 - 循环变量捕获问题。让我详细解释一下: 问题背景 看这个代码片段: fo…...
2025年能源电力系统与流体力学国际会议 (EPSFD 2025)
2025年能源电力系统与流体力学国际会议(EPSFD 2025)将于本年度在美丽的杭州盛大召开。作为全球能源、电力系统以及流体力学领域的顶级盛会,EPSFD 2025旨在为来自世界各地的科学家、工程师和研究人员提供一个展示最新研究成果、分享实践经验及…...
FFmpeg 低延迟同屏方案
引言 在实时互动需求激增的当下,无论是在线教育中的师生同屏演示、远程办公的屏幕共享协作,还是游戏直播的画面实时传输,低延迟同屏已成为保障用户体验的核心指标。FFmpeg 作为一款功能强大的多媒体框架,凭借其灵活的编解码、数据…...
Swift 协议扩展精进之路:解决 CoreData 托管实体子类的类型不匹配问题(下)
概述 在 Swift 开发语言中,各位秃头小码农们可以充分利用语法本身所带来的便利去劈荆斩棘。我们还可以恣意利用泛型、协议关联类型和协议扩展来进一步简化和优化我们复杂的代码需求。 不过,在涉及到多个子类派生于基类进行多态模拟的场景下,…...
智能在线客服平台:数字化时代企业连接用户的 AI 中枢
随着互联网技术的飞速发展,消费者期望能够随时随地与企业进行交流。在线客服平台作为连接企业与客户的重要桥梁,不仅优化了客户体验,还提升了企业的服务效率和市场竞争力。本文将探讨在线客服平台的重要性、技术进展、实际应用,并…...
基于数字孪生的水厂可视化平台建设:架构与实践
分享大纲: 1、数字孪生水厂可视化平台建设背景 2、数字孪生水厂可视化平台建设架构 3、数字孪生水厂可视化平台建设成效 近几年,数字孪生水厂的建设开展的如火如荼。作为提升水厂管理效率、优化资源的调度手段,基于数字孪生的水厂可视化平台的…...
第25节 Node.js 断言测试
Node.js的assert模块主要用于编写程序的单元测试时使用,通过断言可以提早发现和排查出错误。 稳定性: 5 - 锁定 这个模块可用于应用的单元测试,通过 require(assert) 可以使用这个模块。 assert.fail(actual, expected, message, operator) 使用参数…...
MODBUS TCP转CANopen 技术赋能高效协同作业
在现代工业自动化领域,MODBUS TCP和CANopen两种通讯协议因其稳定性和高效性被广泛应用于各种设备和系统中。而随着科技的不断进步,这两种通讯协议也正在被逐步融合,形成了一种新型的通讯方式——开疆智能MODBUS TCP转CANopen网关KJ-TCPC-CANP…...
ETLCloud可能遇到的问题有哪些?常见坑位解析
数据集成平台ETLCloud,主要用于支持数据的抽取(Extract)、转换(Transform)和加载(Load)过程。提供了一个简洁直观的界面,以便用户可以在不同的数据源之间轻松地进行数据迁移和转换。…...
