Spring Boot 3.x Rest API统一异常处理最佳实践

上一篇:Spring Boot 3.x Rest API最佳实践之统一响应结构

在Spring MVC应用中,要对web表示层所抛出的异常进行捕获处理有多种方式,具体的可参考著名国外Spring技术实战网站baeldung上的相关话题。Spring Boot对Spring MVC应用中抛出的异常以及http错误的捕获处理流程做了统一的封装,最终以特定的json结构响应给前端,而我们要做的只是扩展它对json结果的包装方式,以我们想要的结构返回即可。

接下来的实践,我们将自定义异常、业务错误码以及错误响应结构三者融合起来,实现定制化的企业级统一异常处理方案。如果觉得对你有帮助,记得点赞收藏,关注小卷,后续更精彩!

在这里插入图片描述

文章目录

    • 定义和抛出自定义异常
    • 扩展DefaultErrorAttributes
    • Response中增加错误信息
    • 验证响应404错误
    • 响应自定义异常
    • 完善自定义异常和错误响应类字段
    • 记录错误响应日志
    • 总结

定义和抛出自定义异常

自定义一个异常,从RuntimeException继承,编译期无需处理。先考虑只用msg来构造。

package com.juan.demo.common.exception;public class BusinessException extends RuntimeException {public BusinessException(String msg) {super(msg);}}

在添加购物车的service方法中模拟抛出,启动服务,测试看响应结果。

...
public class CartServiceImpl implements CartService {@Overridepublic List<CartItemDTO> addCartItem(CartItemDTO addItemDTO) {// 模拟抛出异常if (addItemDTO.getProductId() == 2) {throw new BusinessException("该商品已经下架,无法添加到购物车");}...}
}

测试发现输出的错误结构,包含在数据域data中,且包含了太多我们不关心的信息。

在这里插入图片描述

由于篇幅限制,这里的trace项内容非常多,这里省略掉。data域中响应的内容其实是spring boot框架内部对错误统一处理的结果,只不过在我们之前实现统一响应处理的RestBodyAdvice中也一并进行了拦截处理。

扩展DefaultErrorAttributes

spring boot内部对各种异常和http错误进行了相关捕获和保存,在响应输出到目标控制器,也就是BasicErrorController前,在DefaultErrorAttributes进行了错误信息的获取和结构的封装处理,这里,我们可以通过继承DefaultErrorAttributes类,重写其getErrorAttributes方法,来改变要响应的错误结构。

package com.juan.demo.common.web.support;import ...@Slf4j
@Component
public class CustomErrorAttributes extends DefaultErrorAttributes {static final String ERR_RESP_KEY = "err_resp";@Overridepublic Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {log.info("开始收集和整理错误结构...");Response<?> errResp = buildErrResp(webRequest);return Map.of(ERR_RESP_KEY, errResp);}private Response<?> buildErrResp(WebRequest webRequest) {// 参考了父类中获取抛出的错误对象的代码Throwable error = getError(webRequest);if (error != null) {while (error instanceof ServletException && error.getCause() != null) {error = error.getCause();}}// todo 判断和处理错误类型Integer status = getAttribute(webRequest, RequestDispatcher.ERROR_STATUS_CODE);String msg = getAttribute(webRequest, RequestDispatcher.ERROR_MESSAGE);if (StringUtils.isEmpty(msg) && error != null) {msg = error.getMessage();}// todo 返回失败的Response对象log.info("msg = {}, status = {}", msg, status);return null;}@SuppressWarnings("unchecked")private <T> T getAttribute(RequestAttributes requestAttributes, String name) {return (T) requestAttributes.getAttribute(name, RequestAttributes.SCOPE_REQUEST);}
}

代码详解

这里我们扩展了一个CustomErrorAttributes类,并用@Component来修饰为一个sprin的bean组件,它从DefaultErrorAttributes继承,它们都实现了ErrorAttributes接口,当spring boot在启动的时候,发现用户有实现该接口的类并配置为一个组件时,就会用用户扩展的而非默认的实现。

这里,我们重写getErrorAttributes方法,并在其中调用了一个私有的构建错误响应对象的buildErrResp方法,在该方法中,我们参考了父类DefaultErrorAttributes中如何获取错误信息的相关代码,比如获取抛出来的错误对象error的逻辑代码就来自于父类,getError(webRequest)方法来自于父类,这里获取到的error对象可能是经过多层包装的,需要判断并循环调用getCause()以获得最原始的错误对象,getAttribute方法也是从父类移植过来的,用来从请求的作用域中获取提前设置好的http响应状态status和错误信息msg,如果msg无法从预设中获取到,并且错误对象不为空,则调用错误对象的getMessage()方法返回的信息作为错误信息。

最后,我们将基于http错误状态码和错误信息来构建一个Response对象,这部分待实现。

构建出来的错误响应对象errResp,需要放到作为返回结果的Map中,这里的key我们可以任意指定,这个Map对象最终会作为参数传递给我们先前实现的RestBodyAdvice类的beforeBodyWrite方法,以便我们可以拿到构建好的Response类型的错误响应对象进行响应,为此,这里我们将这个key抽取为一个包级别可访问的ERR_RESP_KEY静态成员变量。

Response中增加错误信息

这里的错误消息msg对于正确响应来说是空的,是不用参与json序列化的;代表http响应状态的枚举类型HttpStatus也不用参与序列化,因此用了@JsonIgnore注解来忽略;这里还提供了一个静态fail方法来进行错误响应对象的包装。

package com.juan.demo.common.dto;import ......
public class Response<T> {...@JsonInclude(JsonInclude.Include.NON_EMPTY)private String msg;...@JsonIgnoreprivate HttpStatus httpStatus;...private static final Integer STATUS_FAIL = 1;...public static Response<?> fail(String msg, Integer statusCode) {Response<?> errResp = new Response<>();errResp.setStatus(STATUS_FAIL);errResp.setMsg(msg);if (statusCode != null) {errResp.setHttpStatus(HttpStatus.valueOf(statusCode));}return errResp;}...}

然后,CustomErrorAttributes类的buildErrResp方法的返回值,这样包装:

private Response<?> buildErrResp(WebRequest webRequest) {...return Response.fail(msg, status);
}

RestBodyAdvice类的beforeBodyWrite方法中,对传入的Object类型的body参数进行判断,如果是我们之前包装好的包含err_resp的key的错误响应Map,则从中获取错误响应对象进行响应设置:

package com.juan.demo.common.web.support;import ...import static com.juan.demo.common.web.support.CustomErrorAttributes.ERR_RESP_KEY;...
public class RestBodyAdvice implements ResponseBodyAdvice<Object> {......public Object beforeBodyWrite(Object body, ...) {if (body instanceof Map && ((Map<?, ?>) body).containsKey(ERR_RESP_KEY)) {Response<?> errResp = (Response<?>) ((Map<?, ?>) body).get(ERR_RESP_KEY);if (errResp.getHttpStatus() != null) response.setStatusCode(errResp.getHttpStatus());return errResp;}// 正确响应处理代码省略...}
}

验证响应404错误

启动服务测试一个不存在的地址,看到预期的404错误信息:

在这里插入图片描述

响应自定义异常

为了可以响应自定义异常BusinessException抛出的操作信息,我们需要在CustomErrorAttributesbuildErrResp方法中判断异常类型并进行错误响应对象的包装:

private Response<?> buildErrResp(WebRequest webRequest) {// 获取错误对象的代码省略Throwable error = ...// 判断和处理错误类型if (error instanceof BusinessException) {BusinessException be = (BusinessException) error;return Response.fail(be);}...
}

Response类中再提供一个相应的fail重载方法:

public static Response<?> fail(BusinessException ex) {Response<?> errResp = new Response<>();errResp.setStatus(STATUS_FAIL);errResp.setMsg(ex.getMessage());errResp.setHttpStatus(HttpStatus.INTERNAL_SERVER_ERROR);return errResp;
}

重启服务,再次测试下添加购物车服务,响应的结果符合我们的预期。

在这里插入图片描述

完善自定义异常和错误响应类字段

相对于之前的版本,这里新引入了一个errCode的字段来保存要响应给前端的错误码信息。对于重载的构造和静态fail方法,因为扩展了字段,这里提供最全的重载方法,其他重载则调用合适的重载方法即可。另外接收BusinessException类型的fail方法,在完成转换时,需要在BusinessException中也扩展相应的字段。

package com.juan.demo.common.dto;import ......
public class Response<T> {...@JsonInclude(JsonInclude.Include.NON_EMPTY)private String errCode;...private Response(Integer status, String msg, String errCode, T data, HttpStatus httpStatus) {this.status = status;this.msg = msg;this.errCode = errCode;this.data = data;this.httpStatus = httpStatus;}private Response(Integer status, T data) {// 改成调用重载构造this(status, null, null, data, null);}...// 增加fail重载方法public static <T> Response<T> fail(String msg, String errCode, T data, HttpStatus httpStatus) {// 调用最全的构造return new Response<>(STATUS_FAIL, msg, errCode, data, httpStatus);}public static <T> Response<T> fail(String msg, String errCode, T data) {return fail(msg, errCode, data, null);}public static Response<?> fail(String msg, String errCode) {return fail(msg, errCode,null);}public static Response<?> fail(String msg) {return fail(msg,null, null);}public static Response<?> fail(BusinessException ex) {// todo 这里的后3个参数都要从异常对象ex中获取,暂时硬编码写死return fail(ex.getMessage(), null, null, HttpStatus.INTERNAL_SERVER_ERROR);}public static Response<?> fail(String msg, Integer statusCode) {Response<?> errResp = fail(msg);...}...}

Response完善后的字段:

  • status

    响应状态,0-成功,1-失败

  • errCode

    错误响应时携带的错误码,可为空,为空时不输出到json

  • msg

    响应的错误消息,正常响应时该字段为空,且不输出到json

  • data

    实际响应的数据,为空时不输出到json

  • httpStatus

    要设置给响应对象的http状态码枚举类型,不输出到json

注意,除了无参构造是public的,其他都是private的,这样只允许外部通过调用静态的okfail方法来构造实例

扩展BusinessException字段:

package com.juan.demo.common.exception;import ...@Getter    
public class BusinessException extends RuntimeException {private String errCode;@Nullableprivate Object data;private HttpStatus status = HttpStatus.INTERNAL_SERVER_ERROR;public BusinessException(String msg, String errCode, Object data, HttpStatus status) {super(msg);this.errCode = errCode;this.data = data;this.status = status;}public BusinessException(String msg, String errCode, Object data) {this(msg, errCode, data, null);}public BusinessException(String msg, String errCode) {this(msg, errCode, null);}public BusinessException(String msg, HttpStatus status) {this(msg);this.status = status;}...}

BusinessException类中完善字段:

  • errCode

    业务错误码,可在枚举类中维护。抛出异常时,可指定或者不指定

  • data

    抛出异常时携带的相关的数据信息,可以为空

  • status

    http的状态码,默认为500,可在抛出异常时,自己指定

增加重载的构造器,在构造器内部可以调用其他构造器完成已有属性的初始化。

不要忘了在类上加@Getter注解,来提供属性的getter方法。

最后,再调整下Response类中转换BusinessException对象的方法:

public static Response<?> fail(BusinessException ex) {return fail(ex.getMessage(), ex.getErrCode(), ex.getData(), ex.getStatus());
}

完成这些调整后,我们做一个测试,对CartController中的addCartItem方法,直接返回一个认证失败的异常:

package com.juan.demo.web.controller;import ......
public class CartController implements CartAPI {......public void addCartItem(CartItemDTO cartItemDTO) {throw new BusinessException("请先登录", HttpStatus.UNAUTHORIZED);// 注释掉后续代码...}
}

启动服务,测试添加购物车接口。

在这里插入图片描述

甚至,我们可以在抛出异常时指定业务错误码:

throw new BusinessException("请先登录", "555", null,  HttpStatus.UNAUTHORIZED);

测试输出:

在这里插入图片描述

记录错误响应日志

在响应体信息拦截的RestBodyAdvice类中加一个记录响应对象日志信息的私有方法:

@SneakyThrows
private Response<?> logResp(Response<?> resp) {log.info("============ 响应结果:{}", objectMapper.writeValueAsString(resp));return resp;
}

把传入的对象返回,调用这个包装方法的3处地方:

public Object beforeBodyWrite(...) {// 判断是错误响应的情况if (...) {Response<?> errResp = ......return logResp(errResp); // 第1处}...// 字符串响应的情况if (type == String.class) {...return objectMapper.writeValueAsString(logResp(Response.ok(body))); // 第2处}return logResp(Response.ok(body)); // 第3处
}

测试错误日志输出:

在这里插入图片描述

总结

通过一步步的实践,我们完成了基于spring boot对异常处理现有流程的扩展,后续我们还将在这个扩展基础上继续增加数据校验相关的异常信息组织方式。通过不断的完善,这种异常处理的基础架构我们可以封装成common-starter起始依赖,让小伙伴们在企业级项目中得到应用。大家加油!

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

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

相关文章

RNN循环网络层

文章目录 1、简介2、RNN 网络原理3、PyTorch RNN 层的使用3.1、RNN送入单个数据3.2、RNN层送入批量数据 4、RNN三个维度4.1、解释4.2、输入数据的组织4.3、示例4.4、为什么需要这种格式&#xff1f;4.5、小结 &#x1f343;作者介绍&#xff1a;双非本科大三网络工程专业在读&a…

苹果手机数据被抹除还能恢复吗?这两个方法强烈推荐

苹果手机数据被抹除还能恢复吗&#xff1f;我们在使用苹果手机时&#xff0c;有时由于误操作、系统故障或升级失败等原因&#xff0c;导致手机照片、备忘录、视频、联系人等数据被意外抹除。 面对这类情况&#xff0c;我们应该怎么办&#xff1f;下面牛小编给大家的分享2个方法…

记录使用FlinkSql进行实时工作流开发

使用FlinkSql进行实时工作流开发 引言Flink SQL实战常用的Connector1. MySQL-CDC 连接器配置2. Kafka 连接器配置3. JDBC 连接器配置4. RabbitMQ 连接器配置5. REST Lookup 连接器配置6. HDFS 连接器配置 FlinkSql数据类型1. 基本数据类型2. 字符串数据类型3. 日期和时间数据类…

论文解读,神经网络全梯度表示《Full-Gradient Representation for Neural Network Visualization》

导语 这篇论文介绍了一种新的工具&#xff0c;称为全梯度&#xff0c;用于解释神经网络的响应。这个全梯度的概念将神经网络的响应分解为两个部分&#xff1a;输入灵敏度和每个神经元的灵敏度分量。 输入灵敏度&#xff1a;输入灵敏度指的是对于神经网络输出的影响程度。它反…

Python试讲

Python试讲 导语Python简介Python及其特点如何使用Python Python与计算计算变量 导语 本次试讲内容如下&#xff1a;Python简介与使用&#xff0c;Python与基本运算 辅助教材为 《趣学Python编程》和《Python编程从入门到实践》 Python简介 Python是目前入门最简单最好学的…

NSSCTF练习记录:[SWPUCTF 2021 新生赛]jicao

题目&#xff1a; 这段PHP代码的意思是&#xff1a; 对index.php文件进行语法高亮显示&#xff0c;插入flag.php文件&#xff0c;变量id的值为POST传递的值&#xff0c;变量json的值为GET传递的json类型的值。当id值为wllmNB且json中含有键为“x”&#xff0c;值为“wllm”的时…

数据结构:栈与队列OJ题

目录 前言 一、用栈实现队列 二、用队列实现栈 三、括号匹配问题 前言 前面讲了栈和队列的基础知识&#xff0c;今天来巩固一下加深理解&#xff0c;这里说明一下&#xff0c;因为现在都是在用C语言写&#xff0c;这些OJ题里都要用到前面实现栈和队列的代码&#xff0c;每道题…

告别数据丢失烦恼,转转数据恢复和另外三款工具助你一臂之力!

不知道大伙儿有没有和我一样&#xff0c;到哪都喜欢拍照片和视频&#xff0c;加上办公上也是七七八八的各种格式的文件实在是多&#xff0c;所以电脑和手机等等设备上经常内存爆满需要清理&#xff0c;难免会出现不小心误删或者格式化、清空等等的情况&#xff0c;用过几款和转…

Journyx项目管理软件 soap_cgi.pyc XXE漏洞复现

0x01 产品简介 Journyx-Journyx成立于1996年,提供自托管项目管理解决方案ProjectXecute。主要功能包括资源跟踪、待办事项列表、任务分配以及与MS Project的集成。要运行ProjectXecute,需要Windows 2003或更高版本、IIS Web服务器和Intel处理器。也可以在Linux、Solaris、AI…

#子传父父传子props和emits #封装的table #vue3

#子传父&父传子props和emits #封装的table #vue3 父组件&#xff1a;emits defineEmits props 子组件&#xff1a; 子组件 <template><el-table v-bind"$attrs" ref"innerTableRef" v-loading"loading" border :data"tabl…

力扣刷题-轮转数组

&#x1f308;个人主页&#xff1a;羽晨同学 &#x1f4ab;个人格言:“成为自己未来的主人~” 首先&#xff0c;我们现在这里提供的是一种特别简单的思路&#xff0c;我们先来看一下这段代码&#xff1a; void rotate(int* nums, int numsSize, int k) {k%numsSize;int n…

git clone private repo

Create personal access token Clone repo $ git clone https://<user_name>:<personal_access_tokens>github.com/<user_name>/<repo_name>.git

5个适用于Linux系统的PDF转Word工具

凭借其跨平台和设备的统一标准、兼容性和规模小巧等主要优点&#xff0c;可携带文档格式&#xff08;PDF&#xff09;可谓最主流的文件格式之一。 市面上有许多查看PDF文件的强大工具&#xff0c;因此所有Linux系统的用户都可以根据自身喜好找到合适的PDF查看工具。然而&#x…

Linux从0到1——基础IO(上)【文件描述符/重定向/缓冲区】

Linux从0到1——基础IO&#xff08;上&#xff09; 1. 预备知识2. 复习一下常见的C语言文件接口3. 系统调用接口3.1 函数传参小技巧——标志位3.2 使用系统调用接口3.2.1 open3.2.2 write3.2.3 read 4. 文件描述符fd4.1 fd的本质4.2 理解struct file结构体4.3 fd的分配规则 5. …

BES(恒玄)平台log分析

前言 恒玄软件调试和分析基本是通过日志形式分析的&#xff0c;今天就详细说下日志组成和常用分析方法 1.日志组成解析 bes日志组成一般说由以下组成&#xff1a;tick时钟 模块log打印所在线程编码log内容 [17:31:22.834] 21786/NONE / 2 | CPU USAGE: busy18 light8…

WebStorm格式化JSON,将一行很长的JSON展开

webstorm json格式化插件将一行很长的json展开 在WebStorm中&#xff0c;要展开很长的JSON行&#xff0c;可以使用内置的JSON格式化功能。 打开WebStorm&#xff0c;并打开包含JSON的文件。 选择JSON文件中的任意部分。 按下快捷键 CtrlAltL (Windows/Linux) 或 CmdAltL (Ma…

GPT-4.o mini

https://share.xuzhugpt.cloud/ GPT-4.o mini 目前免费使用 把上面[chatgpt4o-mini-xuzhu]复制到UserToken的文本框中 点击[个人账户] 测试一下哈&#xff0c;看看&#xff1a; GPT-4.o代码有时候还是有严重错误&#xff1a;好奇怎么来的 上面是我写得&#xff0c;下面是GPT写…

01背包问题 c++

题目描述 有一个背包能装的重量maxw(正整数&#xff0c;0≤maxw≤20000)&#xff0c;同时有n件物品(0≤n≤100)(每件物品只有一件&#xff0c;要么拿&#xff0c;要么不拿)&#xff0c;每件物品有一个重量wi(正整数)和一个价值vi(正整数)。要求从这n件物品中任取若干件装入背包…

C++ 简单学习

C简单编译 auto关键字 auto 关键字用于自动类型推导。它允许编译器自动推断变量的类型&#xff0c;使得代码更加简洁和易于编写&#xff0c;尤其是在处理复杂类型或模板编程时。使用 auto 可以避免编写冗长的类型声明&#xff0c;同时减少由于类型不匹配导致的编译错误 auto x…

论文阅读报告: 在时间双向图上查询基于时间的的密集子图 | ICDE 2024

摘要 本文提出了一个新的模型&#xff08;α, β, T&#xff09;-core&#xff0c;用于在时间双向图上寻找凝聚子图。时间双向图中&#xff0c;不同实体之间的关系随着时间的推移而变化。为了提高查询效率&#xff0c;本文提出了顶点分区和时间分区的历史索引&#xff08;VH-I…