Class Result<T>

java.lang.Object
com.sure.tool.lang.Result<T>
Type Parameters:
T - 成功值类型

public final class Result<T> extends Object
显式错误传播的两态结果门面(成功值 / 失败信息)。

与异常流互补:适合业务校验、批量聚合等"失败信息需要显式携带"的场景, 支持 map(Function)/flatMap(Function) 链式短路、recover(Function) 恢复与 throwIfFailed() 终止式转换。零依赖,对标 Vavr Result。

使用示例:

Result<Integer> r = Result.ok(1)
        .map(x -> x * 2)                       // 2
        .onSuccess(v -> log(v))
        .recover(e -> 0);                      // 失败恢复
if (r.isFailure()) { throw new BizException(r.getErrorMessage()); }

null 语义:ok(T) 允许 null 值;fail(String) 不允许 null 信息(立即 NPE);失败时 get()/throwIfFailed() 抛异常, getOrNull()/getOrElse(T) 返回默认值。

Since:
1.12.0
  • Method Details

    • ok

      public static <T> Result<T> ok(T value)
      成功结果。
      Type Parameters:
      T - 泛型
      Parameters:
      value - 值(可为 null)
      Returns:
      Result
    • fail

      public static <T> Result<T> fail(String errorMessage)
      失败结果(仅信息)。
      Type Parameters:
      T - 泛型
      Parameters:
      errorMessage - 失败信息
      Returns:
      Result
    • fail

      public static <T> Result<T> fail(Throwable cause)
      失败结果(携带异常)。
      Type Parameters:
      T - 泛型
      Parameters:
      cause - 异常
      Returns:
      Result
    • fail

      public static <T> Result<T> fail(String errorMessage, Throwable cause)
      失败结果(信息 + 异常)。
      Type Parameters:
      T - 泛型
      Parameters:
      errorMessage - 失败信息
      cause - 异常(可为 null)
      Returns:
      Result
    • isSuccess

      public boolean isSuccess()
      是否成功。
      Returns:
      true=成功
    • isFailure

      public boolean isFailure()
      是否失败。
      Returns:
      true=失败
    • get

      public T get()
      获取成功值(失败抛 NoSuchElementException)。
      Returns:
      成功值
      Throws:
      NoSuchElementException - 失败时
    • getOrNull

      public T getOrNull()
      获取成功值;失败返回 null。
      Returns:
      值或 null
    • getOrElse

      public T getOrElse(T defaultValue)
      获取成功值;失败返回默认值。
      Parameters:
      defaultValue - 默认值
      Returns:
      值或默认值
    • getOrElseGet

      public T getOrElseGet(Supplier<T> supplier)
      获取成功值;失败时由供应器提供。
      Parameters:
      supplier - 默认值供应器
      Returns:
      值或供应值
    • map

      public <U> Result<U> map(Function<? super T, ? extends U> mapper)
      映射成功值(失败短路保留原错误)。
      Type Parameters:
      U - 新泛型
      Parameters:
      mapper - 映射函数
      Returns:
      新 Result
    • flatMap

      public <U> Result<U> flatMap(Function<? super T, ? extends Result<? extends U>> mapper)
      平铺映射(失败短路保留原错误;mapper 返回 null 视为成功 null 值)。
      Type Parameters:
      U - 新泛型
      Parameters:
      mapper - 返回 Result 的映射函数
      Returns:
      新 Result
    • onSuccess

      public Result<T> onSuccess(Consumer<? super T> consumer)
      成功时回调(链式可用,返回自身)。
      Parameters:
      consumer - 成功消费者
      Returns:
      this
    • onFailure

      public Result<T> onFailure(Consumer<String> consumer)
      失败时回调(链式可用,返回自身)。
      Parameters:
      consumer - 失败消费者(入参为错误信息)
      Returns:
      this
    • recover

      public Result<T> recover(Function<String, ? extends T> recoverer)
      失败恢复:将失败转换为成功值(成功原样返回)。
      Parameters:
      recoverer - 恢复函数(入参为错误信息)
      Returns:
      恢复后的 Result
    • throwIfFailed

      public T throwIfFailed()
      失败时抛出异常(携带 cause),成功返回自身值。
      Returns:
      成功值
      Throws:
      RuntimeException - 失败时(cause 为原始异常,无 cause 时含错误信息)
    • getErrorMessage

      public String getErrorMessage()
      获取失败信息(成功返回 null)。
      Returns:
      失败信息或 null
    • getCause

      public Throwable getCause()
      获取失败异常(成功返回 null)。
      Returns:
      异常或 null
    • toOptional

      public Optional<T> toOptional()
      转 JDK Optional(失败为空)。
      Returns:
      Optional
    • toString

      public String toString()
      Overrides:
      toString in class Object