Flutter位枚举管理插件enum_bit_vector的使用

Flutter位枚举管理插件enum_bit_vector的使用

动机

通常情况下，我们需要存储一组标志或标签。例如超级英雄拥有的超能力、用户拥有的权限或者食品项的标签。所有这些用例都可以通过一组枚举值来表示：

enum SuperPowers { 隐形, 速度, 飞行, 永生, 抗性, 心灵感应 }
batman.SuperPowers = {SuperPowers.飞行, SuperPowers.抗性, SuperPowers.心灵感应};

enum Permissions { 删除文件, 邀请他人, 创建会议 }
user1.Permissions = { Permissions.邀请他人 };

enum FoodLabels { 素食, 纯素食, 含有坚果, 健酮友好 }
carrotLabels = {FoodLabels.纯素食, FoodLabels.素食, FoodLabels.健酮友好};

如果我们需要存储大量数据，那么将这些值以字符串列表或字符串到布尔值的映射形式存储在JSON中可能会效率低下：

{
  "title": "胡萝卜",
  "foodLabels": {
    "FoodLabels.纯素食": true,
    "FoodLabels.素食": true,
    "FoodLabels.含有坚果": false,
    "FoodLabels.健酮友好": true
  }
}

相反，在Dart中我们可以使用一个64位整数来表示最多64个布尔值：只要我们的枚举包含的值不超过64个，我们就可以将它们全部放入一个整数中，该整数可以用只有8个字符的十六进制字符串表示。

安装

首先，你需要添加enum_bit_vector包到你的项目中：

dart pub add enum_bit_vector
dart pub get

然后，导入这个包：

import 'package:enum_bit_vector/enum_bit_vector.dart';

如何使用

1. 注册你想要创建EnumBitVectors的枚举类型

这一步只需要在程序运行期间执行一次，但必须在第一次使用该数据类型之前完成：

EnumBitVector.registerEnum(SuperPowers.values);

2. 从集合、列表、整数或十六进制字符串创建EnumBitVector

EnumBitVector enumBitVector;

// 从枚举集创建
enumBitVector = EnumBitVector.fromSet({SuperPowers.飞行, SuperPowers.抗性, SuperPowers.心灵感应});

// 从枚举列表创建
enumBitVector = EnumBitVector.fromList([SuperPowers.飞行, SuperPowers.抗性, SuperPowers.心灵感应]);

// 从整数创建
enumBitVector = EnumBitVector.fromInt(13); 

// 从十六进制字符串创建
enumBitVector = EnumBitVector.fromHexString('0000000d');

访问值

你可以随时将EnumBitVector转换为枚举集、枚举列表、整数或十六进制字符串：

enumBitVector.toSet(); // => {SuperPowers.飞行, SuperPowers.抗性, SuperPowers.心灵感应}
enumBitVector.enumSet; // => {SuperPowers.飞行, SuperPowers.抗性, SuperPowers.心灵感应}
enumBitVector.toList(); // => [SuperPowers.飞行, SuperPowers.抗性, SuperPowers.心灵感应]
enumBitVector.toInt(); // => 13
enumBitVector.value; // => 13
enumBitVector.toBinaryString();  // => '0000000000000000000000000000000000000000000000000000000000001101'
enumBitVector.toHexString();  // => '0000000d';

JSON转换

final json = enumBitVector.toJson();
// json 将是 {'v': 13}
final bitVector = EnumBitVector<SuperPowers>.fromJson({'v': 13});
// 将创建一个值为13的bit vector。

打印EnumBitVector

enumBitVector = EnumBitVector.fromSet({SuperPowers.飞行, SuperPowers.抗性, SuperPowers.心灵感应});
print(enumBitVector);
// 打印: EnumBitVector<SuperPowers>(0000000000000000000000000000000000000000000000000000000000001101 = {SuperPowers.飞行, SuperPowers.抗性, SuperPowers.心灵感应})

完整示例Demo

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

import 'package:enum_bit_vector/enum_bit_vector.dart';

enum SuperPowers { 隐形, 速度, 飞行, 永生, 抗性, 心灵感应 }

void main(List<String> arguments) {
  // 注册枚举类型
  EnumBitVector.registerEnum(SuperPowers.values);

  // 创建一个枚举集合
  final enumSet = {
    SuperPowers.飞行,
    SuperPowers.抗性,
    SuperPowers.心灵感应,
  };

  // 输出原始枚举集合
  print('枚举集合: $enumSet');

  // 从枚举集合创建EnumBitVector
  final enumBitVector = EnumBitVector.fromSet(enumSet);

  // 输出EnumBitVector
  print('EnumBitVector: $enumBitVector');

  // 输出EnumBitVector转换为整数
  print('EnumBitVector转为整数: ${enumBitVector.toInt()}');

  // 输出EnumBitVector转换为集合
  print('EnumBitVector转为集合: ${enumBitVector.toSet()}');

  // 输出EnumBitVector转换为列表
  print('EnumBitVector转为列表: ${enumBitVector.toList()}');
}