Flutter枚举增强插件enum_plus的使用

Flutter枚举增强插件enum_plus的使用

enum_plus 是一个用于增强 Dart 枚举功能的插件。它提供了多种方法来操作枚举实例，使其更加强大和灵活。

安装

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

dependencies:
  enum_plus: ^最新版本号

然后运行 flutter pub get 来安装该包。

使用

要使用 enum_plus，你需要将 with EnumPlus 添加到你的枚举定义中，并实现 toValue 方法以返回自定义值。

示例代码

import 'package:enum_plus/enum_plus.dart';

// 定义一个带有枚举增强功能的枚举
enum Animal with EnumPlus {
  DOG(0),
  CAT(1),
  HONEY_BEE(2);

  const Animal(this.value);

  final int value;

  [@override](/user/override)
  dynamic toValue() => value;
}

void main() {
  // 检查两个枚举实例是否相等
  print(Animal.DOG.equal(Animal.DOG)); // true
  print(Animal.DOG.equal(0)); // true
  print(Animal.DOG.equal(Animal.CAT)); // false
  print(Animal.DOG.equal(1)); // false

  // 检查两个枚举实例是否不相等
  print(Animal.DOG.notEqual(Animal.CAT)); // true
  print(Animal.DOG.notEqual(1)); // true
  print(Animal.DOG.notEqual(Animal.DOG)); // false
  print(Animal.DOG.notEqual(0)); // false

  // 检查枚举实例是否在给定集合内
  print(Animal.DOG.inside([Animal.DOG, Animal.CAT])); // true
  print(Animal.DOG.inside([0, 1])); // true
  print(Animal.DOG.inside([Animal.HONEY_BEE, Animal.CAT])); // false
  print(Animal.DOG.inside([1, 2])); // false

  // 检查枚举实例是否不在给定集合内
  print(Animal.DOG.outside([Animal.HONEY_BEE, Animal.CAT])); // true
  print(Animal.DOG.outside([1, 2])); // true
  print(Animal.DOG.outside([Animal.DOG, Animal.CAT])); // false
  print(Animal.DOG.outside([0, 1])); // false

  // 获取友好的枚举名称
  print(Animal.HONEY_BEE.getFriendlyName()); // Honey Bee

  // 检查枚举是否包含特定名称
  print(Animal.values.hasName('DOG')); // true
  print(Animal.values.hasName('FISH')); // false

  // 检查枚举是否包含特定友好名称
  print(Animal.values.hasFriendlyName('Honey Bee')); // true
  print(Animal.values.hasFriendlyName('Dog')); // true
  print(Animal.values.hasFriendlyName('Fish')); // false

  // 获取指定枚举值的名称
  print(Animal.values.getName(1)); // CAT
  print(Animal.values.getName(100)); // Bad state: No element

  // 获取所有枚举名称
  print(Animal.values.getNames()); // [DOG, CAT, HONEY_BEE]
  print(Animal.values.getNames(values: [0, Animal.CAT])); // [DOG, CAT]
  print(Animal.values.getNamesExcept([0, Animal.HONEY_BEE])); // [CAT]

  // 获取所有友好名称
  print(Animal.values.getFriendlyNames()); // [Dog, Cat, Honey Bee]
  print(Animal.values.getFriendlyNames(values: [0, Animal.HONEY_BEE])); // [Dog, Honey Bee]
  print(Animal.values.getFriendlyNamesExcept([Animal.DOG, 1])); // [Honey Bee]

  // 根据名称获取枚举实例
  print(Animal.values.fromName('DOG')); // Animal.DOG
  print(Animal.values.fromName('FISH')); // Bad state: No element

  // 根据友好名称获取枚举实例
  print(Animal.values.fromFriendlyName('Honey Bee')); // Animal.HONEY_BEE
  print(Animal.values.fromFriendlyName('Fish')); // Bad state: No element

  // 获取除指定值之外的所有枚举实例
  print(Animal.values.toListExcept([Animal.DOG, 1])); // [Animal.HONEY_BEE]

  // 获取随机枚举实例
  print(Animal.values.getRandom()); // Animal.HONEY_BEE
  print(Animal.values.getRandomName()); // DOG
  print(Animal.values.getRandomFriendlyName()); // Cat

  // 根据名称列表获取枚举实例
  print(Animal.values.fromNames(['DOG', 'CAT'])); // [Animal.DOG, Animal.CAT]
  print(Animal.values.fromNames(['CAT', 'FISH'])); // Bad state: No element
  print(Animal.values.fromFriendlyNames(['Honey Bee', 'Cat'])); // [Animal.HONEY_BEE, Animal.CAT]
  print(Animal.values.fromFriendlyNames(['Honey Bee', 'Fish'])); // Bad state: No element

  // 检查枚举是否包含特定值
  print(Animal.values.hasValue(1)); // true
  print(Animal.values.hasValue(Animal.CAT)); // true
  print(Animal.values.hasValue(100)); // false

  // 获取指定名称的枚举值
  print(Animal.values.getValue('DOG')); // 0
  print(Animal.values.getValue('FISH')); // Bad state: No element

  // 根据值列表获取枚举实例
  print(Animal.values.fromValues([0, Animal.CAT])); // [Animal.DOG, Animal.CAT]

  // 获取所有枚举值
  print(Animal.values.getValues()); // [0, 1, 2]
  print(Animal.values.getValues(names: ['DOG'])); // [0]
  print(Animal.values.getValuesExcept([Animal.DOG, 1])); // [2]

  // 根据值获取枚举实例
  print(Animal.values.fromValue(1)); // Animal.CAT
  print(Animal.values.fromValue(Animal.CAT)); // Animal.CAT
  print(Animal.values.fromValue(100)); // Bad state: No element

  // 尝试根据键或值创建新的枚举实例
  print(Animal.values.coerce(1)); // Animal.CAT
  print(Animal.values.coerce('CAT')); // Animal.CAT
  print(Animal.values.coerce(100)); // null
  print(Animal.values.coerce('FISH')); // null

  // 获取随机枚举值
  print(Animal.values.getRandomValue()); // 1
}