Flutter地图数据生成插件mapify_generator的使用

本文将介绍如何使用 mapify_generator 插件来生成对象之间的映射代码。该库可以帮助我们自动处理相似对象之间的映射，从而减少重复代码并提高开发效率。

使用场景

在实现干净架构（Clean Architecture）时，通常会在不同层之间定义类似的类结构。例如，我们可能在不同的包中定义了输入对象和输出对象，但它们的字段完全相同或部分相同。通过使用 mapify_generator，我们可以轻松地生成这些对象之间的映射逻辑。

示例代码

输入对象

假设我们有一个 Account 类，用于表示用户账户信息：

class Account {
  final String id;
  final List<String> activeMemberIds;
  final List<Member> members;

  const Account({
    required this.id,
    required this.activeMemberIds,
    required this.members,
  });
}

输出对象

在其他包中，我们可能需要定义与 Account 类对应的实体类（AccountEntity）和数据传输对象（AccountDto）：

class AccountEntity {
  final String id;
  final List<String> activeMemberIds;
  final List<Member> members;

  const AccountEntity({
    required this.id,
    required this.activeMemberIds,
    required this.members,
  });
}

class AccountDto {
  final String id;
  final List<String> activeMemberIds;
  final List<MemberDto> members;

  const AccountDto({
    required this.id,
    required this.activeMemberIds,
    required this.members,
  });
}

定义映射器

为了生成 Account 到 AccountEntity 和 AccountDto 的映射代码，我们需要创建一个新的 Dart 文件，并添加以下代码：

import 'package:example_api/example_api.dart'; // 引入输出对象所在的包
import 'package:example_core/example_core.dart'; // 引入输入对象所在的包
import 'package:mapify/mapify.dart'; // 引入 mapify_generator 库

// 如果有依赖关系，可以导入子映射文件
import 'member.dart';

// 指定生成的映射文件名
part 'account.g.dart';

// 定义映射器类
@GenerateMapping(
  outputType: [ // 指定目标输出类型
    AccountDto,
    AccountEntity,
  ],
  inputType: Account, // 指定输入类型
)
class AccountMapper extends MappingManager<Account> {
  AccountMapper(super.input); // 构造函数接收输入对象
}

运行生成器

在包含 AccountMapper 的项目中运行以下命令以生成映射代码：

flutter pub run build_runner build --delete-conflicting-outputs

生成完成后，account.g.dart 文件将会自动生成 AccountMapper 类的映射逻辑。

生成结果示例

假设生成的 account.g.dart 文件内容如下：

extension AccountMapperExtension on Account {
  AccountDto toDto() {
    return AccountDto(
      id: id,
      activeMemberIds: activeMemberIds,
      members: members.map((e) => e.toDto()).toList(),
    );
  }

  AccountEntity toEntity() {
    return AccountEntity(
      id: id,
      activeMemberIds: activeMemberIds,
      members: members.map((e) => e.toEntity()).toList(),
    );
  }
}

通过上述代码，我们现在可以直接调用 toDto() 或 toEntity() 方法来完成对象之间的映射。

使用示例

以下是使用生成的映射方法的示例代码：

void main() {
  // 创建一个 Account 对象
  final account = Account(
    id: "123",
    activeMemberIds: ["m1", "m2"],
    members: [
      Member(name: "Alice"),
      Member(name: "Bob"),
    ],
  );

  // 调用生成的映射方法
  final dto = account.toDto();
  final entity = account.toEntity();

  print("DTO: $dto");
  print("Entity: $entity");
}