跨平台开发 / 系统课时
用注解声明 Notifier 状态
用注解声明 Notifier 状态
当状态既要被界面读取,又需要通过明确的业务方法修改时,生成式 Notifier 能把“状态初始化”和“状态变更”放在同一个类里,同时让 Provider 声明保持简洁。本节用一个计数器完成声明、生成、调用与验证。
学习目标
- 使用
@riverpod和生成基类声明可修改的同步状态 - 区分
build()、state与公开业务方法各自的职责 - 通过生成代码和测试验证 Notifier 的读写行为
Notifier 的生成式写法
类上添加 @riverpod 后,需要继承生成器提供的 _$类名。build() 返回初始状态,Riverpod 会据此推断状态类型;类中的公开方法负责修改 state。这种结构适合购物车数量、筛选条件、表单草稿等“有状态且有业务动作”的场景。
下面是完整的 lib/counter.dart:
import 'package:riverpod_annotation/riverpod_annotation.dart';
part 'counter.g.dart';
@riverpod
class Counter extends _$Counter {
@override
int build() => 0;
void increment() {
state++;
}
void reset() {
state = 0;
}
}这是完整文件示例,但它依赖代码生成得到的 counter.g.dart。不要手写 _$Counter 或 counterProvider,它们属于生成结果。
生成 Provider 代码
如果工程还没有代码生成依赖,在项目根目录执行:
flutter pub add flutter_riverpod riverpod_annotation
flutter pub add --dev riverpod_generator build_runner预期结果
依赖解析成功,pubspec.yaml 中包含 Riverpod 注解与代码生成相关依赖保存 counter.dart 后执行:
dart run build_runner build --delete-conflicting-outputs预期结果
命令正常结束,并生成 lib/counter.g.dart构建日志中的耗时和生成条目数量会随工程变化。生成后,业务代码使用的是 counterProvider,而不是直接实例化 Counter。
从界面读取和修改状态
界面需要当前值时监听 Provider,需要触发动作时读取 .notifier:
final count = ref.watch(counterProvider);
ref.read(counterProvider.notifier).increment();上面是片段示例,依赖 ConsumerWidget、ConsumerState 或其他可获得 WidgetRef/Ref 的上下文。读取状态和执行动作分开后,界面不需要知道 state 如何维护,业务方法也能保持可测试。
用测试验证状态变化
下面的 test/counter_test.dart 可以直接验证初始值和业务方法:
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_test/flutter_test.dart';
import '../lib/counter.dart';
void main() {
test('Counter increments and resets', () {
final container = ProviderContainer();
expect(container.read(counterProvider), 0);
container.read(counterProvider.notifier).increment();
expect(container.read(counterProvider), 1);
container.read(counterProvider.notifier).reset();
expect(container.read(counterProvider), 0);
container.dispose();
});
}执行:
flutter test test/counter_test.dart预期输出
00:00 +1: All tests passed!测试运行时间前缀可能不同,但应有 1 个测试通过且无失败。
让业务方法承担状态规则
不要在 Widget 中到处写“读旧值、计算新值、再赋值”的逻辑。诸如“数量不能小于 0”“只有登录用户才能收藏”这类规则应集中在 Notifier 方法中。build() 主要负责建立初始状态和声明依赖,公开方法负责后续变更;这样生成式 Provider 只是入口,真正的业务边界仍然清晰可维护。