Flutter功能未定义插件okay的使用

Flutter功能未定义插件okay的使用

okay 是一个用于 Dart 的类型化错误处理库。它提供了一个 Result<T, E> 类型，用于返回和传播错误。这个类型有两个变体：Ok(T) 表示成功并包含一个值，而 Err(E) 表示错误并包含一个错误值。

以下是该库的一些关键功能和使用方法：

安装

在您的 pubspec.yaml 文件的 dependencies: 部分中添加以下行：

dependencies:
  okay: <latest_version>

请将 <latest_version> 替换为最新的版本号。

基本用法

下面是一个基本的使用示例：

import 'package:okay/okay.dart';

class FallibleOpFailure {}

// 模拟一个可能失败的操作
Result<String, FallibleOpFailure> fallibleOp() {
  if (true) { // 这里可以替换为实际的条件判断
    return Ok('Very good string');
  } else {
    return Err(FallibleOpFailure());
  }
}

void main() {
  final result = fallibleOp();

  // 使用 switch 表达式提取值
  final goodString = switch(result) {
    Ok(v: final value) => value,
    Err(e: final error) => error,
  };

  // 或者使用 when 方法
  final goodString2 = result.when(
    ok: (value) {
      print('Success with value: $value');
      return value;
    },
    err: (error) {
      print('Failure with Error: $error');
      return 'Fallback string';
    },
  );

  useString(goodString);
  useString(goodString2);
}

void useString(String value) {
  // 使用字符串的逻辑
}

提取包含的值

• expect: 如果是 Ok，返回包含的值；如果是 Err，抛出带有提供的消息的异常。
• unwrap: 如果是 Ok，返回包含的值；如果是 Err，抛出异常。
• unwrapOr: 如果是 Ok，返回包含的值；如果是 Err，返回提供的回退值。
• unwrapOrElse: 如果是 Ok，返回包含的值；如果是 Err，返回提供的函数的结果（函数接收包含的错误类型并返回一个值类型）。

示例代码

以下是一个更复杂的示例，展示了如何使用 okay 库进行 HTTP 请求并处理可能的错误：

// ignore_for_file: avoid_print

import 'dart:convert' as convert;

import 'package:http/http.dart' as http;
import 'package:okay/okay.dart';

void main() async {
  final result = await getBooks();

  // 处理错误情况
  final books = result.inspectErr((ConnectionError error) {
    print('Http request failed with `ConnectionError` $error');
    switch (error) {
      case ConnectionError.noInternet:
        // 显示没有互联网连接的提示
        break;
      case ConnectionError.internalServerError:
        // 显示服务器内部错误的提示并记录到崩溃分析工具
        break;
      case ConnectionError.badData:
        // 显示数据格式错误的提示并记录到崩溃分析工具
        break;
      case ConnectionError.badRequest:
        // 显示请求错误的提示并记录到崩溃分析工具
        break;
      case ConnectionError.forbidden:
        // 显示禁止访问的提示
        break;
      case ConnectionError.notFound:
        // 显示资源未找到的提示并记录到崩溃分析工具
        break;
      case ConnectionError.notImplemented:
        // 显示未实现的功能提示并记录到崩溃分析工具
        break;
      case ConnectionError.otherError:
        // 显示其他错误的提示
    }
  }).unwrapOr({});

  // 使用 `Map<String, dynamic>`
  useBooks(books);
}

/// 使用 Google Books API 搜索关于 HTTP 的书籍。
/// 如果成功，返回一个包含书籍信息的 `Ok` 结果；
/// 如果失败，返回一个表示 HTTP 状态码的 `Err` 结果。
Future<Result<Map<String, dynamic>, ConnectionError>> getBooks() async {
  final url =
      Uri.https('www.googleapis.com', '/books/v1/volumes', {'q': '{http}'});

  // 检查是否有互联网连接
  if (!isThereInternetConnection()) {
    return const Err(ConnectionError.noInternet);
  }

  // 等待 HTTP GET 响应，然后解码 JSON 格式的响应。
  final response = await http.get(url);

  if (response.statusCode == 200) {
    try {
      final jsonResponse =
          convert.jsonDecode(response.body) as Map<String, dynamic>;
      return Ok(jsonResponse);
    } catch (_) {
      return const Err(ConnectionError.badData);
    }
  }

  switch (response.statusCode) {
    case 401:
      return const Err(ConnectionError.badRequest);
    case 403:
      return const Err(ConnectionError.forbidden);
    case 404:
      return const Err(ConnectionError.notFound);
    case 500:
      return const Err(ConnectionError.internalServerError);
    case 501:
      return const Err(ConnectionError.notImplemented);
    default:
      return const Err(ConnectionError.otherError);
  }
}

/// 检查是否有互联网连接。
bool isThereInternetConnection() {
  return true; // 在实际应用中需要实现具体的检查逻辑
}

void useBooks(Map<String, dynamic> books) {}

enum ConnectionError {
  noInternet,
  internalServerError,
  badData,
  badRequest,
  forbidden,
  notFound,
  notImplemented,
  otherError,
}