开发指南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)

相关推荐
DuelCode22 分钟前
Windows VMWare Centos Docker部署Springboot 应用实现文件上传返回文件http链接
java·spring boot·mysql·nginx·docker·centos·mybatis
浪裡遊22 分钟前
React Hooks全面解析:从基础到高级的实用指南
开发语言·前端·javascript·react.js·node.js·ecmascript·php
优创学社226 分钟前
基于springboot的社区生鲜团购系统
java·spring boot·后端
幽络源小助理33 分钟前
SpringBoot基于Mysql的商业辅助决策系统设计与实现
java·vue.js·spring boot·后端·mysql·spring
猴哥源码34 分钟前
基于Java+springboot 的车险理赔信息管理系统
java·spring boot
lzb_kkk1 小时前
【C++】C++四种类型转换操作符详解
开发语言·c++·windows·1024程序员节
YuTaoShao1 小时前
【LeetCode 热题 100】48. 旋转图像——转置+水平翻转
java·算法·leetcode·职场和发展
好开心啊没烦恼1 小时前
Python 数据分析:numpy,说人话,说说数组维度。听故事学知识点怎么这么容易?
开发语言·人工智能·python·数据挖掘·数据分析·numpy
Dcs2 小时前
超强推理不止“大”——手把手教你部署 Mistral Small 3.2 24B 大模型
java
简佐义的博客2 小时前
破解非模式物种GO/KEGG注释难题
开发语言·数据库·后端·oracle·golang