跨平台开发 / 系统课时

用参数自动生成 family Provider

用参数自动生成 family Provider

同一份状态逻辑经常要按用户 ID、商品 ID 或查询条件分别维护实例。使用 Riverpod 代码生成时,不必手写 .family;只要让被注解的函数或 Notifier 的 build() 接收参数,生成器就会创建可按参数调用的 Provider。

学习目标

  • 通过带参数的 @riverpod 函数自动得到 family Provider
  • 理解不同参数组合为什么会对应独立的 Provider 实例
  • 避免使用不稳定的参数相等性导致缓存失效

直接把参数写进 Provider 函数

下面的完整 lib/greeting.dart 同时使用位置参数、命名参数和默认值:

dart
import 'package:riverpod_annotation/riverpod_annotation.dart';

part 'greeting.g.dart';

@riverpod
String greeting(
  Ref ref,
  String name, {
  String punctuation = '!',
}) {
  return 'Hello, $name$punctuation';
}

函数签名就是 family 的参数定义,不需要手写 Provider.family。如果工程还没有生成依赖,先执行:

bash
flutter pub add flutter_riverpod riverpod_annotation
flutter pub add --dev riverpod_generator build_runner

预期结果

text
依赖解析成功,pubspec.yaml 中包含 Riverpod 注解与代码生成相关依赖

保存文件后执行代码生成:

bash
dart run build_runner build --delete-conflicting-outputs

预期结果

text
命令正常结束,并生成 lib/greeting.g.dart

生成器会提供 greetingProvider。调用时直接把参数传给它:

dart
final normal = ref.watch(greetingProvider('Ada'));
final question = ref.watch(
  greetingProvider('Ada', punctuation: '?'),
);

这是片段示例,依赖可以使用 ref.watch 的 Riverpod 上下文。两个参数组合会得到彼此独立的 Provider 实例。

参数就是实例身份的一部分

可以把 family 理解为“以参数组合作为键的 Provider 集合”。greetingProvider('Ada') 与 greetingProvider('Bob') 不是同一个实例;即使 Provider 定义只有一份,它们也能分别缓存和刷新。

参数可以有多个,可以是位置参数、命名参数、可选参数,也可以带默认值。函数式 Provider 适合只计算或读取值;如果每个参数实例还需要公开修改方法,则把参数放进生成式 Notifier 的 build() 更合适,业务方法继续放在 Notifier 类中。

用测试确认实例按参数区分

下面的 test/greeting_test.dart 不依赖 Flutter 界面,直接读取三个参数组合:

dart
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_test/flutter_test.dart';

import '../lib/greeting.dart';

void main() {
  test('family provider separates parameter combinations', () {
    final container = ProviderContainer();

    expect(container.read(greetingProvider('Ada')), 'Hello, Ada!');
    expect(
      container.read(greetingProvider('Ada', punctuation: '?')),
      'Hello, Ada?',
    );
    expect(container.read(greetingProvider('Bob')), 'Hello, Bob!');

    container.dispose();
  });
}

执行:

bash
flutter test test/greeting_test.dart

预期输出

text
00:00 +1: All tests passed!

测试运行时间前缀可能不同,但三个断言都应通过。

参数类型要有稳定的相等性

family 会依据参数的 == 和 hashCode 判断是否是同一个键。String、int 等值类型通常很安全;自定义条件对象应保持不可变,并实现稳定的值相等逻辑。不要在每次构建时传入新建且按引用比较的可变对象,否则看起来“内容相同”的查询可能不断产生新实例。

生成式 family 的核心不是省掉一个 .family 单词,而是把“Provider 需要什么参数”直接写进函数签名或 build(),让调用方式、类型检查和状态实例边界保持一致。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用参数自动生成 family Provider

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通