Flutter数据编码与解码插件conduit_codable_fork的使用

Flutter数据编码与解码插件conduit_codable_fork的使用

conduit_codable_fork 是一个用于将动态数据编码为 Dart 对象或从 Dart 对象解码的库。该库提供了方便的方法来处理对象的编码和解码，支持嵌套对象和引用。

基本用法

要使用 conduit_codable_fork，首先需要创建一个扩展了 Coding 类的数据对象，并实现 decode 和 encode 方法。

class Person extends Coding {
  String name;

  @override
  void decode(KeyedArchive object) {
    // 必须调用父类的解码方法
    super.decode(object);

    name = object.decode("name");   
  }

  @override
  void encode(KeyedArchive object) {
    object.encode("name", name);
  }
}

示例：从JSON读取对象

final json = jsonDecode('{"name": "Alice"}'); // 假设这是从网络获取的JSON字符串
final archive = KeyedArchive.unarchive(json);
final person = Person()..decode(archive);
print(person.name); // 输出 "Alice"

示例：将对象写入JSON

final person = Person()..name = "Bob";
final archive = KeyedArchive.archive(person);
final json = jsonEncode(archive);
print(json); // 输出 {"name": "Bob"}

编码和解码其他对象

Coding 对象可以编码或解码其他 Coding 对象，包括列表和包含 Coding 对象的映射。在解码时，必须提供一个闭包来实例化正在解码的对象。

class Team extends Coding {
  List<Person> members;
  Person manager;

  @override
  void decode(KeyedArchive object) {
    super.decode(object); // 必须调用父类的解码方法

    members = object.decodeObjects("members", () => Person());
    manager = object.decodeObject("manager", () => Person());
  }

  @override
  void encode(KeyedArchive object) {
    object.encodeObject("manager", manager);
    object.encodeObjects("members", members);
  }
}

示例：编码和解码嵌套对象

final team = Team()
  ..manager = Person()..name = "John"
  ..members = [
    Person()..name = "Alice",
    Person()..name = "Bob"
  ];

final archive = KeyedArchive.archive(team);
final json = jsonEncode(archive);
print(json); // 输出嵌套的JSON数据

动态类型转换

对于带有原始类型参数（例如 List<String> 或 Map<String, int>）的类型，在解码时可能会遇到问题。可以通过重写 Coding 类中的 castMap 方法来进行类型强制转换。

import 'package:codable/cast.dart' as cast;

class Container extends Coding {  
  List<String> things;

  @override
  Map<String, cast.Cast<dynamic>> get castMap => {
    "things": cast.List(cast.String)
  };

  @override
  void decode(KeyedArchive object) {
    super.decode(object);

    things = object.decode("things");
  }

  @override
  void encode(KeyedArchive object) {
    object.encode("things", things);
  }
}

示例：动态类型转换

final container = Container()
  ..things = ["apple", "banana"];

final archive = KeyedArchive.archive(container);
final json = jsonEncode(archive);
print(json); // 输出 {"things": ["apple", "banana"]}

文档引用

Coding 对象可以在文档中多次引用而不重复结构。通过 $key 键来引用对象。

示例：引用对象

final person = Person()..name = "Alice";
final archive = KeyedArchive.archive(person);
final json = jsonEncode(archive);
print(json); // 输出 {"name": "Alice"}

// 引用同一个对象
final refJson = '{"$ref": "#/person"}';
final refArchive = KeyedArchive.unarchive(jsonDecode(refJson));
final refPerson = Person()..decode(refArchive);
print(refPerson.name); // 输出 "Alice"