《框架封装 · 统一异常处理和返回值包装》

📢 大家好，我是 【战神刘玉栋】，有10多年的研发经验，致力于前后端技术栈的知识沉淀和传播。 💗
🌻 CSDN入驻不久，希望大家多多支持，后续会继续提升文章质量，绝不滥竽充数，如需交流，欢迎留言评论。👍

文章目录

    • 写在前面的话
    • @RestControllerAdvice 实现异常处理
      • 基础使用
      • 注解简介
      • 实战分析
    • ResponseBodyAdvice 实现返回值包装
      • 技术说明
      • 实战分析
      • 其他方式
    • 总结陈词

写在前面的话

此篇博文继续介绍框架封装过程中，关于统一异常处理和返回值包装的具体方案，这本是一个相对常见的需求场景，此处结合实战情况说明，各位看官可一睹为快。

技术栈：后端 SpringCloud + 前端 Vue/Nuxt

@RestControllerAdvice 实现异常处理

基础使用

由于场景较简单，也不构思了，可以直接实现，再来考虑内容。
由于是 SpringBoot 项目，直接使用注解@RestControllerAdvice的方式实现全局异常处理类。
先上一段示例代码：

@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {@ExceptionHandler(value = Throwable.class)public ResultModel jsonErrorHandler(HttpServletRequest req, Throwable e) throws Exception {log.error("请求发生异常，URL：{}，HTTP_METHOD：{}，IP：{}，错误信息：{}", req.getRequestURL().toString(),req.getMethod(), req.getRemoteAddr(), e.getMessage());ResultModel resultModel;//异常结果处理步骤return resultModel;}
}

注解简介

@RestControllerAdvice是一个组合注解，由@ControllerAdvice、@ResponseBody组成，而@ControllerAdvice继承了@Component，因此@RestControllerAdvice本质上是个Component，用于定义@ExceptionHandler，@InitBinder和@ModelAttribute方法，适用于所有使用@RequestMapping方法。
@RestControllerAdvice注解将作用在所有注解了@RequestMapping的控制器的方法上，该注解有一些属性，可以设定具体的范围。

Tips：上文提到的一些注解的基础用法，网上资料很多，这边不展开。

实战分析

接下来谈谈博主所在企业是如何实现这一异常处理器的，它到底可以做，或者应该做哪些事情？
Step1、从上下文获取链路ID，设置到响应头，并设置响应状态，代码如下。

@ExceptionHandler(Exception.class)
public Object exceptionHandler(Exception ex) {IResult<?> result;try {String traceId = OnelinkContextHolder.getString(OnelinkConstant.TRACE_ID);// 响应头增加链路IDthis.response.setHeader(OnelinkConstant.TRACE_ID, StrUtil.nullToEmpty(traceId));// 先默认设置HTTP状态码为500,然后根据具体异常处理再调整对应的状态码this.response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);// 统一分发并处理异常result = this.handleException(ex);} catch (Exception e) {log.error("全局异常处理发生错误", e);result = ResultVO.failure(ex.getMessage(), ExceptionUtil.stacktraceToString(e));}// 是否开启异常处理指南if (!this.onelinkExceptionGuideProviders.isEmpty()) {this.appendExGuide(ex, result);}return result;
}

Step2、针对框架自定义的异常拦截器接口进行遍历，先执行前置接口，再执行后置接口，这个思想贯穿整个框架搭建过程，预留给各小组的业务开发人员，更多扩展空间（那什么，遵循开闭原则，对修改关闭，对扩展开放）。

// 异常拦截器
if (this.interceptors != null) {for (WebExceptionInterceptor interceptor : this.interceptors) {ex = interceptor.beforeHandle(ex);}
}public interface WebExceptionInterceptor {/*** 全局异常处理前逻辑*/default Exception beforeHandle(Exception ex) {return ex;}/*** 全局异常处理后逻辑*/default Exception afterHandle(Exception ex, ResultVO<Object> resultVO) {return ex;}}

3、最后就是本职工作了，针对异常的不同类型，进行不同的组装，比如ORA-开头的异常做出翻译处理等，还有一些异常日志记录、是否异常指引等功能，这里不展开了。

ResponseBodyAdvice 实现返回值包装

技术说明

0、ResponseBodyAdvice 是 Spring Framework 的 Web 模块中的一个接口，它允许你在将响应体写入 HTTP 响应之前拦截和修改它。它提供了一种全局定制响应处理逻辑的方式，适用于 Spring MVC 或 Spring WebFlux 应用程序。
1、ResponseBodyAdvice 可以在注解 @ResponseBody 将返回值处理成相应格式之前操作返回值，实现这个接口即可完成相应操作，可用于对response 数据的一些统一封装或者加密等操作。
2、ResponseBodyAdvice 接口和 RequestBodyAdvice 接口类似，RequestBodyAdvice 是请求到Controller 之前拦截，做相应的处理操作，而ResponseBodyAdvice 是对Controller返回的{@code @ResponseBody}or a {@code ResponseEntity} 后，{@code HttpMessageConverter} 类型转换之前拦截，进行相应的处理操作后，再将结果返回给客户端。
3、实现 ResponseBodyAdvice 接口，需要重写其 supports 和 beforeBodyWrite 方法。
1）supports方法：判断是否要执行beforeBodyWrite方法，true为执行，false不执行。通过该方法可以选择哪些类或那些方法的response要进行处理，其他的不进行处理。
2）beforeBodyWrite方法：对response方法进行具体操作处理。

public interface ResponseBodyAdvice<T> {/*** 1、选择是否执行 beforeBodyWrite 方法，返回 true 执行，false 不执行* 2、通过 supports 方法，可以选择对哪些类或方法的 Response 进行处理* @param returnType：返回类型* @param converterType：转换器* @return ：返回 true 则下面的 beforeBodyWrite  执行，否则不执行*/boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);/*** 对 Response 处理的具体执行方法* @param body：响应对象(response)中的响应体* @param returnType：控制器方法的返回类型* @param selectedContentType：通过内容协商选择的内容类型* @param selectedConverterType：选择写入响应的转换器类型* @param request：当前请求* @param response：当前响应* @return ：返回传入的主体或修改过的(可能是新的)主体*/@NullableT beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response);
}

@ControllerAdvice
public class CustomResponseBodyAdvice implements ResponseBodyAdvice<Object> {@Overridepublic boolean supports(MethodParameter returnType, Class converterType) {// 根据返回类型和转换器类型检查是否应用此建议// 你可以在这里放置任何条件return true;}@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType,MediaType selectedContentType,Class selectedConverterType, ServerHttpRequest request,ServerHttpResponse response) {// 在将响应体写入输出流之前修改它// 你可以在这里检查或修改 'body' 对象return body;}
}

总结：ResponseBodyAdvice 接口允许在执行 @ResponseBody 或 ResponseEntity 控制器方法之后，但在使用 HttpMessageConverter 写入响应体之前自定义响应，进行功能增强。通常用于加密，签名，统一数据格式等。
注意：要使其生效参考框架代码，关键点是@RestControllerAdvice。

实战分析

可以用于针对返回数据进行处理，要特别注意如下点：

  • 异常结果的处理
  • Feign调用结果的处理
  • 普通数据的处理
  • 其他数据的处理

核心思路就是设置一个返回值类，根据返回数据的类型是否为该类进行判断处理。

public Object beforeBodyWrite(Object responseBody,@NonNull MethodParameter methodParameter,@NonNull MediaType mediaType,@NonNull Class<? extends HttpMessageConverter<?>> clazz,@NonNull ServerHttpRequest serverHttpRequest,@NonNull ServerHttpResponse serverHttpResponse) {HttpHeaders reqHeaders = serverHttpRequest.getHeaders();String disableWrapperFlag = reqHeaders.getFirst(ResultWrapper.DISABLE_WRAPPER_HEADER_KEY);String rpcClient = reqHeaders.getFirst(RpcConstant.RPC_CLIENT_HEADER_NAME);if (this.couldSkip(mediaType, disableWrapperFlag, rpcClient)) {return responseBody;}Type type = methodParameter.getExecutable().getAnnotatedReturnType().getType();String traceId = this.traceIdProvider == null ? null : this.traceIdProvider.getTraceId();Object result;// 远程调用直接返回if (responseBody instanceof ApiResult<?>) {result = responseBody;// 为返回结果设置链路ID} else if (responseBody instanceof IResult) {ResultVO<?> resultVO = (ResultVO<?>) responseBody;result = StrUtil.isBlank(resultVO.getTraceId()) ? resultVO.setTraceId(traceId) : resultVO;this.setResultEnv(resultVO);// 如果返回结果是字符串,不能直接返回ResultVO,否则会与StringHttpMessageConverter冲突} else if (responseBody instanceof String || type == String.class) {ResultVO<?> resultVO = ResultVO.success(responseBody).setTraceId(traceId);result = JSON.toJSONString(resultVO, SerializerFeature.WriteMapNullValue);serverHttpResponse.getHeaders().add("content-type", ContentType.JSON.toString());// 没有被IResult包装,默认使用ResultVO进行包装} else {ResultVO<Object> resultVO = ResultVO.success(responseBody).setTraceId(traceId);this.setResultEnv(resultVO);result = resultVO;}return result;
}

还可以用于链路追踪返回数据Span的数据二次处理，比如返回值长度截取等，具体不展开了。

String responseTempStr = JSONObject.toJSONString(responseBody);
String truncatedResult = responseTempStr.length() > 2000 ? responseTempStr.substring(0, 2000) + "..." : responseTempStr;
span.tag(TraceSpanConstant.HTTP_RESPONSE, truncatedResult);

其他方式

如果您的项目需要针对返回值做了一些自定义扩展或处理，除了可以使用ResponseBodyAdvice，还可以考虑一下下面两个关键词：MessageConverters、 HandlerMethodReturnValueHandler，这里篇幅受限就不展开了。

总结陈词

上文介绍了框架封装人员，针对框架的统一异常和返回值包装的处理过程，仅供参考。
本系列博文后续继续更新，介绍框架搭建人员如何以恰当的方式应对各式各样的情况，这也是此专栏的主题。
后续将持续更新，请多多支持！

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

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

相关文章

贪心算法-以高校科研管理系统为例

贪心算法-以高校科研管理系统为例

1.贪心算法介绍 1.算法思路 贪心算法的基本思路是从问题的某一个初始解出发一步一步地进行&#xff0c;根据某个优化测度&#xff0c;每一 步都要确保能获得局部最优解。每一步只考虑一 个数据&#xff0c;其选取应该满足局部优化的条件。若下 一个数据和部分最优解连在一起…
阅读更多...
JavaEE初阶-网络原理1

JavaEE初阶-网络原理1

文章目录 前言一、UDP报头二、UDP校验和2.1 CRC2.2 md5 前言 学习一个网络协议&#xff0c;最主要就是学习的报文格式&#xff0c;对于UDP来说&#xff0c;应用层数据到达UDP之后&#xff0c;会给应用层数据报前面加上UDP报头。 UDP数据报UDP包头载荷 一、UDP报头 如上图UDP的…
阅读更多...
Kubernetes(K8s) kubectl 常用命令

Kubernetes(K8s) kubectl 常用命令

文章目录 一、常用命令1.1 kubectl describe 命令 二、kubectl 命令中的简写三、Helm3.1 常用命令&#xff1a;3.2 遇到的问题3.2.1 cannot re-use a name that is still in use 四、Containerd 一、常用命令 检查 k8s 各节点状态&#xff0c;确保k8s集群各节点状态正常&#x…
阅读更多...
概率基础——矩阵正态分布matrix normal distribution

概率基础——矩阵正态分布matrix normal distribution

矩阵正态分布-matrix normal distribution 定义性质应用 最近碰到了这个概念&#xff0c;记录一下 矩阵正态分布是一种推广的正态分布&#xff0c;它应用于矩阵形式的数据。矩阵正态分布在多维数据分析、贝叶斯统计和机器学习中有广泛的应用。其定义和性质如下&#xff1a; 定…
阅读更多...
Emacs之解决：java-mode占用C-c C-c问题(一百四十六)

Emacs之解决：java-mode占用C-c C-c问题(一百四十六)

简介&#xff1a; CSDN博客专家&#xff0c;专注Android/Linux系统&#xff0c;分享多mic语音方案、音视频、编解码等技术&#xff0c;与大家一起成长&#xff01; 优质专栏&#xff1a;Audio工程师进阶系列【原创干货持续更新中……】&#x1f680; 优质专栏&#xff1a;多媒…
阅读更多...
【django项目使用easycython编译】Cannot convert Unicode string to ‘str‘ implicitly.

【django项目使用easycython编译】Cannot convert Unicode string to ‘str‘ implicitly.

django项目编译遇到的问题 报错条件 需要编译的python源码里面的函数写了type hint&#xff0c;尤其是return的type hint&#xff0c; 当type hint是str时&#xff0c;但是变量确实f-string格式化后得到的&#xff0c;编译时会报错 报错原因 easycython会检查变量类型&…
阅读更多...
软件开发中的原型开发与需求文档开发：哪个更优？

软件开发中的原型开发与需求文档开发：哪个更优？

1. 引言 在软件开发过程中&#xff0c;选择合适的开发方法对于项目的成功至关重要。基于原型开发和基于需求文档开发是两种常见的开发方法&#xff0c;各自有其优点和缺点。在项目复杂性、客户需求和资源限制等因素的影响下&#xff0c;开发团队需要慎重选择适合的开发方法。 …
阅读更多...
C++语言相关的常见面试题目(二)

C++语言相关的常见面试题目(二)

1.vector底层实现原理 以下是 std::vector 的一般底层实现原理&#xff1a; 内存分配&#xff1a;当创建一个 std::vector 对象时&#xff0c;会分配一块初始大小的连续内存空间来存储元素。这个大小通常会随着 push_back() 操作而动态增加。 容量和大小&#xff1a;std::vec…
阅读更多...
element-plus 的form表单组件之el-radio（单选按钮组件）

element-plus 的form表单组件之el-radio（单选按钮组件）

单选按钮组件适用于同一组类型的选项只能互斥选择的场景&#xff0c;就是支持单选。单选组件包含以下3个组件 组件名作用el-radio-group单选组组件&#xff0c;子元素可以是el-radio或el-radio-button&#xff0c;v-mode绑定单选组的响应式属性el-radio单选组件&#xff0c;la…
阅读更多...
阶段三：项目开发---搭建项目前后端系统基础架构:任务9：导入空管基础数据

阶段三：项目开发---搭建项目前后端系统基础架构:任务9：导入空管基础数据

任务描述 本阶段任务是导入项目的基础数据&#xff0c;包括空管基础数据和离线的实时飞行数据&#xff08;已经脱敏&#xff09;。 任务指导 本阶段任务需要导入两种数据&#xff1a; 1、在MySQL中导入空管基础数据 kongguan.sql空管基础数据表说明&#xff1a; 1告警信息…
阅读更多...
OpenCV直方图计算函数calcHist的使用

OpenCV直方图计算函数calcHist的使用

操作系统&#xff1a;ubuntu22.04OpenCV版本&#xff1a;OpenCV4.9IDE:Visual Studio Code编程语言&#xff1a;C11 功能描述 图像的直方图是一种统计表示方法&#xff0c;用于展示图像中不同像素强度&#xff08;通常是灰度值或色彩强度&#xff09;出现的频率分布。具体来说…
阅读更多...
对MsgPack与JSON进行序列化的效率比较

对MsgPack与JSON进行序列化的效率比较

序列化是将对象转换为字节流的过程&#xff0c;以便在内存或磁盘上存储。常见的序列化方法包括MsgPack和JSON。以下将详细探讨MsgPack和JSON在序列化效率方面的差异。 1. MsgPack的效率&#xff1a; 优点&#xff1a; 高压缩率&#xff1a; MsgPack采用高效的二进制编码格式&…
阅读更多...
Embedding理解

Embedding理解

一、概念 Embedding 可以理解为一种将概念、物体或信息转换为数字序列的数值表示方法。它是沟通两个不同世界或领域的桥梁，能够把各种类型的数据（如文本、图像、视频等）映射到一个向量空间中。 在这个向量空间里，相似的项目（例如语义上相近的单词、相似的图像或相关的视…
阅读更多...
cs231n作业1——SVM

cs231n作业1——SVM

参考文章&#xff1a;cs231n assignment1——SVM SVM 训练阶段&#xff0c;我们的目的是为了得到合适的 &#x1d44a; 和 &#x1d44f; &#xff0c;为实现这一目的&#xff0c;我们需要引进损失函数&#xff0c;然后再通过梯度下降来训练模型。 def svm_loss_naive(W, …
阅读更多...
【Qt】Qt概述

【Qt】Qt概述

目录 一. 什么是Qt 二. Qt的优势 三. Qt的应用场景 四. Qt行业发展方向 一. 什么是Qt Qt是一个跨平台的C图形用户界面应用程序框架&#xff0c;为应用程序开发者提供了建立艺术级图形界面所需的所有功能。 Qt是完全面向对象的&#xff0c;很容易扩展&#xff0c;同时Qt为开发…
阅读更多...
从打印到监测：纳米生物墨水助力3D生物打印与组织监测平台？

从打印到监测：纳米生物墨水助力3D生物打印与组织监测平台？

从打印到监测&#xff1a;纳米生物墨水助力3D生物打印与组织监测平台&#xff1f; 在 3D 组织工程中&#xff0c;纳米生物墨水是将纳米材料与 ECM 水凝胶结合&#xff0c;以提高其打印性和功能性的重要策略。纳米生物墨水可以增强水凝胶的机械性能、导电性、生物活性&#xff…
阅读更多...
汽车报价资讯app小程序模板源码

汽车报价资讯app小程序模板源码

蓝色实用的汽车报价&#xff0c;汽车新闻资讯&#xff0c;最新上市汽车资讯类小程序前端模板。包含&#xff1a;选车、资讯列表、榜单、我的主页、报价详情、资讯详情、询底价、登录、注册、车贷&#xff0c;油耗、意见反馈、关于我们等等。这是一款非常全的汽车报价小程序模板…
阅读更多...
MNIST 数据集 ubyte 格式介绍

MNIST 数据集 ubyte 格式介绍

train-images-idx1-ubyte 文件是用于存储 MNIST 数据集中手写数字图像数据的文件。与标签文件类似&#xff0c;这个文件使用的是一种简单而紧凑的二进制格式。具体的文件格式如下&#xff1a; 文件头&#xff08;Header&#xff09;&#xff1a; 文件头部分包含了一些描述文件内…
阅读更多...
Ubuntu 20版本安装Redis教程，以及登陆

Ubuntu 20版本安装Redis教程，以及登陆

第一步 切换到root用户&#xff0c;使用su命令&#xff0c;进行切换。 输入&#xff1a; su - 第二步 使用apt命令来搜索redis的软件包&#xff0c;输入命令&#xff1a;apt search redis 第三步 选择需要的redis版本进行安装&#xff0c;本次选择默认版本&#xff0c;redis5.…
阅读更多...
Emacs 的优点及与 DE 的比较

Emacs 的优点及与 DE 的比较

一、引言 在编程领域&#xff0c;对于工具的选择一直是开发者们热议的话题。今天&#xff0c;我们来探讨一下 Emacs 及其所具有的优点&#xff0c;并思考使用 Emacs 写程序是否真的比使用集成开发环境&#xff08;IDE&#xff09;更方便。 二、Emacs 的优点 高度可定制性 可以…
阅读更多...
最新文章

Copyright @ 2022~2023