Flutter数据类型处理插件dart_result_type的使用

Flutter数据类型处理插件dart_result_type的使用

dart_result_type 是一个用于表示成功或错误值的类型安全方式，模仿了 Rust 的 Result 类型。它可以帮助开发者更好地处理异步操作中的成功或失败情况。

构建状态

在 Rust 中，调用 unwrap() 方法在 Err 类型上调用会导致恐慌。在这个包中，等效的操作会抛出一个 Exception。因此，建议的做法是进行模式匹配（感谢 Dart 3），或者在调用 unwrap() 之前检查 .isOk 或 .isErr。

Future<void> doSomething() async {
    final result: Result<Json, ApiError> = await apiCall();
    switch (result) {
        case Ok(value: final value):
            showSuccessDialog(value.content);
        case Err(value: final value):
            showFailureDialog(value);
    };
}

选项

由于 Dart 已经支持空安全，所以没有必要使用 Option<T> 来表示可选值。相反，可以使用 .unwrapOrNull() 和 .unwrapErrOrNull 方法来返回 Result 的底层值，如果没有值则返回 null。

Future<void> doSomething() async {
    final result: Result<Json, ApiError> = await apiCall();
    final content = result.unwrapOrNull()?.content;
    if (content != null) showSuccessDialog(content);
}

示例

以下是一个完整的示例，展示了如何使用 dart_result_type 包来处理游戏结果。

import 'dart:math';

import 'package:dart_result_type/dart_result_type.dart';

// 定义游戏状态枚举
enum GameState {
  win,
  lose;

  [@override](/user/override)
  String toString() {
    return switch (this) {
      GameState.win => 'You win',
      GameState.lose => 'You lose'
    };
  }
}

// 定义游戏错误枚举
enum GameError { unlucky, veryUnlucky }

// 定义侮辱性错误枚举
enum InsultingError { noob, youAbsolutelySuck }

// 获取随机游戏结果
Result<int, GameError> getResult() {
  final rand = Random();
  final randValue = rand.nextInt(10);

  // 使用 Ok 或 Err 表示成功或错误
  return switch (randValue) {
    > 5 => Ok(randValue),
    _ => Err(rand.nextBool() ? GameError.unlucky : GameError.veryUnlucky)
  };
}

// 模拟多次游戏
Iterable<Result<GameState, InsultingError>> playGame(int iterations) {
  return Iterable.generate(
    iterations,
    (_) => getResult()
        // 将成功值映射为实际的游戏状态
        .map((element) => element > 8 ? GameState.win : GameState.lose)
        // 将错误值映射为侮辱性错误
        .mapErr((element) => switch (element) {
          GameError.unlucky => InsultingError.noob,
          GameError.veryUnlucky => InsultingError.youAbsolutelySuck
        }),
  );
}

void main() {
  // 打印10次游戏的结果
  for (final game in playGame(10)) {
    print(game);
  }
}