Flutter枚举扩展注解插件enum_extendable_annotation的使用

Flutter枚举扩展注解插件enum_extendable_annotation的使用

注解介绍

enum_extendable_annotation 是一个用于生成扩展方法的注解包。它与 enum_extendable_generator 一起使用以生成所需的扩展方法。

主要注解

  • ExtendableEnum

    该注解必须应用于枚举类型上。

    [@ExtendableEnum](/user/ExtendableEnum)()
enum MyEnum {
  first,
  second,
  third;
}

  • ExtendableEnumPodo

    该注解必须应用于枚举对应的PODO类上。

    [@ExtendableEnumPodo](/user/ExtendableEnumPodo)()
class MyEnumPodo {
  final int value;

  MyEnumPodo(this.value);

  static MyEnumPodo from(MyEnum myEnum) {
    switch (myEnum) {
      case MyEnum.first:
        return MyEnumPodo(1);
      case MyEnum.second:
        return MyEnumPodo(2);
      case MyEnum.third:
        return MyEnumPodo(3);
    }
  }

  MyEnum toMyEnum() {
    switch (value) {
      case 1:
        return MyEnum.first;
      case 2:
        return MyEnum.second;
      case 3:
        return MyEnum.third;
    }
  }
}

  • ExtendableEnumValues

    该注解应用于包含枚举值的映射字段。如果此字段名为 values，则可以省略此注解。

    [@ExtendableEnumValues](/user/ExtendableEnumValues)(checkCompleteness: true)
Map<MyEnum, MyEnumPodo> values = {
  MyEnum.first: MyEnumPodo(1),
  MyEnum.second: MyEnumPodo(2),
  MyEnum.third: MyEnumPodo(3),
};

  • ExtendableEnumField

    该注解应用于PODO类的任何字段，用于确定扩展方法的命名约定。默认情况下，它将为所有字段生成扩展方法。

    class MyClass {
  [@ExtendableEnumField](/user/ExtendableEnumField)(enumExtension: false, classExtension: true)
  MyEnumPodo myEnumPodo;

  // 构造函数等...
}

完整示例Demo

以下是一个完整的示例，展示如何使用这些注解来生成扩展方法。

import 'package:enum_extendable_annotation/enum_extendable_annotation.dart';
import 'package:enum_extendable_generator/enum_extendable_generator.dart';

// 使用ExtendableEnum注解标记枚举类型
[@ExtendableEnum](/user/ExtendableEnum)()
enum MyEnum {
  first,
  second,
  third;
}

// 使用ExtendableEnumPodo注解标记PODO类
[@ExtendableEnumPodo](/user/ExtendableEnumPodo)()
class MyEnumPodo {
  final int value;

  MyEnumPodo(this.value);

  static MyEnumPodo from(MyEnum myEnum) {
    switch (myEnum) {
      case MyEnum.first:
        return MyEnumPodo(1);
      case MyEnum.second:
        return MyEnumPodo(2);
      case MyEnum.third:
        return MyEnumPodo(3);
    }
  }

  MyEnum toMyEnum() {
    switch (value) {
      case 1:
        return MyEnum.first;
      case 2:
        return MyEnum.second;
      case 3:
        return MyEnum.third;
    }
  }
}

// 使用ExtendableEnumValues注解标记包含枚举值的映射字段
[@ExtendableEnumValues](/user/ExtendableEnumValues)(checkCompleteness: true)
Map<MyEnum, MyEnumPodo> values = {
  MyEnum.first: MyEnumPodo(1),
  MyEnum.second: MyEnumPodo(2),
  MyEnum.third: MyEnumPodo(3),
};

// 使用ExtendableEnumField注解标记PODO类的字段
class MyClass {
  [@ExtendableEnumField](/user/ExtendableEnumField)(enumExtension: false, classExtension: true)
  MyEnumPodo myEnumPodo;

  MyClass(this.myEnumPodo);
}

void main() {
  print(values[MyEnum.first]); // 输出 MyEnumPodo(1)
  print(values[MyEnum.second].toMyEnum()); // 输出 MyEnum.second
}

更多关于Flutter枚举扩展注解插件enum_extendable_annotation的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter枚举扩展注解插件enum_extendable_annotation的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是一个关于如何使用 enum_extendable_annotation 插件的示例。enum_extendable_annotation 插件允许你在 Flutter 中扩展枚举类型，这在某些情况下非常有用，比如当你需要在枚举中添加额外的元数据时。

首先，确保你已经在 pubspec.yaml 文件中添加了 enum_extendable_annotation 依赖：

dependencies:
  flutter:
    sdk: flutter
  enum_extendable_annotation: ^最新版本号

然后，运行 flutter pub get 来获取依赖。

步骤 1: 定义枚举并使用注解

创建一个枚举并使用 @ExtendableEnum() 注解。这个注解会告诉编译器这个枚举是可以被扩展的。

import 'package:enum_extendable_annotation/enum_extendable_annotation.dart';

part 'my_enum_extension.dart'; // 声明扩展部分

@ExtendableEnum()
enum MyEnum {
  value1,
  value2,
}

步骤 2: 创建扩展文件

接下来，创建一个与枚举定义文件同名的 Dart 文件，但后缀为 _extension。在这个文件中，你可以定义枚举的扩展。

my_enum_extension.dart:

import 'my_enum.dart';
import 'package:enum_to_string/enum_to_string.dart'; // 可选，用于方便枚举到字符串的转换

part of 'my_enum.dart';

@EnumExtension()
extension MyEnumExtension on MyEnum {
  String get description {
    switch (this) {
      case MyEnum.value1:
        return 'Description for value1';
      case MyEnum.value2:
        return 'Description for value2';
      default:
        throw UnsupportedError('Unknown value: $this');
    }
  }

  // 你可以添加更多的扩展方法或属性
}

步骤 3: 使用扩展

现在你可以在你的应用中使用这个扩展了。

void main() {
  print(MyEnum.value1.description); // 输出: Description for value1
  print(MyEnum.value2.description); // 输出: Description for value2
}

完整示例

my_enum.dart

import 'package:enum_extendable_annotation/enum_extendable_annotation.dart';

part 'my_enum_extension.dart';

@ExtendableEnum()
enum MyEnum {
  value1,
  value2,
}

my_enum_extension.dart

import 'my_enum.dart';
import 'package:enum_to_string/enum_to_string.dart'; // 可选

part of 'my_enum.dart';

@EnumExtension()
extension MyEnumExtension on MyEnum {
  String get description {
    switch (this) {
      case MyEnum.value1:
        return 'Description for value1';
      case MyEnum.value2:
        return 'Description for value2';
      default:
        throw UnsupportedError('Unknown value: $this');
    }
  }
}

main.dart

import 'my_enum.dart';

void main() {
  print(MyEnum.value1.description); // 输出: Description for value1
  print(MyEnum.value2.description); // 输出: Description for value2
}

通过这种方式，你可以轻松地为 Flutter 中的枚举类型添加额外的元数据或方法，而无需修改原始的枚举定义。

回到顶部