开发指南002-前后端信息交互规范-返回类ResponseResult

返回类有两个,一般返回类ResponseResult和分页返回类PageResult,本篇介绍ResponseResult

java 复制代码
public class ResponseResult<T> implements Serializable{
    @Schema(description = "平台-返回结构类型 表明是千里马架构返回体")
    private String flag;
    //1.0
    @Schema(description = "平台-返回结构版本 用于版本兼容")
    private String version="1.0";

    @Schema(description = "平台-返回服务的时间戳")
    private String timestamp;

    @Schema(description = "平台-请求者")
    private String consumer;//请求者 标识发出请求的系统

    @Schema(description = "平台-返回提供服务的名字")
    private String server; //返回该消息的服务

    @Schema(description = "平台-返回提供服务的名字")
    private String path; //返回该消息的服务路径

    @Schema(description = "平台-请求流水")
    private String serialNo;//请求流水

    @Schema(description = "平台-返回码")
    private int retCode;//返回码 IOResultEnum中定义

    @Schema(description = "平台-返回消息")
    private String msg;//返回消息

    @Schema(description = "平台-返回结构信息")
    private T data;//返回结构信息
}

flag用于标识平台服务返回包(有时候前端收到的返回并不是后台服务返回的,而是网关返回)

返回ResponseResult时 底层提供了五种构造方法:

通用

public ResponseResult(String server,String path,String serialNo,String msg,IOResultEnum code,T data)

异常时用

public ResponseResult(String path,RequestInfo requestInfo,Exception e)

错误时用(可以自定义错误消息)

ResponseResult(String path,RequestInfo requestInfo,IOResultEnum code,String msg)

正确时用

public ResponseResult(String path,RequestInfo requestInfo,T data)

无需返回具体数据,只需要正确或错误(看code)

ResponseResult(String path, RequestInfo requestInfo, IOResultEnum code)

相关推荐
奋斗羊羊4 小时前
【C++】使用MSBuild命令行编译ACE、TAO、DDS
开发语言·c++·windows
paj1234567894 小时前
elasticsearch-8.12.2集群部署
java·elasticsearch
1candobetter4 小时前
JAVA后端开发——软件分层架构中的“管道井”原则
java·开发语言·架构
三掌柜6664 小时前
突破AR视觉交互边界:Unity赋能Rokid AR眼镜实现高精度图像识别与实时跟踪
unity·ar·交互
Seven974 小时前
Spring 事务、循环依赖
java
聪明的笨猪猪4 小时前
Java Redis “核心应用” 面试清单(含超通俗生活案例与深度理解)
java·经验分享·笔记·面试
为java加瓦5 小时前
Spring 方法注入机制深度解析:Lookup与Replace Method原理与应用
java·数据库·spring
_extraordinary_5 小时前
Java SpringIoC&DI --- @Bean,DI
java·开发语言
史迪奇_xxx5 小时前
9、C/C++ 内存管理详解:从基础到面试题
java·c语言·c++