Flutter枚举映射插件enum_map的使用

enum_map 是一个用于 Dart 的插件，它允许你创建一个在编译时检查每个 enum 常量是否都有对应的条目的 Map。这个插件特别适用于需要确保所有枚举值都被正确处理的情况。

概述

假设我们有一个简单的枚举：

enum Fruit { apple, orange, banana }

通过使用 enum_map 插件，可以生成如下类：

class FruitMap<V> extends EnumMap<Fruit, V> { // implements Map<Fruit, V>
  FruitMap({
    required this.apple,
    required this.orange,
    required this.banana,
  });
  // ...
}

这意味着只有当你在构造函数中设置所有值时，应用才会构建成功。然后你可以像操作普通 Map 一样操作这个对象。

使用方法

添加依赖

首先，在你的 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  enum_map: ^0.1.0

dev_dependencies:
  build_runner:
  enum_map_gen: ^0.1.0

运行 dart pub get 来安装这些依赖。

配置和生成代码

假设你的枚举文件名为 fruit.dart，你需要做以下几步：

1. 添加 part 'fruit.g.dart'; 指令。
2. 添加 @enumMap 或 @unmodifiableEnumMap 注解，或者同时添加这两个注解。

示例如下：

import 'package:enum_map/enum_map.dart';

part 'fruit.g.dart';

@enumMap
@unmodifiableEnumMap
enum Fruit { apple, orange, banana }

然后在项目根目录运行以下命令来生成代码：

$ dart run build_runner build

这会在与枚举文件相同的目录下生成一个新的文件。如果原来的文件是 lib/fruit.dart，那么生成的文件将是 lib/fruit.g.dart。

使用生成的类

以下是使用生成类的示例代码：

import 'fruit.dart';

void main() {
  final modifiableMap = FruitMap<String>(apple: 'a', orange: 'o', banana: 'b');
  print(modifiableMap);  // prints: {Fruit.apple: a, Fruit.orange: o, Fruit.banana: b}
  print(modifiableMap[Fruit.apple]);      // prints: a
  print(modifiableMap.get(Fruit.apple));  // prints: a

  const unmodifiableMap = UnmodifiableFruitMap<String>(apple: 'a', orange: 'o', banana: 'b');
  print(unmodifiableMap);  // prints: {Fruit.apple: a, Fruit.orange: o, Fruit.banana: b}
  print(unmodifiableMap[Fruit.apple]);      // prints: a
  print(unmodifiableMap.get(Fruit.apple));  // prints: a
}

生成的类包含了 Map 接口的所有公共成员，并且还提供了非空的 get 方法来确保返回指定类型的值。

不要将生成的文件纳入版本控制

你应该避免将生成的文件纳入版本控制，而应该在每次检出后重新生成它们。为此，可以在你的构建管道中添加上述命令，以便在 dart compile 或 flutter build 之前执行。

为了避免将生成的文件纳入版本控制，请在 .gitignore 文件中添加以下行：

*.g.dart

此外，get() 方法具有安全性，它使用 switch (key) 来返回结果。如果你向枚举中添加新值，生成的文件将会导致构建失败，提醒你重新生成文件。

示例 Demo

下面是一个完整的示例 demo：

// lib/main.dart
import 'package:enum_map/enum_map.dart';

part 'main.g.dart';

@enumMap
@unmodifiableEnumMap
enum Fruit {
  apple,
  orange,
  banana,
}

void main() {
  final modifiableMap = FruitMap<String>(apple: 'a', orange: 'o', banana: 'b');
  print(modifiableMap);  // prints: {Fruit.apple: a, Fruit.orange: o, Fruit.banana: b}
  print(modifiableMap[Fruit.apple]);      // prints: a
  print(modifiableMap.get(Fruit.apple));  // prints: a

  const unmodifiableMap = UnmodifiableFruitMap<String>(apple: 'a', orange: 'o', banana: 'b');
  print(unmodifiableMap);  // prints: {Fruit.apple: a, Fruit.orange: o, Fruit.banana: b}
  print(unmodifiableMap[Fruit.apple]);      // prints: a
  print(unmodifiableMap.get(Fruit.apple));  // prints: a
}

请按照前面描述的步骤配置和生成代码，然后运行此示例以查看效果。希望这能帮助你更好地理解和使用 enum_map 插件！