Flutter错误处理插件error_or的使用

Flutter错误处理插件error_or的使用

ErrorOr 是一个用于返回结果的类型，它可以包含一个值 T 或者一个错误 Object。这个插件提供了一种更简洁的方式来处理可能抛出异常的函数，避免了在每个地方都使用 try/catch 语句。

功能特性

• 替代异常处理：通过包装一个可能抛出异常的函数，将其转换为返回 ErrorOr 的函数，从而避免直接使用 try/catch。
• 明确的错误处理：可以更明确地定义一个可能返回错误的函数，而不需要每次都使用 try/catch。
• 支持异步和同步函数：ErrorOr 可以用于处理同步和异步函数。

API介绍

• 创建 ErrorOr 实例：可以通过 ErrorOr.value() 或 ErrorOr.error() 工厂构造函数来创建 ErrorOr 实例。
• 检查是否有错误或值：使用 hasError 和 hasValue 方法来检查 ErrorOr 中是否包含错误或值。如果在没有正确检查的情况下调用 error 或 value，会抛出 ErrorOrTypeError。
• 便捷的 wrap 方法：ErrorOr.wrap 方法会自动处理 try/catch 逻辑，并返回一个 FutureOr，因此可以用于同步和异步函数。

示例代码

以下是一个完整的示例，展示了如何在 Flutter 项目中使用 ErrorOr 插件进行错误处理。

import 'dart:async';
import 'dart:math';

import 'package:error_or/error_or.dart';

// 模拟一个可能抛出异常的同步函数
String maybeThrows() {
  if (Random().nextBool() == false) {
    throw Exception('Error');
  }
  return 'Success';
}

// 使用 ErrorOr 包装同步函数
ErrorOr<String> maybeErrorSync() {
  if (Random().nextBool() == false) {
    return ErrorOr.error(Exception('Error'));
  }
  return ErrorOr.value('Success');
}

// 模拟一个可能抛出异常的异步函数
final delay = Duration(milliseconds: 400);

Future<String> getValueOrThrows() async {
  await Future.delayed(delay);
  return maybeThrows();
}

// 使用 ErrorOr 包装异步函数
Future<ErrorOr<String>> getValueOrError() async {
  await Future.delayed(delay);
  return ErrorOr.wrap(maybeThrows);
}

// 使用 then 和 catchError 进行错误处理
Future<void> errorHandlingWithThenAndCatchError() async {
  print('* Error handling with then and catchError');
  final completer = Completer();
  getValueOrThrows().then((String value) {
    print(value);
  }).catchError((e) {
    print(e);
  }).whenComplete(() {
    print('');
    completer.complete();
  });
  return completer.future;
}

// 使用 await 和 try/catch 进行错误处理
Future<void> errorHandlingWithAwaitAndTryCatch() async {
  print('* Error handling with await and try/catch');
  try {
    final String value = await getValueOrThrows();
    print(value);
  } catch (e) {
    print(e);
  }
  print('');
}

// 使用 ErrorOr 进行错误处理（异步）
Future<void> errorHandlingWithErrorOr() async {
  print('* Error handling with ErrorOr');
  final ErrorOr<String> errorOr = await getValueOrError();
  if (errorOr.hasError) {
    print(errorOr.error); // 如果有错误，打印错误信息
  } else {
    print(errorOr.value); // 如果没有错误，打印返回的值
  }
  print('');
}

// 使用 ErrorOr 进行错误处理（同步）
void errorHandlingWithErrorOrSync() {
  print('* Error handling with ErrorOr sync');
  final ErrorOr<String> errorOr = maybeErrorSync();
  if (errorOr.hasError) {
    print(errorOr.error); // 如果有错误，打印错误信息
  } else {
    print(errorOr.value); // 如果没有错误，打印返回的值
  }
  print('');
}

// 演示 ErrorOrTypeError 的抛出
Future<void> errorHandlingWithErrorOrTypeError() async {
  print('* Error handling with ErrorOr throws ErrorOrTypeError');
  try {
    final ErrorOr<String> errorOr = await getValueOrError();
    print(errorOr.value); // 如果没有检查 hasError 直接调用 value，会抛出 ErrorOrTypeError
  } on ErrorOrTypeError catch (e) {
    print(e.message); // 打印 ErrorOrTypeError 的错误信息
  }
  print('');
}

void main() async {
  await errorHandlingWithThenAndCatchError();
  await errorHandlingWithAwaitAndTryCatch();
  await errorHandlingWithErrorOr();
  errorHandlingWithErrorOrSync();
  await errorHandlingWithErrorOrTypeError();
}