Class Result<T>

java.lang.Object
tech.riemann.nif.web.response.Result<T>
Type Parameters:
T - 响应数据的类型
public class Result<T> extends Object
API响应结果类

用于统一API响应格式，包含响应状态、数据、错误信息和扩展数据

支持泛型，可以返回不同类型的数据

提供了多种静态方法用于创建不同类型的响应结果： 1. success() - 返回成功响应 2. success(T t) - 携带数据返回成功响应 3. fail(String... msgs) - 返回失败响应及原因 4. exception(String... msgs) - 返回异常响应及原因 5. exception(List<String> msgs) - 返回异常响应及原因列表 6. exception(Throwable... throwables) - 从异常对象创建异常响应

Author:
Kerbores(kerbores@riemann.tech)

  • Constructor Details

    • Result

      public Result()

  • Method Details

    • success

      public static <T> Result<T> success()
      返回成功响应

      创建一个状态为SUCCESS的响应结果，不携带数据

      Type Parameters:
      T - 响应数据的类型
      Returns:
      成功的响应结果

    • success

      public static <T> Result<T> success(T t)
      携带数据返回成功响应

      创建一个状态为SUCCESS的响应结果，并携带指定的数据

      Type Parameters:
      T - 响应数据的类型
      Parameters:
      t - 要返回的数据
      Returns:
      成功的响应结果，包含指定的数据

    • fail

      public static <T> Result<T> fail(String... msgs)
      返回失败响应及原因

      创建一个状态为FAIL的响应结果，并携带失败原因

      Type Parameters:
      T - 响应数据的类型
      Parameters:
      msgs - 失败原因
      Returns:
      失败的响应结果，包含失败原因

    • exception

      public static <T> Result<T> exception(String... msgs)
      返回异常响应及原因

      创建一个状态为EXCEPTION的响应结果，并携带异常原因

      Type Parameters:
      T - 响应数据的类型
      Parameters:
      msgs - 异常原因
      Returns:
      异常的响应结果，包含异常原因

    • exception

      public static <T> Result<T> exception(List<String> msgs)
      返回异常响应及原因列表

      创建一个状态为EXCEPTION的响应结果，并携带异常原因列表

      Type Parameters:
      T - 响应数据的类型
      Parameters:
      msgs - 异常原因列表
      Returns:
      异常的响应结果，包含异常原因列表

    • exception

      public static <T> Result<T> exception(Throwable... throwables)
      从异常对象创建异常响应

      创建一个状态为EXCEPTION的响应结果，从异常对象中提取异常信息

      Type Parameters:
      T - 响应数据的类型
      Parameters:
      throwables - 异常对象
      Returns:
      异常的响应结果，包含从异常对象中提取的异常信息

    • addExtData

      public Result<T> addExtData(String key, Object value)
      添加扩展数据

      向响应结果中添加扩展数据，支持链式调用

      Parameters:
      key - 数据的键
      value - 数据的值
      Returns:
      当前响应结果对象，支持链式调用

    • isSuccess

      public boolean isSuccess()
      判断操作是否成功

      当响应状态为SUCCESS时返回true，否则返回false

      Returns:
      是否成功的标识

    • toString

      public String toString()
      重写toString方法，返回响应结果的JSON表示

      使用Json.toJson方法将响应结果转换为JSON字符串

      Overrides:
      toString in class Object
      Returns:
      响应结果的JSON字符串表示