Flutter代码生成插件superclass_generator的使用

在Flutter开发中，代码生成工具可以极大地提升开发效率。superclass_generator 是一个强大的代码生成插件，它可以帮助开发者自动生成代码，例如将类转换为部分类（partial class），并支持 Freezed 和 JSON 序列化的集成。

本文将通过一个完整的示例展示如何使用 superclass_generator 插件来生成代码。

示例代码说明

以下是一个完整的示例，展示了如何使用 superclass_generator 插件来自动生成代码。

示例代码结构

example/
├── lib/
│   ├── example.freezed.dart       // 自动生成的部分类文件
│   ├── example.superclass.dart    // 自定义的超类文件
│   ├── example.g.dart             // 自动生成的 JSON 序列化文件
│   └── example.dart               // 主程序入口
└── test/
    └── example_test.dart           // 单元测试文件

示例代码实现

1. 添加依赖

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

dependencies:
  freezed_annotation: ^0.15.2
  superclass: ^0.1.0

dev_dependencies:
  build_runner: ^2.1.7
  superclasses_generator: ^0.1.0
  freezed: ^0.15.2

然后运行 flutter pub get 来安装依赖。

2. 编写主代码

在 example/lib/example.dart 中编写如下代码：

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:superclass/superclass.dart';

part 'example.freezed.dart';   // 自动生成的部分类文件
part 'example.superclass.dart'; // 自定义的超类文件
part 'example.g.dart';          // 自动生成的 JSON 序列化文件

// 定义用户类
@freezed
class User with _$User {
  const factory User({
    required String name,
    int? age,
    required Profile profile,
  }) = _User;

  // 自动生成 JSON 反序列化方法
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
}

// 定义用户配置类
@freezed
class Profile with _$Profile {
  const factory Profile({required String bio}) = _Profile;

  // 自动生成 JSON 反序列化方法
  factory Profile.fromJson(Map<String, dynamic> json) =>
      _$ProfileFromJson(json);
}

// 使用 Superclass 注解生成超类
@Superclass(
  includeFreezed: true,         // 包含 Freezed 的功能
  includeJsonSerialization: true, // 包含 JSON 序列化功能
  classAnnotations: [Freezed()], // 添加 Freezed 注解
  apply: [
    MakePartial<User>(), // 将 User 类转换为部分类
  ],
)
typedef UserProfile = $UserProfile;

3. 生成代码

运行以下命令以生成所需的代码文件：

flutter pub run build_runner build

生成的文件包括：

• example.freezed.dart: 包含 Freezed 的部分类实现。
• example.superclass.dart: 包含自定义超类的实现。
• example.g.dart: 包含 JSON 序列化的实现。

4. 测试代码

在 example/test/example_test.dart 中编写单元测试代码：

import 'package:test/test.dart';
import 'package:example/example.dart';

void main() {
  group('User', () {
    test('can be created from JSON', () {
      final json = {
        "name": "John Doe",
        "age": 30,
        "profile": {"bio": "Software Engineer"},
      };

      final user = User.fromJson(json);

      expect(user.name, "John Doe");
      expect(user.age, 30);
      expect(user.profile.bio, "Software Engineer");
    });
  });
}

运行测试：

flutter test