实现完整统一响应对象

最新推荐文章于 2024-02-26 21:21:33 发布
最新推荐文章于 2024-02-26 21:21:33 发布
阅读量399 收藏
点赞数
分类专栏： JAVA 文章标签： java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38667268/article/details/128271489
版权
本文介绍了在前后端分离的开发模式下，为减少沟通成本并提高问题定位效率，如何设计并实现一个统一的响应对象。内容包括响应对象包含的字段如状态码、详细错误信息、业务数据、分布式跟踪ID等，以及实现步骤，如定义统一返回码接口、创建响应结果类、工具类、业务异常类，并通过全局异常拦截器进行异常处理。
摘要由CSDN通过智能技术生成

一、常见场景
前后端分离，定义一种统一的返回格式应该有一个标准，减少沟通成本。
基于约定去理解，出现问题能快速的定位。

二、统一响应对象一半包含哪些字段，如下：

{
"code": 0,
"message": "成功",
detailMessage："成功",
"data": true,
"traceId" ": "54sd5a545as4",
"spanId": "654565k56h54jk",
"env": "dev"
}

code:状态码，通常是6位，不同的开头代表不同的业务
detailMessage:开发人员看，打印的错误栈信息
data：返回给调用方的业务数据，通常是json
traceId：分布式链路跟踪-traceId,通常结合日志平台使用
spanId：分布式链路跨度-spanId，所有的spanId组合在一起就是整个链路的trace
env：当前的服务部署的环境，dev、prod

三、实现方案及实现步骤
1、定义一个通用的统一返回码接口∶IRespResultCode.java。接口里面规范子类对象要实现的方法.
例如: getcode.getMessage() ,getDetailHessage()

2、定义一个通用的统一返回码对象︰RespRe sultCode.java实现IRespResultCode接口，主要放通用的返回结果信息。
例如:请求成功、系统异常、网络异常、参数不合法等信息。

3、定义一个处理返回结来的

最低0.47元/天 解锁文章
阿里巴巴技术总指挥
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
统一结果集返回java代码
06-10
统一结果集返回java代码
vue+axios 拦截器实现统一token的案例
10-14
本案例将详细讲解如何在Vue项目中利用axios的拦截器实现统一的token管理。 首先，`axios`的拦截器分为两种：`request interceptors`和`response interceptors`。`request interceptors`在请求被发送到服务器之前...
java 封装一个项目的全局响应对象
weixin_44310899的博客
09-11 635
在项目中通常我们的controller层中，每个方法都要有一个返回值对象，通过返回值对象传给前端工程师以便于处理业务需求，如果我们在controller每个方法都没有统一的返回值对象，我们的代码可维护性就会很差，前端工程师处理起来也不是很方便，便于这样的情况，我们通常的做法是整个项目中，封装一个总得全局响应对象，下面是我封装的JsonCallBack对象 package com.tcyl.dam.savior.json; import lombok.AllArgsConstructor; import l
java：封装统一的响应体code、data、msg、paging
分享前端开发工程师的一些日常生活、前端知识点、职业发展、对一些问题的看法、感悟等等
12-04 1271
我们在写接口的时候一般不会直接返回给前端数据，而是会有响应体，比如 code、data、msg，这样就有一个统一的结构方便前端处理，那么今天就来封装一个统一的响应体。1、在 config 包里新建 ApiResponse.java。这是一个非常简单的封装，如果更复杂的可以在这个基础上增加。
【JavaWeb基础】统一响应结果
qq_42294095的博客
06-26 243
统一响应结果
java统一响应信息主体（工具类）
故事的小黄花的博客
05-13 548
【代码】java统一响应信息主体（工具类）
详解SpringBoot统一响应体解决方案
08-25
在实现统一响应体解决方案时，需要满足以下几点： 1. 不限制返回类型，能够适应不同的返回类型。 2. 能够基于注解，减少切面表达式的修改。 三、统一响应体的解决方案 基于上述需求，选择使用 Spring 的 ...
java swing 实现蜘蛛纸牌 面向对象思想
04-19
例如，所有牌堆类（Stack和Foundation）都可以实现一个统一的`moveCard()`方法，但具体实现可能不同。 - **接口**：定义行为规范，不关心实现细节。例如，可以定义一个`GameElement`接口，规定所有游戏元素必须有的...
Vue+axios实现统一接口管理的方法
10-18
本文将介绍如何利用Vue.js和axios实现统一接口管理的方法，以提高代码的复用性，简化接口的调用过程。 首先，我们可以通过创建一个全局的axios实例，来集中管理API请求的配置项，例如baseURL、timeout、headers等。...
.Net用面向对象实现ATM机
02-26
综上所述，".Net用面向对象实现ATM机"项目涵盖了OOP的多个核心概念，包括类的设计、继承、封装、多态、接口、集合、事件处理、用户界面设计以及错误处理。通过这个项目，开发者可以提升其.NET开发技能，并理解如何将...
JAVA利用泛型返回类型不同的对象方法
08-31
下面小编就为大家带来一篇JAVA利用泛型返回类型不同的对象方法。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
结果集ResultDTO
qq_36296417的博客
12-18 2900
统一返回结果集ResultDTO @Data public class ResultDTO<T> extends HashMap<Object,Object> { /** 状态码 */ public static final String CODE = "code"; /** 返回内容 */ public static final String MSG = "msg"; /** 数据对象 */ public static fina
Java统一响应格式-笔记
weixin_52408528的博客
01-03 424
笔记自用
java通用响应体封装（Single）
AG.『Feng』的博客
11-04 1369
java封装通用响应体
Java SSM项目统一响应
Java开发日常
05-27 141
RestControllerAdvice添加mvc增强配置类，@ExceptionHandler(value=Exception.class)标注进行异常管理。项目中我们会将响应封装成json返回，若将所有的接口的数据格式统一，可以使前端对数据的操作更一致、轻松。一般采用错误码、错误消息、返回数据三部分组成。接口，实现里面的supports方法（代表哪些需要同意返回返回），重写beforeBodyWrite方法，封装里面的 T数据。在mvc层实现全栈的异常捕获处理。采用返回前检查的方式完成，实现。
Java 统一封装响应结果--统一系统响应格式
QiuHaoqian的博客
02-01 1425
第一步：定义枚举，管理响应码和相应消息 package com.example.demo.responseResult; public enum ResultCode { /** * 成功:200 */ SUCCESS(200, "成功"), /** * 参数错误：1001-1999 */ PARAM_IS_INVALID(1001, "参数无效"), PARAM_IS_NULL(1002, "参数为空"), PARA
JAVA - API 定义 统一返回
sou_time
07-01 590
一。定义创建统一返回的格式 和定义枚举 package com.baking.baking.zander.enums; /** * @author: di-zhang * @description: 错误返回通用枚举 */ public enum ResponseEnum { /** * 成功 */ SUCCESS(0, "successful"), /** * 失败 */ FAILURE(-1, "服务器错误");
java自定义异常并使用API统一返回对象
最新发布
weixin_56392989的博客
02-26 1225
在开发中，需要使用API统一返回对象保证后端返回的数据是固定并有格式的，便于前端进行解析，返回相应的信息给用户，这就要求不管程序抛出任何错误或异常，你所返回的对象都应该是："status": ‘状态码’,"msg": "信息"，“data”：“数据”
Java全局统一返回处理
tony_stark的博客
12-21 5129
新项目中不希望每次返回参数还要重新封装再返回，希望直接将查询数据或者返回数据统一定义进行返回，所以将新项目中的全局统一返回配置记录，备忘。同时分享给有需要的码友。(例：查询出来的对象集合直接返回，会统一封装在一个返回对象的data中丢给前端，保持返回数据统一) 1.创建统一返回对象： import lombok.Data; import java.io.Serializable; /** * 全局统一返回对象 * * @author Tom * @date 2020-12-14 */ @Data
java怎样实现统一异常处理
07-14
在Java中实现统一异常处理可以通过以下步骤进行操作： 1. 创建一个全局异常处理类：创建一个类，用于处理应用程序中抛出的所有异常。可以命名为GlobalExceptionHandler或类似的名称。 ```java public class GlobalExceptionHandler implements HandlerExceptionResolver { @Override public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { // 在这里处理异常并返回适当的错误响应 return new ModelAndView("error"); // 返回一个自定义的错误页面或其他错误响应 } } ``` 2. 实现HandlerExceptionResolver接口：让全局异常处理类实现HandlerExceptionResolver接口，并实现其中的resolveException()方法。 3. 处理异常并返回错误响应：在resolveException()方法中，根据需要对捕获到的异常进行适当的处理，并返回一个错误响应给客户端。可以是一个自定义的错误页面，或者是一个包含错误信息的JSON对象。 4. 注册全局异常处理器：将全局异常处理器注册到应用程序中，以确保它能够捕获到所有的异常。具体的注册方式取决于所使用的Java框架。 在Spring框架中，可以通过以下方式注册全局异常处理器： ```java @Configuration @EnableWebMvc public class WebConfig implements WebMvcConfigurer { @Override public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) { resolvers.add(new GlobalExceptionHandler()); } } ``` 在Spring Boot框架中，可以通过以下方式注册全局异常处理器： ```java @RestControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) public ResponseEntity<ErrorResponse> handleException(Exception ex) { // 在这里处理异常并返回适当的错误响应 ErrorResponse errorResponse = new ErrorResponse("500", "Internal Server Error"); return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR); } } ``` 需要根据具体的需求和框架进行调整和实施。以上是一种常见的实现方式，可以根据自己的需求进行扩展和定制。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值