Flutter代码管理与执行插件tridev_codeunit的使用

tridev_codeunit 是一个用于将动态数据编码和解码为Dart对象的库。本文档将详细介绍如何使用该库。

基本用法

数据对象需要扩展 Coding 类：

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);
  }
}

可以将扩展了 Coding 的对象从JSON读取：

final json = jsonDecode('{"name": "Alice"}');
final archive = KeyedArchive.unarchive(json);
final person = Person()..decode(archive);

同样，这些对象也可以写入JSON：

final person = Person()..name = "Bob";
final archive = KeyedArchive.archive(person);
final json = jsonEncode(archive);

Coding 对象可以编码或解码其他 Coding 对象，包括 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);
  }
}

动态类型转换

具有原始类型参数的类型（例如 List<String> 或 Map<String, int>）在解码时是一个特别棘手的问题。可以在 Coding 中重写 castMap 方法以执行类型转换。 必须导入 package:codable/cast.dart as cast 并在类型名称前加上 cast 前缀。

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);
  }
}

文档引用

Coding 对象可以在文档中多次引用而不会重复其结构。对象通过 $key 键进行引用。 例如，考虑以下JSON：

{
  "components": {
    "thing": {
      "name": "The Thing"
    }
  },
  "data": {
    "$ref": "#/components/thing"
  }
}

上述情况下，data 解码后的值继承自 /components/thing 的所有属性：

{
  "$ref": "#/components/thing",
  "name": "The Thing"
}

可以通过 Coding.referenceURI 在内存数据结构中创建引用。

final person = Person()..referenceURI = Uri(path: "/teams/engineering/manager");

上面的 person 将被编码为：

{
  "$ref": "#/teams/engineering/manager"
}