开发指南002-前后端信息交互规范-请求类

wangbing11252024-03-10 12:01

复制代码

请求类由org.qlm.io.vo.RequestInfo定义：

java 复制代码

//1.0
@Schema(description = "平台-请求包版本标识 用于版本兼容")
private String version;

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

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

@Schema(description = "平台-请求者语言")
private String language;//请求者 要求使用的语言 zh-cn zh-tw en jp

//分页要求参数
@Schema(description = "平台-页码 下标从0开始")
private Integer page;//页码  下标从0开始

@Schema(description = "平台-每页最大数据")
private Integer size;//每页最大数据

//附加参数
@Schema(description = "平台-附加参数 简单的单参数请求可以使用该参数")
private String tag;
@Schema(description = "平台-描述tag的用处")
private String tagDescription;

@Schema(description = "平台-附加参数2 简单的单参数请求可以使用该参数")
private String tag2;

@Schema(description = "平台-描述tag2的用处")
private String tagDescription2;

简单的请求（1-2个参数）直接使用 RequestInfo即可，例如删除请求，将要删除对象的id存入tag即可。对于复杂的请求，需要定义一个dto扩展RequestInfo。之所以这样做，而不是在Requestinfo中定义一个模板属性private T data;//具体请求信息是因为swagger里无法正确解析T。

version：目前为"1.0"，之所以设计这个属性是为了保持兼容。（例如后台可能同时接收到1.0或1.1的请求包）

consumer：标识请求，在前端配置文件中定义

serialNo：uuid，唯一标识一个请求