Flutter未知功能插件d2p_gen的介绍（由于介绍为undefined，基于名称推测） Flutter数据生成或处理插件d2p_gen的使用

Flutter数据生成或处理插件d2p_gen的使用

d2p_gen 简介

d2p_gen 是一个用于自动生成 Protocol Buffer 文件（.proto）的 Dart 包。它通过利用 d2p_annotation 包提供的 Dart 代码注解来实现这一功能。该包简化了创建 .g.proto 文件、映射类及关联测试的过程，从而提高了在 Dart 项目中使用 Protocol Buffers 的效率。

使用理由

Protocol Buffers（简称 Proto）提供了紧凑的数据表示方式，与 JSON 相比，传输消息的大小可减少 3-5 倍。通过更高效的序列化和反序列化，使用 Proto 可以将数据交换速度提高 30-40%。Proto 的数据类型和严格的模式简化了开发过程，并提供了更强大的数据验证机制，使其成为分布式系统中的首选。

安装

要使用 d2p_gen，你需要设置典型的 [build_runner]/code-generator 配置。

首先，在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  d2p_annotation: any
  # 其他依赖项
dev_dependencies:
  d2p_gen: any

对于 Flutter 项目，运行以下命令：

flutter pub add d2p_annotation
flutter pub add dev:build_runner
flutter pub add dev:d2p_gen

对于 Dart 项目，运行以下命令：

dart pub add d2p_annotation
dart pub add dev:build_runner
dart pub add dev:d2p_gen

注解

在你希望接收通知的类上放置注解。

import 'package:d2p_annotation/d2p_annotation.dart';

@ProtoGen(createMappers: false)
class User {
  final String name;
  final int age;
  const User(this.name, this.age);
}

运行以下命令：

dart run build_runner build

该包会在项目的根目录下创建一个新的 proto 文件夹，并生成一个包含所有你的 Proto 消息的文件 messages.g.proto。对于上述类，生成的文件将如下所示：

syntax = "proto3";
package messages;
// -- 其他消息。
/*
  class: User
*/
message DTOUser {
    // String User.name
    string name = 1;
    // int User.age
    int32 age = 2;
}

如果你使用带有 createMappers 选项设置为 true 的 @ProtoGen 注解，则还会获得一个可以将生成的 Dart 代码转换为模型类以及反之的映射类。这些映射类总是保存在具有 .mp.dart 扩展名的单独文件中。

/// 映射器，将 DTO [DTOUser] 对象转换为模型 [User] 并反向转换。
abstract class $MapperUser {
  /// 将模型 [User] 转换为 DTO [DTOUser]。
  static User fromDTO(DTOUser model) {
    try {
      return User(
        model.name,
        model.age,
      );
    } on FormatException catch (e, trace) {
      throw FormatException(
        '''异常
      ${e.source}
      ${e.message}
      $trace''',
      );
    }
  }

  /// 将模型 [User] 转换为 DTO [DTOUser]。
  static DTOUser toDTO(User model) {
    try {
      return DTOUser(
        name: model.name,
        age: model.age,
      );
    } on FormatException catch (e, trace) {
      throw FormatException(
        '''异常
      ${e.source}
      ${e.message}
      $trace''',
      );
    }
  }
}

为了确保映射函数正常运行，工具还会为每个映射函数生成测试用例。

group(r'测试 $MapperUser 方法', () {
  // 测试返回 DTO 类的 toDTO 方法
  test(r'$MapperUser.toDTO 输出类 User 应为 DTOUser', () {
    // 准备 - 设置事实、预期输出或初始化
    final model = User(
      'ZymI7ohW2Dq9XeUE',
      49,
    );

    // 操作 - 调用要测试的函数
    final dto = $MapperUser.toDTO(model);

    // 断言 - 比较实际结果和预期结果
    // 检查输出是否为预期类型
    expect(
      dto,
      TypeMatcher<DTOUser>(),
      reason: '输出应为 DTOUser 类型',
    );
    // 检查输出是否不为空
    expect(
      dto,
      isNotNull,
      reason: '输出不能为空',
    );
    // 检查输出是否不是异常
    expect(
      dto,
      isNot(isException),
      reason: '输出不能是异常',
    );
  });

  // 测试返回 Dart 数据类或枚举的 fromDTO 方法
  test(r'$MapperUser.fromDTO 输出类 User 应为 User', () {
    // 准备 - 设置事实、预期输出或初始化
    final dto = DTOUser(
      name: '8O',
      age: 48,
    );

    // 操作 - 调用要测试的函数
    final model = $MapperUser.fromDTO(dto);

    // 断言 - 比较实际结果和预期结果
    // 检查输出是否为预期类型
    expect(
      model,
      TypeMatcher<User>(),
      reason: '输出应为 User 类型',
    );
    // 检查输出是否不为空
    expect(
      model,
      isNotNull,
      reason: '输出不能为空',
    );
    // 检查输出是否不是异常
    expect(
      model,
      isNot(isException),
      reason: '输出不能是异常',
    );
  });
});

一旦所有相关的文件都被创建，映射器的测试将自动开始。然后你会看到类似于以下屏幕的结果。

🎉 2 tests passed.