Flutter增强枚举处理插件enhanced_enum的使用

enhanced_enum 是一个用于生成枚举扩展和从字符串生成枚举的生成器。它可以帮助你在 Flutter 项目中更方便地处理枚举类型。

安装与构建

1. 将 enhanced_enum 包添加到你的项目中，并将 enhanced_enum_generator 包作为开发依赖添加：

   pub add enhanced_enum && pub add enhanced_enum_generator --dev
   

2. 在你想要使用 enhanced_enum 的文件中引入包：

   import 'package:enhanced_enum/enhanced_enum.dart';
   

3. 添加生成文件的部分声明：

   part 'YOURFILE.g.dart';
   

   例如：

   part 'main.g.dart';
   

4. 在你的枚举上添加 @enhancedEnum 装饰器，或者使用 [@EnhancedEnum](/user/EnhancedEnum)() 来设置更多选项：

   [@EnhancedEnum](/user/EnhancedEnum)(strict: false, namingConvention: EnhancedEnumNamingConvention.snakeCase)
   enum Animals { fox, rabbit, redPanda }
   

5. 使用 build_runner 构建增强的枚举：

   pub run build_runner build
   

使用示例

定义枚举

import 'package:enhanced_enum/enhanced_enum.dart';

part 'main.g.dart';

[@EnhancedEnum](/user/EnhancedEnum)(strict: false, namingConvention: EnhancedEnumNamingConvention.snakeCase)
enum Animals { fox, rabbit, redPanda }

[@EnhancedEnum](/user/EnhancedEnum)()
enum AnimalParts {
  @EnhancedEnumValue(name: 'cutsie paw')
  paw,
  @EnhancedEnumValue(name: 'curly tail')
  tail,
  @EnhancedEnumValue(name: 'boopable snoot')
  snoot,
}

[@EnhancedEnum](/user/EnhancedEnum)(namingConvention: EnhancedEnumNamingConvention.snakeCase)
enum AnimalColours {
  redYellow, greenBlack,
}

[@EnhancedEnum](/user/EnhancedEnum)(prefixes: ['water-', 'fire_'])
enum AnimalTypes {
  @EnhancedEnumValue(name: 'bird')
  bird
}

使用枚举

void main() {
  print(Animals.values.fromString('fox')); // 输出: Animals.fox
  print(Animals.values.fromString('red_panda')); // 输出: Animals.redPanda
  print(Animals.values.fromString('redPanda')); // 输出: Animals.redPanda
  print(Animals.values.fromString('Animals.rabbit')); // 输出: Animals.rabbit
  print(AnimalParts.values.fromString('boopable snoot')); // 输出: AnimalParts.snoot
  print(AnimalColours.values.fromString('red_yellow')); // 输出: AnimalColours.redYellow
  print(AnimalColours.values.fromString('redYellow')); // 输出: null (因为默认是严格模式)
  print(AnimalTypes.values.fromString('water-bird')); // 输出: AnimalTypes.bird
  print(AnimalTypes.values.fromString('fire_bird')); // 输出: AnimalTypes.bird

  print(Animals.redPanda.name); // 输出: red_panda
  print(AnimalParts.paw.name); // 输出: cutsie paw

  print(Animals.fox.isFox); // 输出: true
  print(Animals.fox.isRedPadna); // 输出: false

  print(Animals.fox.when(
    fox: () => 1,
    rabbit: () => 2,
    redPanda: () => 3,
  )); // 输出: 1

  print(Animals.fox.maybeWhen(
    rabbit: () => 2,
    orElse: () => 9001,
  )); // 输出: 9001

  print(Animals.rabbit.maybeWhen(
    rabbit: () => 2,
    orElse: () => 9001,
  )); // 输出: 2
}

枚举值的命名

如果你有一个名为 MyEnum 的枚举，那么 MyEnum.values.fromString() 会根据值的名称生成相应的枚举。同样，MyEnum.someVal.name 会返回枚举值的名称。

有时，代码中的枚举名称与你希望的字符串表示形式不一致。例如，你在代码中使用 camelCase，但枚举代表的值在 JSON 中使用 snake_case。为此，EnhancedEnum() 构造函数接受一个 namingConvention 参数，可以根据命名约定命名枚举。可用的命名约定有：

• EnhancedEnumNamingConvention.original：源代码中的枚举值名称不变
• EnhancedEnumNamingConvention.camelCase：camelCase 命名约定
• EnhancedEnumNamingConvention.upperCamelCase：UpperCamelCase 命名约定（与 camelCase 相同，只是首字符大写）
• EnhancedEnumNamingConvention.snakeCase：snake_case 命名约定
• EnhancedEnumNamingConvention.screamingSnakeCase：SCREAMING_SNAKE_CASE 命名约定（与 snake_case 相同，只是所有字符大写）

有时你的枚举值名称过于复杂，无法很好地映射到这些命名约定。为此，你可以使用 EnhancedEnumValue() 注解为特定值提供名称覆盖。例如：

[@EnhancedEnum](/user/EnhancedEnum)()
enum AnimalParts {
  @EnhancedEnumValue(name: 'cutsie paw')
  paw,
  @EnhancedEnumValue(name: 'curly tail')
  tail,
  @EnhancedEnumValue(name: 'boopable snoot')
  snoot,
}

严格枚举

如果枚举设置为严格模式（strict: true），则在从字符串转换为枚举值时，必须使用确切的枚举名称字符串表示形式。例如：

[@EnhancedEnum](/user/EnhancedEnum)(strict: true)
enum AnimalColours {
  redYellow, greenBlack,
}

在这种情况下，AnimalColours.values.fromString('redYellow') 将返回 null，因为严格模式要求精确匹配。