跨平台开发 / 系统课时
接入 riverpod_generator 工具链
接入 riverpod_generator 工具链
Riverpod 的代码生成并不是运行时功能,而是一条“注解源码 → build_runner → .g.dart 产物”的构建链。本节把依赖、最小源码、一次性生成和持续监听串起来,最终能稳定更新生成文件,并知道哪些文件应该手写、哪些文件不该修改。
学习目标
- 正确区分运行时依赖与代码生成开发依赖
- 跑通
build_runner并生成对应的.g.dart文件 - 掌握一次性生成与持续监听两种更新方式
理清代码生成链路
riverpod_annotation 提供 @riverpod 等注解,属于源码编译需要的运行时依赖;riverpod_generator 负责读取注解并产出 Provider 代码,build_runner 负责调度生成器,因此后二者放在开发依赖中。Flutter 项目还需要 flutter_riverpod 来在界面层使用 Riverpod。

安装所需依赖
在 Flutter 项目根目录执行下面的命令,让 pub 解析一组彼此兼容的版本。这里不手写版本号,可以避免示例与项目当前 SDK 约束不一致。
flutter pub add flutter_riverpod riverpod_annotation
flutter pub add --dev build_runner riverpod_generator预期结果
依赖解析成功,pubspec.yaml 中出现 flutter_riverpod、riverpod_annotation、build_runner 和 riverpod_generator。具体下载日志与版本号会随项目环境不同而变化。如果项目原本已经安装 flutter_riverpod,重复执行不会改变用法;重点是确保注解包与两个生成工具都存在。
准备一个可生成的源文件
仅安装依赖不会凭空产生 .g.dart。需要先在手写文件中声明 part,再提供至少一个带 @riverpod 的函数。下面是 lib/app_name.dart 的片段示例,它依赖刚安装的包,并由生成器补齐 app_name.g.dart。
import 'package:riverpod_annotation/riverpod_annotation.dart';
part 'app_name.g.dart';
@riverpod
String appName(Ref ref) {
return 'Anystack';
}生成后,代码中会得到名为 appNameProvider 的 Provider。不要手工创建或编辑 app_name.g.dart,因为下一次生成会重新写入该文件。
生成并持续更新产物
第一次接入时先执行一次构建,确认工具链完整。
dart run build_runner build -d预期结果
构建命令正常结束,并生成 lib/app_name.g.dart。build_runner 的具体日志行数、耗时和缓存提示会因版本与项目状态不同而变化。参数 -d 是删除冲突生成产物的快捷选项,适合生成文件与当前源码不一致时重新建立产物。若团队把 .g.dart 纳入版本控制,也应在提交前重新生成,避免手写源码与生成文件不同步。
开发期间可以把一次性 build 换成 dart run build_runner watch -d。该进程会持续监听源码变化;保存带注解的文件后,相应 .g.dart 会自动刷新,直到主动结束监听进程。验收重点不是某一行构建日志,而是生成文件能随源文件稳定更新。