net.sohelp.boot.admin.core.base

类 ApiResult<T>

java.lang.Object

net.sohelp.boot.admin.core.base.ApiResult<T>

所有已实现的接口:

Serializable

public class ApiResult<T>
extends Object
implements Serializable

统一API返回结果封装类，用于封装接口响应的数据结构。 包含元数据（状态码、消息等）和实际业务数据两部分。

从以下版本开始:

2023/8/12 12:32

作者:

AaronFung

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
class	ApiResult.MetaVO 封装API返回的元数据信息，包括状态码、消息、错误详情及成功标识。

构造器概要

构造器

构造器和说明
ApiResult() 默认构造函数
ApiResult(Integer code, String message) 构造函数：根据指定的状态码和消息初始化meta对象

方法概要

限定符和类型	方法和说明
ApiResult<T>	setCode(Integer code) 设置状态码并返回当前实例以支持链式调用
ApiResult<T>	setData(T data) 设置返回的业务数据并返回当前实例以支持链式调用
ApiResult<T>	setError(String error) 设置内部错误信息并返回当前实例以支持链式调用
ApiResult<T>	setMeta(ApiResult.MetaVO metaVO) 设置完整的MetaVO对象并返回当前实例以支持链式调用

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ApiResult

public ApiResult()

默认构造函数

ApiResult

public ApiResult(Integer code,
                 String message)

构造函数：根据指定的状态码和消息初始化meta对象

参数:

code - 状态码

message - 提示信息

方法详细资料

setError

public ApiResult<T> setError(String error)

设置内部错误信息并返回当前实例以支持链式调用

参数:

error - 内部错误描述信息

返回:

当前ApiResult实例

setData

public ApiResult<T> setData(T data)

设置返回的业务数据并返回当前实例以支持链式调用

参数:

data - 实际业务数据

返回:

当前ApiResult实例

setCode

public ApiResult<T> setCode(Integer code)

设置状态码并返回当前实例以支持链式调用

参数:

code - 状态码

返回:

当前ApiResult实例

setMeta

public ApiResult<T> setMeta(ApiResult.MetaVO metaVO)

设置完整的MetaVO对象并返回当前实例以支持链式调用

参数:

metaVO - 元数据对象

返回:

当前ApiResult实例