Flutter插件pro_mpack的介绍与使用

pro_mpack 是一个用于在Dart中进行数据序列化和反序列化的库，支持MessagePack格式。它具有高效、紧凑的数据编码特性，并且支持自定义扩展类型。

Features（功能）

• 支持将Dart对象序列化为MessagePack格式，并从MessagePack格式反序列化回Dart对象。
• 支持自定义扩展类型。
• 高效的二进制编码，适用于各种数据类型。
• 完全支持MessagePack的类型系统，包括整数、字符串、数组、映射等。

Installation（安装）

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

dependencies:
  pro_mpack: ^2.0.2

然后运行 flutter pub get 来安装该包。

Usage（使用）

基本序列化和反序列化

下面是一个简单的示例，展示了如何使用 pro_mpack 进行基本的序列化和反序列化操作：

import 'package:pro_mpack/pro_mpack.dart';

void main() {
  // 序列化一个对象
  final serializedData = serialize({'key': 'value'});

  // 反序列化数据回到对象
  final deserializedData = deserialize(serializedData);

  print(deserializedData); // 输出: {key: value}
}

自定义扩展类型

为了处理自定义扩展类型，可以混合使用 ExtEncoder 和实现 ExtDecoder。

import 'dart:typed_data';
import 'package:pro_binary/pro_binary.dart';
import 'package:pro_mpack/pro_mpack.dart';

enum TimeStampFormat {
  ts32,
  ts64,
  ts96;

  static TimeStampFormat fromLength(int length) {
    switch (length) {
      case 4:
        return ts32;
      case 8:
        return ts64;
      case 12:
        return ts96;
      default:
        throw Exception('Invalid timestamp length');
    }
  }
}

/// 自定义扩展编码器用于序列化DateTime对象。
class CustomTypesExtEncoder with ExtEncoder {
  CustomTypesExtEncoder({required this.timeStampFormat});

  final TimeStampFormat timeStampFormat;

  @override
  int? extTypeForObject(Object? object) {
    if (object is DateTime) {
      return -1;
    }
    throw Exception('Unknown object type');
  }

  @override
  Uint8List encodeObject(Object? object) {
    if (object is DateTime) {
      final writer = BinaryWriter();

      switch (timeStampFormat) {
        case TimeStampFormat.ts32:
          final seconds = object.millisecondsSinceEpoch ~/ 1000;
          writer.writeUint32(seconds);
          break;
        case TimeStampFormat.ts64:
          final seconds = object.millisecondsSinceEpoch ~/ 1000;
          final nanoSeconds = (object.microsecondsSinceEpoch % 1000000) * 1000;
          writer.writeUint32(nanoSeconds);
          writer.writeUint32(seconds);
          break;
        case TimeStampFormat.ts96:
          final seconds = object.millisecondsSinceEpoch ~/ 1000;
          final nanoSeconds = (object.microsecondsSinceEpoch % 1000000) * 1000;
          writer.writeUint32(nanoSeconds);
          writer.writeInt64(seconds);
          break;
      }

      return writer.takeBytes();
    }
    throw Exception('Unknown object type');
  }
}

/// 自定义扩展解码器用于反序列化DateTime对象。
class CustomTypesExtDecoder implements ExtDecoder {
  @override
  Object? decodeObject(int extType, Uint8List data) {
    if (extType == -1) {
      final type = TimeStampFormat.fromLength(data.length);
      final reader = BinaryReader(data);
      switch (type) {
        case TimeStampFormat.ts32:
          final seconds = reader.readUint32();
          return DateTime.fromMillisecondsSinceEpoch(seconds * 1000, isUtc: true);
        case TimeStampFormat.ts64:
          final nanoSeconds = reader.readUint32();
          final seconds = reader.readUint32();
          return DateTime.fromMillisecondsSinceEpoch(seconds * 1000, isUtc: true)
              .add(Duration(microseconds: nanoSeconds ~/ 1000));
        case TimeStampFormat.ts96:
          final nanoSeconds = reader.readUint32();
          final seconds = reader.readInt64();
          return DateTime.fromMillisecondsSinceEpoch(seconds * 1000, isUtc: true)
              .add(Duration(microseconds: nanoSeconds ~/ 1000));
      }
    }
    throw UnimplementedError();
  }
}

void main() {
  final date = DateTime.utc(2021, 1, 1, 12, 32, 5, 880, 999);
  final userData = serialize(
    {
      'id': 1,
      'name': 'John Doe',
      'created': date,
      'updated': date.add(const Duration(days: 1)),
    },
    extEncoder: CustomTypesExtEncoder(timeStampFormat: TimeStampFormat.ts64),
  );

  final deserializedData = deserialize(
    userData,
    extDecoder: CustomTypesExtDecoder(),
  );

  print(deserializedData);
  // 输出:
  // {
  //  id: 1,
  //  name: John Doe,
  //  created: 2021-01-01 12:32:05.880999Z,
  //  updated: 2021-01-02 12:32:05.880999Z
  //}
}

这个例子展示了如何创建自定义的编码器和解码器来处理特定类型的对象（如 DateTime），并通过 serialize 和 deserialize 函数使用它们。

Running Tests（运行测试）

要运行 pro_mpack 的测试，请使用以下命令：

dart pub run test