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

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

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

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;//返回结构信息
}

image.gif

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)

相关文章
|
1月前
|
存储 数据可视化 JavaScript
可视化集成API接口请求+变量绑定+源码输出
可视化集成API接口请求+变量绑定+源码输出
43 4
|
3月前
|
JSON 前端开发 API
构建前端防腐策略问题之更新getMemoryUsagePercent函数以适应新的API返回格式的问题如何解决
构建前端防腐策略问题之更新getMemoryUsagePercent函数以适应新的API返回格式的问题如何解决
构建前端防腐策略问题之更新getMemoryUsagePercent函数以适应新的API返回格式的问题如何解决
|
3月前
|
前端开发 安全 小程序
如何设计 API 接口,实现统一格式返回?
如何设计 API 接口,实现统一格式返回?
48 0
|
3月前
|
开发框架 前端开发 API
使用代码生成工具快速开发应用-结合后端Web API提供接口和前端页面快速生成,实现通用的业务编码规则管理
使用代码生成工具快速开发应用-结合后端Web API提供接口和前端页面快速生成,实现通用的业务编码规则管理
|
6月前
|
前端开发
|
6月前
|
前端开发
开发指南002-前后端信息交互规范-概述
前后端之间采用restful接口,服务和服务之间使用feign
|
前端开发 UED
前端拿到后端接口字段为null时,一行代码为你解决
我们可以看到有三个字段为 null ,我们前端要拿字段渲染到页面不可能把null 渲染出去
671 0
|
存储 数据可视化 数据挖掘
"探索API:解析应用程序接口的作用、功能和应用场景"
随着互联网技术的不断发展,API(Application Programming Interface)已经成为了连接不同应用程序之间的重要工具,API不仅可以帮助开发者更加容易地创建应用程序,同时还能提供更多的数据和功能,丰富了应用程序的体验和用户的使用感受。在本文中,我们将探讨API的作用、功能和应用场景。
160 0
|
前端开发 JavaScript API
浅谈前端编程语言及API数据返回展示
前端编程语言是指用于开发网站和应用程序的编程语言。