Flutter异常转换插件codenic_exception_converter的使用

Flutter异常转换插件codenic_exception_converter的使用

介绍

codenic_exception_converter 是一个实用工具，用于将异常转换为失败对象（Failure objects）。通过将异常转换为失败对象，程序可以以更通用的方式处理异常，而不是被特定技术或框架的具体细节所束缚。这使得编写代码更加便携和易于维护，因为它不依赖于任何特定技术的具体细节。

以下是关于如何使用 codenic_exception_converter 插件的完整示例 demo。

示例图片

完整示例 Demo

// ignore_for_file: avoid_print

import 'dart:io';

import 'package:codenic_exception_converter/codenic_exception_converter.dart';

Future<void> main() async {
  // To run, type `dart --enable-asserts example/main.dart`.

  await _observeWithDefaultConverters();
  print('');
  await _observeWithArgConverters();
  print('');
  await _observeNoExceptionConverters();
  print('');
  _convert();
}

/// 使用默认的异常转换器观察任务
Future<void> _observeWithDefaultConverters() async {
  // 创建一个异常转换器套件，可以将 `SocketException` 转换为 `NetworkFailure`
  final exceptionConverterSuite = ExceptionConverterSuite(
    defaultErrorConverters: [SocketExceptionConverter.new], // 设置默认的异常转换器
  );

  final result = await exceptionConverterSuite.observe<void>(
    messageLog: MessageLog(id: 'observe-with-default-converters'), // 日志ID
    printOutput: true, // 是否打印输出
    task: (messageLog) {
      // 模拟异常
      throw const SocketException('test');
    },
  );

  print('Observe (with default converters): $result'); // 打印结果
}

/// 使用参数提供的异常转换器观察任务
Future<void> _observeWithArgConverters() async {
  final exceptionConverterSuite = ExceptionConverterSuite();

  final result = await exceptionConverterSuite.observe<void>(
    messageLog: MessageLog(id: 'observe-with-argument-converters'), // 日志ID
    errorConverters: [const SocketExceptionConverter()], // 提供异常转换器作为参数
    printOutput: true, // 是否打印输出
    task: (messageLog) {
      // 模拟异常
      throw const SocketException('test');
    },
  );

  print('Observe (with argument exception converters): $result'); // 打印结果
}

/// 不使用异常转换器观察任务
Future<void> _observeNoExceptionConverters() async {
  final exceptionConverterSuite = ExceptionConverterSuite();

  final result = await exceptionConverterSuite.observe<void>(
    messageLog: MessageLog(id: 'observe-with-no-exception-converters'), // 日志ID
    task: (messageLog) {
      try {
        // 模拟异常
        throw const SocketException('test');
      } on SocketException {
        return const Left(NetworkFailure()); // 返回左值，表示失败
      }
    },
  );

  print('Observe (no exception converter): $result'); // 打印结果
}

/// 直接转换异常
void _convert() {
  final exceptionConverterSuite = ExceptionConverterSuite(
    defaultErrorConverters: [SocketExceptionConverter.new], // 设置默认的异常转换器
  );

  final result = exceptionConverterSuite.convert(
    error: const SocketException('test'), // 异常对象
    errorConverters: [const SocketExceptionConverter()], // 提供异常转换器
  );

  print('Convert result: $result'); // 打印结果
}

/// 网络失败类，继承自 Failure
class NetworkFailure extends Failure {
  const NetworkFailure({super.message = 'A network failure occurred'}); // 默认消息
}

/// 自定义异常转换器，将 `SocketException` 转换为 `NetworkFailure`
final class SocketExceptionConverter<T> extends ExceptionConverter<SocketException, T> {
  const SocketExceptionConverter();

  [@override](/user/override)
  Failure convert(SocketException exception) => const NetworkFailure(); // 将异常转换为失败对象

  [@override](/user/override)
  void logError(
    SocketException exception,
    StackTrace stackTrace,
    CodenicLogger logger,
    MessageLog messageLog,
  ) =>
      logger.error(messageLog, error: exception, stackTrace: stackTrace); // 记录错误日志
}