source_gen 项目教程

项目介绍

source_gen 是一个用于 Dart 语言的源代码生成工具。它提供了一个框架，用于编写生成器（Generators），这些生成器可以自动生成 Dart 源代码。source_gen 基于 build 包，使得开发者可以轻松地在构建系统中集成代码生成功能。

项目快速启动

安装依赖

首先，在你的 Dart 项目中添加 source_gen 依赖：

dependencies:
  source_gen: ^1.5.0

创建生成器

创建一个新的 Dart 文件，例如 my_generator.dart，并实现一个简单的生成器：

import 'package:source_gen/source_gen.dart';
import 'package:build/build.dart';

class MyGenerator extends Generator {
  @override
  String generate(LibraryReader library, BuildStep buildStep) {
    return '// 这是自动生成的代码';
  }
}

配置构建

在项目的根目录下创建一个 build.yaml 文件，配置 source_gen 使用你的生成器：

builders:
  my_builder:
    import: "package:my_package/my_generator.dart"
    builder_factories: ["myGeneratorBuilder"]
    build_extensions: {".dart": [".g.dart"]}
    auto_apply: root_package
    build_to: source

运行构建

使用 build_runner 运行构建：

pub run build_runner build

应用案例和最佳实践

应用案例

假设你有一个数据模型类，你希望自动生成它的 JSON 序列化代码。你可以使用 source_gen 和 json_serializable 包来实现这一点。

import 'package:json_annotation/json_annotation.dart';

part 'my_model.g.dart';

@JsonSerializable()
class MyModel {
  final String name;
  final int age;

  MyModel(this.name, this.age);

  factory MyModel.fromJson(Map<String, dynamic> json) => _$MyModelFromJson(json);
  Map<String, dynamic> toJson() => _$MyModelToJson(this);
}

最佳实践

1. 保持生成器简单：确保生成器只做一件事，并且做得好。
2. 使用注解：利用 Dart 的注解系统来标记需要生成代码的元素。
3. 测试生成器：编写单元测试来确保生成器的行为符合预期。

典型生态项目

source_gen 通常与其他 Dart 生态项目一起使用，例如：

• build_runner：用于运行构建过程的工具。
• json_serializable：用于自动生成 JSON 序列化和反序列化代码。
• inject：用于依赖注入的代码生成。

这些工具和库与 source_gen 结合使用，可以大大提高 Dart 项目的开发效率和代码质量。