Flutter错误处理插件neverthrow的使用

Flutter 错误处理插件 neverthrow 的使用

描述

neverthrow 是一个将 TypeScript 包 neverthrow 移植到 Dart 的库。该库提供了用于处理成功和失败结果的 Result 类型。对于异步任务，neverthrow 提供了 ResultAsync 类，它可以包装一个 Future<Result<T, E>>，并提供与常规 Result<T, E> 相同级别的表达性和控制。

ResultAsync 是可then化的，意味着它表现得像一个原生的 Future。

安装

在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  neverthrow: ^1.0.0

或者运行以下命令：

dart pub add neverthrow

使用

以下是一些使用 neverthrow 的示例代码：

import 'package:neverthrow/neverthrow.dart';

void main() {
  // 创建一个成功的结果
  final okValue = ok(10);
  print(okValue.isOk()); // true
  print(okValue.value); // 10

  // 创建一个失败的结果
  final errValue = err('error');
  print(errValue.isErr()); // true
  print(errValue.error); // error

  // 对成功的结果进行映射操作
  final mappedOk = ok(10).map((value) => value * 2); // Result<int, dynamic>
  print(mappedOk.isOk()); // true
  print(mappedOk.asOk.value); // 20

  // 对失败的结果进行映射操作
  final mappedErr = err('error')
      .mapErr((error) => 'There is an $error'); // Result<dynamic, String>
  print(mappedErr.isErr()); // true
  print(mappedErr.asErr.error); // There is an error

  // 链接多个操作
  final chainedResult = ok(10)
      .andThen((value) => ok(value * 2))
      .andThen((value) => err<int, String>('error'));
  print(chainedResult.isErr()); // true
  print(chainedResult.asErr.error); // error

  // 使用 orElse 处理错误
  final orElseResult = err('error').orElse((error) => ok(10));
  print(orElseResult.isOk()); // true
  print(orElseResult.asOk.value); // 10

  // 使用 match 处理两种情况
  final matchResult = ok(10).match((value) => value * 2, (error) => 0);
  print(matchResult); // 20

  // 使用 unwrapOr 处理两种情况
  final unwrapOrResult = err('error').unwrapOr(10);
  print(unwrapOrResult); // 10

  // 使用 fromFuture 处理 Future 结果
  final futureResult =
      ResultAsync.fromFuture(Future.value(10), (error) => 'There is an $error');
  futureResult.match((value) => print(value), (error) => print(error)); // 10

  // 使用 fromSafeFuture 处理 Future 结果
  final safeFutureResult = ResultAsync.fromSafeFuture(Future.value(10));
  safeFutureResult.match(
      (value) => print(value), (error) => print(error)); // 10

  // 对 Future 结果进行映射操作
  final mappedFuture =
      ResultAsync.fromSafeFuture(Future.value(10)).map((value) => value * 2);
  mappedFuture.match((value) => print(value), (error) => print(error)); // 20

  // 对 Future 错误结果进行映射操作
  final mappedFutureError = ResultAsync.fromFuture(
          Future.error('error'), (error) => 'There is an $error')
      .map((value) => value * 2);
  mappedFutureError.match(
      (value) => print(value), (error) => print(error)); // There is an error

  // 链接多个 Future 操作
  final chainedFutureResult = ResultAsync.fromSafeFuture(Future.value(10))
      .andThen((value) => ResultAsync.fromSafeFuture(Future.value(value * 2)))
      .andThen((value) => ResultAsync.fromFuture(
          Future.error('error'), (error) => 'There is an $error'));
  chainedFutureResult.match(
      (value) => print(value), (error) => print(error)); // There is an error

  // 使用 orElse 处理 Future 错误
  final orElseFutureResult = ResultAsync.fromFuture(
          Future.error('error'), (error) => 'There is an $error')
      .orElse((error) => ResultAsync.fromSafeFuture(Future.value(10)));
  orElseFutureResult.match(
      (value) => print(value), (error) => print(error)); // 10

  // 使用 unwrapOr 处理 Future 结果
  final unwrapOrFutureResult =
      ResultAsync.fromSafeFuture(Future.value(10)).unwrapOr(0);
  unwrapOrFutureResult.then((value) => print(value)); // 10

  // 使用 unwrapOr 处理 Future 错误
  final unwrapOrFutureErrorResult = ResultAsync.fromFuture(
      Future.error('error'), (error) => 'There is an $error').unwrapOr(0);
  unwrapOrFutureErrorResult.then((value) => print(value)); // 0
}