Flutter插件eitherx的介绍与使用

Flutter插件eitherx的介绍与使用

Either 是 Dart 中的一个通用类，表示两种可能类型之一的值：L 或 R。当你希望返回一个既可以是类型 L 也可以是类型 R 的值时，这个类非常有用，但不能同时是两者。

这个类受到函数编程中 Either 数据类型的启发，并提供了一种更简洁和表达式的方式来处理错误和异常。

安装

要在您的 Flutter 或 Dart 项目中使用 Either，请按照以下步骤操作：

1. 将包添加到 pubspec.yaml 文件中：

dependencies:
  either: ^1.0.4

1. 在终端中运行 flutter pub get 来安装该包。

使用

Either

要创建 Either 的实例，可以使用 left 或 right 方法。left 方法接受类型 L 的值作为参数，并返回 L 设置为提供的值且 R 设置为 null 的 Either 实例。right 方法接受类型 R 的值作为参数，并返回 R 设置为提供的值且 L 设置为 null 的 Either 实例。

// 创建一个包含 String 类型的左值
final myEither = left<String, int>('hello');

// 创建一个包含 int 类型的右值
final myOtherEither = right<String, int>(42);

Either<String, int> foo() {
  return left('hello'); // 返回左值
}

Either<String, int> bar() {
  return right(42); // 返回右值
}

然后，您可以使用 fold 方法来获取 either 的 left 或 right 属性的值，具体取决于哪个属性被设置。

final myEither = right<String, int>(45);

// 使用 fold 方法处理 Either 值
final String result = myEither.fold(
  (error) => 'Error: $error', // 处理左值
  (value) => 'Value: $value', // 处理右值
);

print(result); // 输出: Value: 45

您还可以使用 leftOrNull 和 rightOrNull 方法来获取 left 或 right 属性的值，但如果相应的属性未设置，则返回 null。

final either1 = left<int, String>(42);
final either2 = right<int, String>('hello');
print(either1.leftOrNull()); // 输出: 42
print(either2.leftOrNull()); // 输出: null

Unit

Unit 类表示 Dart 中的 void 类型，用于指示函数不返回值。虽然 Dart 没有单独的 void 类型，但 Unit 提供了一种将 void 表示为值的方法。这在定义采用 void 类型参数的泛型函数或类时特别有用。您可以将 Unit 与 Either 类结合使用，以处理函数可能返回值或失败并返回错误的情况。

import 'package:eitherx/eitherx.dart';

// 定义一个模拟 API 调用并返回 Either 的函数
Either<String, Unit> fetchData() {
  // 模拟成功的 API 调用
  int statusCode = 200;

  if (statusCode == 200) {
    // 如果状态码为 200，返回 Unit 表示成功
    return right(unit);
  } else {
    // 否则，返回失败消息
    return left('Error: Failed to fetch data');
  }
}

void main() {
  // 调用 fetchData 函数并处理 Either 结果
  fetchData().fold(
    (failure) => print(failure), // 处理左值（错误）
    (unit) => print('Data fetched successfully'), // 处理右值（成功）
  );
}

示例 Demo

以下是完整的示例代码，展示如何在 Flutter 应用程序中使用 Either：

import 'package:flutter/material.dart';
import 'package:eitherx/eitherx.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: EitherExample(),
    );
  }
}

class EitherExample extends StatefulWidget {
  [@override](/user/override)
  _EitherExampleState createState() => _EitherExampleState();
}

class _EitherExampleState extends State<EitherExample> {
  String _result = '';

  void _fetchData() {
    final myEither = right<String, int>(45);

    // 使用 fold 方法处理 Either 值
    final String result = myEither.fold(
      (error) => 'Error: $error',
      (value) => 'Value: $value',
    );

    setState(() {
      _result = result;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Either Example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'Result:',
            ),
            Text(
              '$_result',
              style: Theme.of(context).textTheme.headline4,
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: _fetchData,
              child: Text('Fetch Data'),
            ),
          ],
        ),
      ),
    );
  }
}