Flutter枚举管理插件good_enums的使用

Flutter枚举管理插件good_enums的使用

good_enums 是一个用于简化枚举使用的代码生成器。它通过注解库来生成额外的方法，从而使得枚举更加易于管理和使用。

安装

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

dependencies:
  flutter:
    sdk: flutter
  good_enums_annotations:

dev_dependencies:
  build_runner:
  good_enums:

然后运行 flutter pub get 来安装这些依赖项。

示例

首先，你需要导入 good_enums_annotations 并创建一个带有注解的枚举类。接着，使用 build_runner 生成必要的代码扩展。

1. 创建枚举类

import 'package:good_enums_annotations/good_enums_annotations.dart';
part 'environment.g.dart';  // 这个文件将由代码生成器自动生成

// 使用 [@goodEnum](/user/goodEnum) 注解来标记这个枚举类
[@goodEnum](/user/goodEnum)
enum Environment {
  dev,
  prod,
  stage;
}

2. 生成代码

运行以下命令来生成代码扩展：

flutter pub run build_runner build

这将在 environment.g.dart 中生成一些扩展方法。

生成的方法

对于每个枚举字段，都会生成以下方法：

• isField 方法（例如 isDev），用于检查当前枚举值是否等于特定的枚举字段。
• ifIs 方法，根据当前枚举值执行不同的回调函数。
• maybeIfIs 方法，具有可选的回调函数和默认情况。

isField 方法

if (environment.isDev()) {
  // do something
  return;
}
// else

如果设置了 valueCheckAsGetter 为 true，你可以直接使用属性访问的方式：

if (environment.isDev) {
  // do something
  return;
}
// else

ifIs 方法

return environment.ifIs(
  dev: () => Text("IsDev"),
  prod: () => Text("IsProd"),
  stage: () => Text("IsStage"),
);

maybeIfIs 方法

return environment.maybeIfIs(
  dev: () => Text("IsDev"),
  orElse: () => Text("IsElse"),
);

生成的代码

extension GoodEnvironment on Environment {
  bool isDev() {
    return this == Environment.dev;
  }

  bool isProd() {
    return this == Environment.prod;
  }

  bool isStage() {
    return this == Environment.stage;
  }

  TResult ifIs<TResult>({
    required TResult Function() dev,
    required TResult Function() prod,
    required TResult Function() stage,
  }) {
    switch (this) {
      case Environment.dev:
        return dev();
      case Environment.prod:
        return prod();
      case Environment.stage:
        return stage();
    }
  }

  TResult maybeIfIs<TResult>({
    TResult Function()? dev,
    TResult Function()? prod,
    TResult Function()? stage,
    required TResult Function() orElse,
  }) {
    switch (this) {
      case Environment.dev:
        if (dev != null) return dev();
        break;
      case Environment.prod:
        if (prod != null) return prod();
        break;
      case Environment.stage:
        if (stage != null) return stage();
        break;
    }
    return orElse();
  }
}

配置

你可以通过传递参数来自定义 @GoodEnum 的行为：

@GoodEnum(
  // 禁用/启用 isIs 方法，默认为 true
  enableIf: true,
  // 禁用/启用 maybeIfIs 方法，默认为 true
  enableMaybeIf: true,
  // 自定义前缀方法，默认为 `is`
  prefix: 'is',
  // 设置 valueCheckAsGetter 为 false
  valueCheckAsGetter: false,
)

完整示例

下面是一个完整的示例代码，展示了如何使用 good_enums 插件：

import 'package:flutter/material.dart';
import 'package:good_enums_annotations/good_enums_annotations.dart';
part 'environment.g.dart';

// 使用 [@goodEnum](/user/goodEnum) 注解来标记这个枚举类
[@goodEnum](/user/goodEnum)
enum Environment {
  dev,
  prod,
  stage;
}

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Good Enums Example')),
        body: Center(
          child: Text(
            Environment.dev.maybeIfIs(
              dev: () => "IsDev",
              orElse: () => "IsElse",
            ),
          ),
        ),
      ),
    );
  }
}