一、常见场景
前后端分离,定义一种统一的返回格式应该有一个标准,减少沟通成本。
基于约定去理解,出现问题能快速的定位。
二、统一响应对象一半包含哪些字段,如下:
{
"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、定义一个处理返回结来的