Flutter打包与配置管理插件get_packer的使用

Flutter打包与配置管理插件GetPacker的使用

GetPacker简介

GetPacker 是一个高性能的 Dart 序列化库，旨在高效地打包和解包数据结构。它提供了一个快速且紧凑的替代方案，相较于 JSON 编码/解码和 MessagePack，GetPacker 没有任何限制（例如支持 DateTime 对象）。

特性

• 快速编码和解码：支持多种数据类型的高效编码和解码。
• 紧凑的二进制格式：相比 JSON，生成的数据量更小。
• 支持多种数据类型：
  • null
  • 布尔值
  • 整数（包括大整数）
  • 浮点数
  • 字符串
  • 二进制数据 (Uint8List)
  • 列表
  • 映射
  • DateTime
  • BigInt
• 易于使用的 API：简单易用的接口。
• 自定义对象支持：通过 PackedModel 混入类轻松实现自定义对象的序列化和反序列化。

安装

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

dependencies:
  get_packer: ^1.0.0

然后运行 dart pub get 或 flutter pub get（如果你使用的是 Flutter）。

使用方法

基本用法

以下是一个简单的示例，展示了如何使用 GetPacker 进行数据的编码和解码：

import 'package:get_packer/get_packer.dart';

void main() {
  // 编码
  final data = {
    'name': 'John Doe',
    'age': 30,
    'isStudent': false,
    'grades': [85, 90, 92],
  };

  final encoded = GetPacker.pack(data);
  print(encoded); // 输出: [132, 164, 110, 97, 109, 101, 168, 74, 111, 104, 110, 32, 68, 111, 101, 163, 97, 103, 101, 30, 169, 105, 115, 83, 116, 117, 100, 101, 110, 116, 194, 166, 103, 114, 97, 100, 101, 115, 147, 85, 90, 92]

  // 解码
  final decoded = GetPacker.unpack(encoded);

  print(decoded); // 输出: {name: John Doe, age: 30, isStudent: false, grades: [85, 90, 92]}
}

使用自定义对象

你可以使用 PackedModel 混入类来轻松实现自定义对象的序列化和反序列化：

class User with PackedModel {
  String name;
  int age;

  User(this.name, this.age);

  [@override](/user/override)
  Map<String, dynamic> toJson() => {'name': name, 'age': age};

  [@override](/user/override)
  static User fromJson(Map<String, dynamic> json) {
    return User(json['name'], json['age']);
  }
}

void main() {
  final user = User('Alice', 25);

  // 打包
  final packed = user.pack();

  // 解包
  final unpackedUser = User.fromJson(GetPacker.unpack(packed));

  print('${unpackedUser.name}, ${unpackedUser.age}'); // 输出: Alice, 25
}

性能

GetPacker 设计为快速且高效。在基准测试中，它通常比标准的 JSON 编码/解码在速度和大小上表现更好：

// 示例基准测试结果：
JSON Encode(RunTime): 191.99949000407997 us.
GetPacker Encode(RunTime): 140.41056438954482 us.

Size comparison:
JSON size: 1268 bytes
GetPacker size: 986 bytes
GetPacker is 22.24% smaller

如果你想自行测试，以下是用于基准测试的代码：

import 'dart:convert';
import 'dart:typed_data';

import 'package:benchmark_harness/benchmark_harness.dart';
import 'package:get_packer/get_packer.dart';

final testData = {
  'nullValue': null,
  'boolean': true,
  'integer': 42,
  'negativeInteger': -42,
  'double': 3.14159,
  'string': 'Hello, World!',
  'binary': Uint8List.fromList([1, 2, 3, 4, 5, 6, 7, 8]),
  'array': [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
  'map': {'key1': 'value1', 'key2': 'value2', 'key3': 'value3'},
  'nestedArray': [
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9]
  ],
  'nestedMap': {
    'outer1': {'inner1': 'value1', 'inner2': 'value2'},
    'outer2': {'inner3': 'value3', 'inner4': 'value4'}
  },
  'mixedArray': [
    1,
    'two',
    3.0,
    true,
    null,
    {'key': 'value'}
  ],
  'complexObject': {
    'id': 1001,
    'name': 'Complex Object',
    'attributes': ['attr1', 'attr2', 'attr3'],
    'metadata': {
      'created': '2023-09-30T12:00:00Z',
      'updated': '2023-09-30T14:30:00Z',
      'tags': ['tag1', 'tag2', 'tag3']
    }
  },
  'longString':
      'This is a much longer string that contains multiple sentences. '
          'It can be used to test how the system handles larger text inputs. '
          'The string can contain various characters and punctuation marks!',
  'largeInteger': 1234567890123456789,
  'negativeDouble': -273.15,
  'emptyStructures': {'emptyArray': [], 'emptyMap': {}, 'emptyString': ''},
  'deeplyNestedStructure': {
    'level1': {
      'level2': {
        'level3': {
          'level4': {'level5': 'Deep value'}
        }
      }
    }
  },
  'repeatingData': List.generate(
      5,
      (index) =>
          {'id': index, 'name': 'Item ${index + 1}', 'isEven': index % 2 == 0}),
};

class JsonEncodeBenchmark extends BenchmarkBase {
  JsonEncodeBenchmark() : super('JSON Encode');

  [@override](/user/override)
  void run() {
    final foo = jsonEncode(testData);
    jsonDecode(foo);
  }
}

class GetPackerEncodeBenchmark extends BenchmarkBase {
  GetPackerEncodeBenchmark() : super('GetPacker Encode');

  [@override](/user/override)
  void run() {
    final foo = GetPacker.pack(testData);
    GetPacker.unpack(foo);
  }
}

void main() {
  JsonEncodeBenchmark().report();
  GetPackerEncodeBenchmark().report();

  // 多次运行以获得更准确的结果
  print('\nRunning multiple iterations:');
  for (int i = 0; i < 5; i++) {
    print('\nIteration ${i + 1}:');
    JsonEncodeBenchmark().report();
    GetPackerEncodeBenchmark().report();
  }

  // 比较大小
  final jsonSize = utf8.encode(jsonEncode(testData)).length;
  final getPackerSize = GetPacker.pack(testData).length;

  print('\nSize comparison:');
  print('JSON size: $jsonSize bytes');
  print('GetPacker size: $getPackerSize bytes');
  print('Size difference: ${(jsonSize - getPackerSize)} bytes');
  print(
      'GetPacker is ${((jsonSize - getPackerSize) / jsonSize * 100).toStringAsFixed(2)}% smaller');
}