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

ObjectId 插件简介

ObjectId 是一个用于Dart语言的高性能、跨平台的ObjectId实现。它具有以下特点：

• 🚀 快速
• 📱 跨平台支持
• 🧪 测试充分
• 📑 符合bson ObjectId 规范
• 📝 文档齐全

开始使用

1. 添加依赖

在 pubspec.yaml 文件中添加 objectid 依赖：

dependencies:
  objectid: ^3.1.0

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

2. 使用示例代码

基本用法

import 'package:objectid/objectid.dart';

void main() {
  // 创建一个新的ObjectId实例
  final id = ObjectId();
  print(id);   // 输出: 5f52c805df41c9df948e6135
  print(id.hexString); // 输出: 5f52c805df41c9df948e6135
}

从十六进制字符串创建ObjectId

import 'package:objectid/objectid.dart';

void main() {
  // 从十六进制字符串创建ObjectId实例
  final id = ObjectId.fromHexString('5f52c805df41c9df948e6135');
  print(id.hexString); // 输出: 5f52c805df41c9df948e6135

  final id2 = ObjectId.fromHexString(id.hexString);
  print(id == id2); // 输出: true
}

从字节数组创建ObjectId

import 'package:objectid/objectid.dart';

void main() {
  // 从字节数组创建ObjectId实例
  final id = ObjectId.fromBytes([95, 82, 205, 121, 180, 195, 28, 88, 32, 47, 183, 78]);
  print(id.hexString); // 输出: 5f52cd79b4c31c58202fb74e

  // 获取ObjectId的字节数组表示
  print(id.bytes); // 输出: [95, 82, 205, 121, 180, 195, 28, 88, 32, 47, 183, 78]

  final id2 = ObjectId.fromBytes(id.bytes);
  print(id == id2); // 输出: true
}

从特定值创建ObjectId

import 'package:objectid/objectid.dart';

void main() {
  // 从特定值创建ObjectId实例
  final zeroed = ObjectId.fromValues(0, 0, 0);
  print(zeroed.hexString); // 输出: 000000000000000000000000

  final withTimestamp = ObjectId.fromValues(0x3e7fffffc18, 0, 0);
  print(withTimestamp.hexString); // 输出: ffffffff0000000000000000

  final withProcessUnique = ObjectId.fromValues(0, 0xffffffffff, 0);
  print(withProcessUnique.hexString); // 输出: 00000000ffffffffff000000

  final withCounter = ObjectId.fromValues(0, 0, 0xffffff);
  print(withCounter.hexString); // 输出: 000000000000000000ffffff

  final filled = ObjectId.fromValues(0x3e7fffffc18, 0xffffffffff, 0xffffff);
  print(filled.hexString); // 输出: ffffffffffffffffffffffff
}

从时间戳创建ObjectId

import 'package:objectid/objectid.dart';

void main() {
  // 从时间戳创建ObjectId实例
  final id = ObjectId.fromTimestamp(DateTime.now());
  print(id.hexString); // 输出: 5f52d05e0000000000000000
}

属性和方法

• hexString: 返回ObjectId的24位十六进制字符串表示。
• timestamp: 返回ObjectId生成的时间戳（精确到秒）。
• bytes: 返回ObjectId的字节数组表示。
• hashCode: 返回ObjectId的哈希码。
• isValid(String hexString): 静态方法，检查提供的十六进制字符串是否为有效的ObjectId。

性能基准测试

在MacBook Pro (13-inch, M2, 2022) 上进行的性能基准测试结果如下：

更多详细的性能基准测试可以在示例应用程序中找到。

完整示例Demo

以下是一个完整的Flutter应用示例，展示了如何在Flutter项目中使用 objectid 插件生成唯一标识符：

import 'package:flutter/material.dart';
import 'package:objectid/objectid.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'ObjectId Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: ObjectIdPage(),
    );
  }
}

class ObjectIdPage extends StatefulWidget {
  @override
  _ObjectIdPageState createState() => _ObjectIdPageState();
}

class _ObjectIdPageState extends State<ObjectIdPage> {
  String _objectId = '';

  void _generateObjectId() {
    final id = ObjectId();
    setState(() {
      _objectId = id.hexString;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('ObjectId Generator'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'Generated ObjectId:',
              style: TextStyle(fontSize: 18),
            ),
            SizedBox(height: 20),
            Text(
              _objectId.isEmpty ? 'Click the button to generate' : _objectId,
              style: TextStyle(fontSize: 16, color: Colors.grey),
            ),
            SizedBox(height: 40),
            ElevatedButton(
              onPressed: _generateObjectId,
              child: Text('Generate ObjectId'),
            ),
          ],
        ),
      ),
    );
  }
}

这个示例应用包含了一个按钮，点击按钮后会生成一个新的ObjectId并显示在屏幕上。希望这些信息对您有所帮助！