Flutter枚举生成插件 mobkit_enum_generator 的使用

mobkit_enum_generator 是一个Dart构建系统插件，用于处理枚举的生成。它可以帮助你简化与枚举相关的代码编写过程。下面将详细介绍如何使用这个插件。

设置

首先，你需要在项目中添加 mobkit_enum_generator 作为开发依赖：

flutter pub add -d mobkit_enum_generator

确保你的项目配置正确，以便支持代码生成。通常需要在项目的 pubspec.yaml 文件中添加如下内容：

dependencies:
  # 其他依赖项...

dev_dependencies:
  build_runner: ^2.0.0
  mobkit_enum_generator: ^最新版本号

记得用实际的最新版本号替换 ^最新版本号。

示例

假设我们有一个名为 example.dart 的库文件，并且定义了一个带有 EnumSerializable 注解的枚举示例：

import 'package:mobkit_enum_generator/annotations.dart';
part 'example.g.dart';

[@EnumSerializable](/user/EnumSerializable)(String, null)
enum PersonStr {
  [@JsonValue](/user/JsonValue)('John')
  name,
  [@JsonValue](/user/JsonValue)('66')
  number,
}

[@EnumSerializable](/user/EnumSerializable)(int, ["name description", "number description"])
enum PersonInt {
  [@JsonValue](/user/JsonValue)(1)
  name,
  [@JsonValue](/user/JsonValue)(66)
  number,
}

运行代码生成器后，会自动生成相应的 example.g.dart 文件：

part of 'example.dart';

const Map<PersonStr, String> personStrEnumMap = {
  PersonStr.name: 'John',
  PersonStr.number: '66',
};

extension PersonStrExtension on PersonStr {
  String toValue() {
    return personStrEnumMap[this]!;
  }
}

const Map<PersonInt, int> personIntEnumMap = {
  PersonInt.name: 1,
  PersonInt.number: 66,
};

extension PersonIntExtension on PersonInt {
  int toValue() {
    return personIntEnumMap[this]!;
  }
}

extension PersonIntDescriptionExtension on PersonInt {
  String toDescription() {
    switch (this) {
      case PersonInt.name:
        return 'name description';
      case PersonInt.number:
        return 'number description';
      default:
        return '';
    }
  }
}

运行代码生成器

在添加了注解之后，你需要运行代码生成器来生成缺失的 .g.dart 文件。对于Flutter项目，请在项目目录下执行以下命令：

flutter pub run build_runner build

这将会根据你的枚举定义生成相应的扩展方法和映射表。

自定义注解

你可以通过 JsonValue 和 EnumValue 注解为枚举值添加额外的信息。例如：

import 'package:mobkit_enum_generator/annotations.dart';
part 'example.g.dart';

[@EnumSerializable](/user/EnumSerializable)(String, null)
enum Person {
  [@EnumValue](/user/EnumValue)('John')
  name,
  [@JsonValue](/user/JsonValue)('66')
  number,
}