Flutter地图数据映射生成插件map_mapper_generator的使用

map_mapper_generator

该包及其配套的map_mapper_annotations包旨在显著减少将Dart业务模型类暴露给NoSQL数据库存储库的工作量。这些存储库以Map<String, dynamic>形式持久化数据，而不是强类型对象。

该项目深受json_serializable包的启发。然而，虽然序列化逻辑相对相似，但其暴露方式有所不同。json_serializable包生成私有方法，而本包则生成MapMapper<TEntity>的子类，该类包含一个将实例转换为Map<String, dynamic>的方法（Map<String, dynamic> toMap(TEntity instance)）和一个从Map<String, dynamic>恢复实体的方法（TEntity fromMap(Map<String, dynamic>) map）。

这种做法的目的是能够开发通用的服务处理代码，该代码能够处理任何类型的 TEntity，将其序列化并发送到数据库，或从数据库检索并反序列化。

具体来说，通过这种方法，更容易开发一个处理gRPC请求的通用混入（mixin），并处理典型的CRUD请求。

此外，生成的代码还定义了类扩展，使得在序列化的类中无需创建工厂构造函数。

例如，如果我们有一个 Recipe 类，只需添加 @mapMap 属性即可使其可序列化，而无需添加其他方法或工厂：

[@mapMap](/user/mapMap)
class Recipe {
  final String key;
  final String title;
  final List<Ingredient> ingredients;

  Recipe({
      this.key = '',
      required this.title,
      required this.ingredients,
  });

  // 不需要在此处添加支持序列化的代码
}

相反，由于生成的代码为 Recipe 和 Map<String, dynamic> 添加了扩展，序列化和反序列化变得非常简单：

final recipe = Recipe(/* 初始化参数 */);

// 这将创建一个包含属性的 Map<String, dynamic>
// 注意我们实际上不需要在 recipe 中添加 toMap() 方法，
// 因为在 recipe.g.dart 中已经创建了一个该方法的扩展。
final recipeMap = recipe.toMap();

// 这将重新创建一个 Recipe。
// 这也是可能的，因为我们还为 Map<String, dynamic> 添加了一个扩展，
// 该扩展添加了名为 toRecipe() 的方法。
final recipe2 = recipeMap.toRecipe();

多态性

多态性允许我们将超类类型的变量引用子类，并以这样的方式序列化对象，使序列化的Map包含所有子类属性以及类型标识符。这使得我们能够在仅事先知道超类类型的情况下反序列化子类对象。该包支持多态性，但有一个限制：所有支持的子类类型必须在生成时已知，并且用 MapMapped() 注解的 knownSubClasses 属性注册。

以下是一个示例：

@mapMapped
class Car extends Vehicle {
  Car({
    required this.numberOfDoors,
    required super.weight,
  });

  final int numberOfDoors;
}

@mapMapped
class Airplane extends Vehicle {
  Airplane({
    required super.weight,
    required this.wingspan,
  });

  final int wingspan;
}

// 注意我们正在识别所有已知的子类
@MapMapped(knownSubClasses: [
  Car,
  Airplane,
])
abstract class Vehicle { // 可以是非抽象的
  final int weight;
  Vehicle({
    required this.weight,
  });
}

void main() {
  final car = Car(numberOfDoors: 4, weight: 1500);
  final Vehicle airplane = Airplane(wingspan: 13, weight: 1500);

  final vehicles = <Vehicle>[car, airplane];
  // 从此处我们可以得到一个包含每个 Vehicle 序列化的列表
  final maps = vehicles.map((v) => v.toMap()).toList();

  // 注意我们调用了 .toVehicle，因为我们知道它们都是车辆
  final deserVehicles = maps.map((m) => m.toVehicle()).toList();

  final deserCar = deserVehicles[0] as Car; // 它真的是一个汽车
  final deserAirplane = deserVehicles[1] as Airplane; // 它真的是一个飞机

  print(deserCar.numberOfDoors); // 应该打印 4
  print(deserAirplane.wingspan); // 应该打印 13
}

入门指南

要开始使用，请查看示例项目：

https://gitlab.com/dartaculous/dartaculous/-/tree/main/map_mapper/example