Flutter哈希ID生成与解析插件hashids2的使用

简介

Hashids2 是一个用于生成YouTube风格哈希值的Dart库。它可以从一个或多个数字生成短小、唯一且可解密的哈希值。该库移植自JavaScript版本的 hashids.js，由Ivan Akimov开发。

特点

• 唯一性和可解密性：每个哈希都是唯一的，并且可以被解密回原始数值。
• 支持多个整数：可以将多个整数编码为一个哈希值。
• 最小长度控制：可以指定生成的哈希值的最小长度。
• 避免敏感词汇：生成的哈希值不会包含常见的英文脏话，适合公开场合使用。

安装与配置

1. 添加依赖

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

dependencies:
  hashids2: ^latest_version # 请确保使用最新版本

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

2. 导入包

在需要使用的Dart文件顶部导入hashids2包：

import 'package:hashids2/hashids2.dart';

使用示例

基本用法

编码（加密）

以下代码展示了如何创建一个HashIds实例并使用它来编码一组数字：

void main() {
  // 创建一个HashIds实例，设置盐、最小哈希长度和字母表
  final hashids = HashIds(
    salt: 'this is my salt', // 盐值，用于增加安全性
    minHashLength: 8,        // 设置最小哈希长度
    alphabet: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890', // 自定义字母表
  );

  // 将数字列表编码为哈希字符串
  final id = hashids.encode([1, 2, 3]);
  print('Encoded ID: $id'); // 输出编码后的哈希值
}

解码（解密）

接下来，我们可以使用相同的HashIds实例来解码之前生成的哈希值，恢复原始数字列表：

  // 解码哈希字符串为原始数字列表
  final numbers = hashids.decode(id);
  print('Decoded Numbers: $numbers'); // 输出解码后的数字列表
}

完整示例

下面是一个完整的示例程序，演示了如何在Flutter应用中使用hashids2进行编码和解码操作：

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Hashids2 Example')),
        body: Center(child: MyHomePage()),
      ),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final hashids = HashIds(
    salt: 'this is my salt',
    minHashLength: 8,
    alphabet: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
  );
  String encodedText = '';
  List<int> decodedNumbers = [];

  void encodeNumbers() {
    setState(() {
      encodedText = hashids.encode([1, 2, 3]);
    });
  }

  void decodeText() {
    setState(() {
      decodedNumbers = hashids.decode(encodedText);
    });
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: <Widget>[
        ElevatedButton(
          onPressed: encodeNumbers,
          child: Text('Encode [1, 2, 3]'),
        ),
        SizedBox(height: 20),
        Text('Encoded: $encodedText'),
        SizedBox(height: 20),
        ElevatedButton(
          onPressed: decodeText,
          child: Text('Decode'),
        ),
        SizedBox(height: 20),
        Text('Decoded: ${decodedNumbers.toString()}'),
      ],
    );
  }
}

此示例应用程序提供了一个简单的用户界面，允许用户点击按钮对预设的数字列表进行编码和解码操作，并显示结果。

许可证

Hashids2采用MIT许可证发布，您可以自由地将其应用于开源项目和商业产品中。更多详情请参阅LICENSE文件。