Flutter唯一标识符生成插件 id_gen 的使用

id_gen 是一个用于生成各种类型唯一标识符的Flutter插件。它支持生成UUID、HumanID、递增/递减整数ID以及时间戳ID等。以下是该插件的详细使用方法及示例代码。

安装

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

dependencies:
  id_gen: ^最新版本号

然后运行 flutter pub get 来安装插件。

使用示例

1. 生成4个随机UUID

UUID（Universally Unique Identifier）是一种标准的128位格式，用于定义信息在计算机系统中的唯一性。

import 'package:id_gen/id_gen.dart';

void main() {
  print([for (var i = 0; i < 4; ++i) genUuid]);
}

输出示例：

[4c48329b-2c1b-4534-b649-1a462626bcd4, a1afafe2-d57a-46ae-9f27-7e42dc936475,
283ae055-cf4e-4d6d-b505-e2a7d60806d2, 843832d1-d0f0-48e7-8a61-3aa151c2103b]

2. 从语言生成HumanID

HumanID是从文本生成的易于阅读的唯一标识符，支持多种语言如白俄罗斯语、英语和乌克兰语。

import 'package:id_gen/id_gen.dart';
import 'package:id_gen/id_gen_helpers.dart';

void main() {
  const gen = HumanIdGen(options: HumanIdGenOptions(lowerCase: true));
  final hid = gen.get('Тема статті чи назва курсу');
  print(hid);
}

输出示例：

tema-stati-chy-nazva-kursu

3. 生成递增的唯一整数ID

import 'package:id_gen/id_gen.dart';

void main() {
  final gen = TransitIdGen();
  print([for (var i = 0; i < 4; ++i) gen.next]);
}

输出示例：

[1, 2, 3, 4]

4. 生成基于时间的唯一整数ID

可以生成以毫秒或微秒为单位的时间戳ID。

import 'package:id_gen/id_gen.dart';

void main() {
  // 毫秒
  print(genTimeId);
  // 微秒
  print(genTimeIdMicro);
}

输出示例：

1705954581187
1705954581188687

注意：第二个ID不适合存储在JavaScript数字中，因为它超过了53位。

5. 给任意类添加HID和UID

通过混合类 HasStringIdMix 可以为任意类添加HID和UID属性。

import 'package:id_gen/id_gen.dart';

class Quant with HasStringIdMix {
  Quant({String? hid, String? uid}) {
    this.hid = hid;
    this.uid = uid;
  }
}

void main() {
  print(Quant().id);
  print(Quant(hid: 'aerwyna').id);
}

输出示例：

92e6ee3e-537a-4dd3-b4e9-06b8fd366469
aerwyna

完整示例代码

以下是一个完整的示例代码，展示了如何使用 id_gen 插件生成不同类型的唯一标识符：

// ignore_for_file: avoid_print

import 'package:id_gen/id_gen.dart';
import 'package:id_gen/id_gen_helpers.dart';

void main() {
  // 生成随机UUIDs
  print('\ngenerate random UUIDs, helper');
  print([for (var i = 0; i < 4; ++i) genUuid]);

  // 使用原生方法生成UUIDs
  print('\ngenerate random UUIDs, native');
  {
    const gen = UuidGen();
    print([for (var i = 0; i < 4; ++i) gen.next]);
    // 或者直接使用genUuid
    print([for (var i = 0; i < 4; ++i) genUuid]);
  }

  // 生成HumanID
  print('\ngenerate HID from Ukrainian');
  {
    final gen = HumanIdGen(options: HumanIdGenOptions(lowerCase: true));
    final hid = gen.get('Тема статті чи назва курсу');
    print(hid);
  }

  // 生成递增的唯一整数ID
  print('\ngenerate increasing unique integer ID, helper');
  {
    final gen = TransitIdGen();
    print([for (var i = 0; i < 4; ++i) gen.next]);
    // 或者直接使用genTransitId
    print([for (var i = 0; i < 4; ++i) genTransitId]);
  }

  // 生成递减的唯一整数ID
  print('\ngenerate decreasing unique integer ID');
  {
    final gen = TransitIdGen(1050, -50);
    print([for (var i = 0; i < 4; ++i) gen.next]);
  }

  // 生成基于时间的ID
  print('\ngenerate time IDs in milliseconds, helper');
  for (var i = 0; i < 4; ++i) {
    print(genTimeId);
  }

  print('\ngenerate time IDs in microseconds, helper');
  for (var i = 0; i < 4; ++i) {
    print(genTimeIdMicro);
  }
}