Flutter枚举与密封类代码生成插件super_enum_sealed_generators的使用

在Flutter开发中，使用密封类（sealed classes）可以有效管理状态或结果类型。super_enum_sealed_generators 是一个强大的插件，用于自动生成密封类及其相关方法，帮助开发者更高效地处理复杂的状态逻辑。

特性

• 自动生成密封类及其子类。
• 提供静态工厂方法，例如 Result.success(data: 0)。
• 支持多种匹配方法，如 when, whenOrElse, whenOrDefault 等。
• 支持数据类的相等性和哈希值生成。
• 支持泛型和空安全。
• 自动生成 toString() 方法。
• 支持自动解包和继承。

使用步骤

1. 添加依赖

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  sealed_annotations: ^latest.version

dev_dependencies:
  sealed_generators: ^latest.version

运行 flutter pub get 安装依赖。

2. 创建密封类定义文件

创建一个文件（例如 weather.sealed.dart），并定义密封类结构：

import 'package:sealed_annotations/sealed_annotations.dart';

part 'weather.sealed.dart'; // 指定生成的目标文件

@Sealed()
abstract class _Weather {
  void sunny(); // 定义抽象方法
  void rainy(int rain); // 带参数的方法
  void windy(double velocity, double? angle); // 带可选参数的方法
}

3. 运行代码生成器

在项目根目录下运行以下命令生成密封类代码：

dart run build_runner build

4. 查看生成的代码

运行生成器后，会在指定的 part 文件中生成密封类及其子类代码。以下是生成代码的简化版本：

abstract class Weather {
  const factory Weather.sunny() = WeatherSunny;
  const factory Weather.rainy({required int rain}) = WeatherRainy;
  const factory Weather.windy({required double velocity, double? angle}) = WeatherWindy;

  bool isSunny() => this is WeatherSunny;
  bool isRainy() => this is WeatherRainy;
  bool isWindy() => this is WeatherWindy;

  R when<R extends Object?>({
    required R Function(WeatherSunny sunny) sunny,
    required R Function(WeatherRainy rainy) rainy,
    required R Function(WeatherWindy windy) windy,
  }) {
    if (this is WeatherSunny) {
      return sunny(this as WeatherSunny);
    } else if (this is WeatherRainy) {
      return rainy(this as WeatherRainy);
    } else if (this is WeatherWindy) {
      return windy(this as WeatherWindy);
    }
    throw Exception('Unhandled case');
  }

  // 其他方法类似 ...
}

class WeatherSunny extends Weather {
  @override
  String toString() => 'Weather.sunny()';
}

class WeatherRainy extends Weather {
  WeatherRainy({required this.rain});

  final int rain;

  @override
  String toString() => 'Weather.rainy(rain: $rain)';
}

class WeatherWindy extends Weather {
  WeatherWindy({required this.velocity, this.angle});

  final double velocity;
  final double? angle;

  @override
  String toString() => 'Weather.windy(velocity: $velocity, angle: $angle)';
}

5. 使用生成的密封类

在实际代码中，您可以使用生成的密封类来管理状态。以下是一个完整的示例：

文件 result.dart

import 'package:sealed_annotations/sealed_annotations.dart';

part 'result.sealed.dart';

@Sealed()
abstract class _Result<D extends Object> {
  void success(D data);
  void error(Object exception);
}

文件 weather.dart

import 'package:sealed_annotations/sealed_annotations.dart';

part 'weather.sealed.dart';

@Sealed()
abstract class _Weather {
  void sunny();
  void rainy(int rain);
  void windy(double velocity, double? angle);
}

文件 main.dart

import 'result.dart';
import 'weather.dart';

void main() {
  // 使用Weather密封类
  final a = Weather.sunny();
  final b = Weather.rainy(rain: 12);
  final c = Weather.windy(velocity: 1.5, angle: null);

  print(a); // 输出: Weather.sunny()
  print(b); // 输出: Weather.rainy(rain: 12)
  print(c); // 输出: Weather.windy(velocity: 1.5, angle: null)

  // 使用Result密封类
  final d = Result.success(data: 1);
  final e = Result.success(data: 5.6);
  final f = Result.error(exception: 'error');

  print(d); // 输出: Result.success(data: 1)
  print(e); // 输出: Result.success(data: 5.6)
  print(f); // 输出: Result.error(exception: error)
}