记录类 ApiResult<T>

java.lang.Object

java.lang.Record

io.github.lishangbu.orange.web.result.ApiResult<T>

类型参数:

T - 返回的数据类型

记录组件：

code - 获取 API 返回结果的状态码

data - 获取 API 返回的数据

errorMessage - 获取 API 返回的错误信息

所有已实现的接口:

Serializable

public record ApiResult<T>(Integer code, T data, String errorMessage)
extends Record
implements Serializable

API 返回结果的封装类，包含状态码、数据和错误信息。

从以下版本开始:

2025/4/16

作者:

lishangbu

另请参阅:

• 序列化表格

字段概要

字段

修饰符和类型	字段	说明
static final Integer	SUCCESS_CODE	默认的成功操作码，通常用于表示操作成功。

构造器概要

构造器

构造器	说明
ApiResult(Integer code, T data, String errorMessage)	创建 ApiResult 记录类的实例。

方法概要

修饰符和类型	方法	说明
Integer	code()	返回 code 记录组件的值。
T	data()	返回 data 记录组件的值。
final boolean	equals(Object o)	指示某个其他对象是否“等于”此对象。
String	errorMessage()	返回 errorMessage 记录组件的值。
static ApiResult<Void>	failed(int code, String errorMessage)	创建一个失败的 API 返回结果，带有指定的错误码和错误信息。
static ApiResult<Void>	failed(ErrorResultCode errorResultCode, String... errorMessages)	构建一个失败的 API 返回结果。
final int	hashCode()	返回此对象的哈希代码值。
static <T> ApiResult<T>	ok(T data)	创建一个成功的 API 返回结果。
final String	toString()	返回此记录类的字符串表示形式。

从类继承的方法 Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

SUCCESS_CODE

public static final Integer SUCCESS_CODE

默认的成功操作码，通常用于表示操作成功。

构造器详细资料

ApiResult

public ApiResult(Integer code,
 T data,
 String errorMessage)

创建 ApiResult 记录类的实例。

参数:

code - code 记录组件的值

data - data 记录组件的值

errorMessage - errorMessage 记录组件的值

方法详细资料

ok

public static <T> ApiResult<T> ok(T data)

创建一个成功的 API 返回结果。

类型参数:

T - 数据类型

参数:

data - 返回的数据

返回:

成功的 API 返回结果

failed

public static ApiResult<Void> failed(int code,
 String errorMessage)

创建一个失败的 API 返回结果，带有指定的错误码和错误信息。

参数:

code - 错误码

errorMessage - 错误信息

返回:

失败的 API 返回结果

failed

public static ApiResult<Void> failed(ErrorResultCode errorResultCode,
 String... errorMessages)

构建一个失败的 API 返回结果。

该方法根据传入的错误结果码和错误信息生成一个失败的 API 返回结果。如果没有提供额外的错误信息， 则使用错误结果码中预设的错误信息。若提供了额外的错误信息，则会将其与错误结果码的错误信息 进行拼接，构建最终的错误消息。

参数:

errorResultCode - 错误结果码，包含错误的状态码和默认的错误信息。

errorMessages - 可变长度的额外错误信息（可选）。如果有额外的错误信息，将与默认错误信息一同返回。

返回:

返回一个封装了失败状态的 API 结果对象。

toString

public final String toString()

返回此记录类的字符串表示形式。此表示形式包含类的名称，后跟每个记录组件的名称和值。

指定者:

toString 在类中 Record

返回:

此对象的字符串表示形式

hashCode

public final int hashCode()

返回此对象的哈希代码值。此值派生自每个记录组件的哈希代码。

指定者:

hashCode 在类中 Record

返回:

此对象的哈希代码值

equals

public final boolean equals(Object o)

指示某个其他对象是否“等于”此对象。如果两个对象属于同一个类，而且所有记录组件都相等，则这两个对象相等。 此记录类中的所有组件都使用 Objects::equals(Object,Object) 进行比较。

指定者:

equals 在类中 Record

参数:

o - 要与之进行比较的对象

返回:

如果此对象与 o 参数相同，则为 true；否则为 false。

code

public Integer code()

返回 code 记录组件的值。

返回:

code 记录组件的值

data

public T data()

返回 data 记录组件的值。

返回:

data 记录组件的值

errorMessage

public String errorMessage()

返回 errorMessage 记录组件的值。

返回:

errorMessage 记录组件的值