Flutter数据序列化插件binary_serializable的使用

Flutter数据序列化插件binary_serializable的使用

高效地对二进制数据流进行序列化和反序列化。当与 binary_serializable_generator 结合使用时，可以方便地将 Dart 对象高效地编码为二进制数据，并将二进制流解码为 Dart 对象。

示例代码

以下是一个完整的示例代码，展示了如何使用 binary_serializable 插件来序列化和反序列化一个包含嵌套对象的数据结构。

import 'package:binary_serializable/binary_serializable.dart';

class Person {
  final String name;
  final int age;
  final List<Person> children;

  Person({required this.name, required this.age, required this.children});
}

void main() {
  // 创建一个示例对象
  final sample = Person(
    name: 'Alice',
    age: 87,
    children: [
      Person(
        name: 'Bob',
        age: 49,
        children: [
          Person(
            name: 'Tina',
            age: 17,
            children: [],
          ),
        ],
      ),
      Person(
        name: 'Joe',
        age: 49,
        children: [],
      ),
    ],
  );

  // 序列化对象
  final encoded = PersonType().encode(sample);

  // 打印编码后的二进制数据
  print(
    'Encoded data: ${encoded.map((b) => b.toRadixString(16).padLeft(2, '0')).join(' ')}',
  );

  // 反序列化二进制数据
  final decoded = PersonType().decode(encoded);

  // 打印解码后的数据
  print(
    '1st child of decoded sample: ${decoded.children.first.name} (${decoded.children.first.age}, ${decoded.children.first.children.length} child)',
  );
}

// 以下是可以通过 binary_serializable_generator 自动生成的代码

class PersonType extends BinaryType<Person> {
  const PersonType();

  @override
  void encodeInto(Person input, BytesBuilder builder) {
    // 将字符串编码为 UTF-8 字节
    utf8String.encodeInto(input.name, builder);
    // 将整数编码为单字节
    uint8.encodeInto(input.age, builder);
    // 将列表编码为长度前缀列表
    const LengthPrefixedListType(uint8, PersonType())
        .encodeInto(input.children, builder);
  }

  @override
  BinaryConversion<Person> startConversion(void Function(Person p1) onValue) =>
      PersonConversion(onValue);
}

class PersonConversion extends CompositeBinaryConversion<Person> {
  PersonConversion(super.onValue);

  @override
  BinaryConversion startConversion() {
    // 开始处理字符串
    return utf8String.startConversion((name) {
      // 处理整数
      currentConversion = uint8.startConversion((age) {
        // 处理列表
        currentConversion = const LengthPrefixedListType(uint8, PersonType())
            .startConversion((children) {
          // 完成对象构造
          onValue(Person(name: name, age: age, children: children));
        });
      });
    });
  }
}

代码解释

1. Person 类定义：

   class Person {
     final String name;
     final int age;
     final List<Person> children;
   
     Person({required this.name, required this.age, required this.children});
   }
   

   这里定义了一个 Person 类，其中包含了名字、年龄和子节点信息。

2. 创建示例对象：

   final sample = Person(
     name: 'Alice',
     age: 87,
     children: [
       Person(
         name: 'Bob',
         age: 49,
         children: [
           Person(
             name: 'Tina',
             age: 17,
             children: [],
           ),
         ],
       ),
       Person(
         name: 'Joe',
         age: 49,
         children: [],
       ),
     ],
   );
   

   创建一个嵌套的 Person 对象实例。

3. 序列化对象：

   final encoded = PersonType().encode(sample);
   

   使用 PersonType 的 encode 方法将 Person 对象编码为二进制数据。

4. 打印编码后的数据：

   print(
     'Encoded data: ${encoded.map((b) => b.toRadixString(16).padLeft(2, '0')).join(' ')}',
   );
   

   将编码后的二进制数据以十六进制格式打印出来。

5. 反序列化二进制数据：

   final decoded = PersonType().decode(encoded);
   

   使用 PersonType 的 decode 方法将二进制数据解码为 Person 对象。

6. 打印解码后的数据：

   print(
     '1st child of decoded sample: ${decoded.children.first.name} (${decoded.children.first.age}, ${decoded.children.first.children.length} child)',
   );