Flutter数据编码插件base32的使用

dart-base32简介

dart-base32是一个遵循RFC4648标准，用于简单地进行Base32编码和解码的库。它支持多种编码方式，并且能够处理用于OTP（一次性密码）密钥的Base32编码。

• GitHub Actions构建状态
• API文档

快速开始

Pubspec配置

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

dependencies:
  base32: ^2.1.3

然后执行flutter pub get以安装该包。

导入包

接下来，在Dart文件中导入base32包：

import 'package:base32/base32.dart';

现在你可以开始对数据进行Base32的编码与解码了。

API介绍

编码函数

base32.encode(List<int> byteList, {Encoding encoding = Encoding.standardRFC4648})

从字节数组生成并返回一个符合RFC4648规范的Base32字符串。

• 参数：

  • byteList: 字节列表，表示要编码的数据。

• 返回值：编码后的Base32字符串。

base32.encodeHexString(String hex, {Encoding encoding = Encoding.standardRFC4648})

将十六进制字符串转换为字节数组后，再按照RFC4648规范生成Base32字符串。

• 参数：

  • hexString: 十六进制字符串形式的数据。

• 返回值：编码后的Base32字符串。

base32.encodeString(String base32str, {Encoding encoding = Encoding.standardRFC4648})

直接对普通字符串进行Base32编码。

• 参数：

  • base32str: 普通字符串，会被转换成字节数组后编码。

• 返回值：编码后的Base32字符串。

解码函数

base32.decode(String base32, {Encoding encoding = Encoding.standardRFC4648})

将Base32字符串解码回原始的字节数组。

• 参数：

  • base32: 要解码的Base32字符串。

• 返回值：解码后的字节数组(Uint8List)。

base32.decodeAsHexString(String base32, {Encoding encoding = Encoding.standardRFC4648})

将Base32字符串解码为原始的十六进制字符串。

• 参数：

  • base32: 要解码的Base32字符串。

• 返回值：解码后的十六进制字符串。

base32.decodeAsString(String base32, {Encoding encoding = Encoding.standardRFC4648})

将Base32字符串解码为原始的普通字符串。

• 参数：

  • base32: 要解码的Base32字符串。

• 返回值：解码后的普通字符串。

枚举类型Encoding

定义了不同的Base32编码变种，包括但不限于：

• StandardRFC4648
• base32Hex
• crockford
• z-base-32
• geohash
• NonStandardRFC4648

每个编码变种都有其特定的字符集和填充规则，请根据实际需求选择合适的编码方式。

示例代码

下面给出一个完整的示例程序，演示如何使用dart-base32来进行编码和解码操作：

import 'package:base32/base32.dart';
import 'package:convert/convert.dart'; // For hex conversion

void main() {
  // Example 1: Encode a hex string to base32
  String encoded = base32.encodeHexString('48656c6c6f21deadbeef');
  print('Encoded Hex String: $encoded'); // Output: JBSWY3DPEHPK3PXP

  // Example 2: Decode a base32 string back to hex string
  String decodedHex = base32.decodeAsHexString(encoded);
  print('Decoded Hex String: $decodedHex'); // Output: 48656c6c6f21deadbeef

  // Example 3: Encode a plain string to base32
  String encodedString = base32.encodeString('Hello!');
  print('Encoded Plain String: $encodedString'); // Output: NBSWYG======

  // Example 4: Decode a base32 string back to plain string
  String decodedString = base32.decodeAsString(encodedString);
  print('Decoded Plain String: $decodedString'); // Output: Hello!

  // Example 5: Decode base32 string to Uint8List and then convert it to hex string
  Uint8List decodedBytes = base32.decode(encoded);
  String decodedBytesHex = hex.encode(decodedBytes);
  print('Decoded Bytes as Hex String: $decodedBytesHex'); // Output: 48656c6c6f21deadbeef
}

这段代码展示了如何使用dart-base32库来实现基本的Base32编码和解码功能，同时结合了package:convert中的工具方法来展示解码后的结果。您可以根据自己的应用场景调整编码方式及参数设置。