0Pricing
Dart Academy · 课时

使用 build_runner 生成代码

根据注解生成样板代码

使用 build_runner 生成代码 是 CoddyKit 上的免费 Dart Academy 课时。 这是第 3 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Dart Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Dart Academy 课程共包含 4 节课。

为什么要生成代码

有些代码是重复性的样板代码,例如 JSON 解析。代码生成器可以根据注解为您编写这些代码,让您保持准确并提高效率。⚙️

认识 build_runner

build_runner 是 Dart 用来在项目中运行代码生成器的工具。它会读取源文件、查找注解,并生成新文件。

开发依赖

请将构建运行器添加到 pubspec.yaml 的开发依赖中,因为它会在构建时运行,绝不会随您的应用一起发布。

dev_dependencies:
  build_runner: ^2.4.0

生成的部分文件

生成器会写入一个同级文件。您可以使用部分指令链接到它,按照惯例,文件名以 .g.dart 结尾。

part 'user.g.dart';

运行构建

使用构建命令触发一次性生成。它会扫描您的代码,并创建或刷新每个 .g.dart 文件。

dart run build_runner build

监视模式

在开发期间,启用监视模式后,每次保存文件都会自动重新生成。这样无需手动重复运行,就能让生成的文件保持同步。

dart run build_runner watch

处理过时冲突

如果输出内容与旧文件发生冲突,请添加 --delete-conflicting-outputs。它会清除过时的生成文件,让全新的构建顺利完成。

dart run build_runner build --delete-conflicting-outputs

注解驱动生成

生成器只会处理您添加了注解的声明。注解会告诉构建器要处理哪个类,以及要生成什么代码。

不要编辑生成的文件

请将每个 .g.dart 文件视为只读文件。下一次构建会覆盖您的修改,因此请改动源代码和注解。

提交还是忽略

团队可以选择提交生成的文件,也可以将它们添加到 .gitignore 中,并在持续集成环境里重新构建。无论选择哪种方式,都请确定一项策略并始终保持一致。

更广阔的生态系统

许多软件包都能接入构建运行器,例如 JSON 序列化器和 freezed。它们共享一条构建器流水线,因此一条命令就能运行全部工具。

快速检查

哪个命令会在每次保存文件时重新生成代码?

回顾

构建运行器会将注解转换为生成的 .g.dart 文件。请将它添加到开发依赖中,运行构建或监视命令,并且永远不要编辑输出文件。🎉

常见问题解答

「使用 build_runner 生成代码」课时是免费的吗?

是的 — 「使用 build_runner 生成代码」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Dart Academy 课程的其余内容,请升级到 CoddyKit PRO。 Dart Academy 课程共包含 4 节课。

「使用 build_runner 生成代码」这节课中我会学到什么?

根据注解生成样板代码 你通过在浏览器中直接运行的动手代码来练习 Dart Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Dart Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 Dart Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 3 节课,共 4 节。

「使用 build_runner 生成代码」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 Dart Academy 课中编写并运行代码吗?

能。每节 Dart Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 内置注解:override、deprecated
  2. 编写自定义注解
  3. 使用 build_runner 生成代码
  4. json_serializable 实战
← 返回 Dart Academy