跨平台开发 / 系统课时

用 ConsumerWidget 读取状态

用 ConsumerWidget 读取状态

当一个页面的大部分构建逻辑都要读取 Riverpod 状态时,ConsumerWidget 比在普通 Widget 中反复嵌套 Consumer 更直接。本节将使用 WidgetRef 在 build 中读取 Provider,并说明 watch、read 的使用边界。

学习目标

  • 能把普通无状态页面改写为 ConsumerWidget
  • 能通过 WidgetRef 和 ref.watch 读取 Provider
  • 能判断 watch 与 read 应放在什么位置

ConsumerWidget 多了什么

ConsumerWidget 的使用方式与 StatelessWidget 很接近,核心差异是 build 多了一个 WidgetRef ref 参数。这个 ref 是 Widget 与 Riverpod Provider 体系之间的访问入口。

dart
class ExamplePage extends ConsumerWidget {
  const ExamplePage({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final value = ref.watch(exampleProvider);
    return Text(value);
  }
}

只要页面本身需要读取 Provider,就可以直接继承 ConsumerWidget,不必再额外包一层 Consumer。

在 build 中读取 Provider

下面定义一个只读 Provider,并在 HomePage 的 build 中读取。完整示例包含 ProviderScope,可以直接放进 Flutter 项目的 lib/main.dart 运行。

dart
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';

final greetingProvider = Provider<String>((ref) {
  return '欢迎使用 Riverpod';
});

void main() {
  runApp(
    const ProviderScope(
      child: MyApp(),
    ),
  );
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends ConsumerWidget {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    // watch 会读取值,并让当前 Widget 订阅该 Provider。
    final greeting = ref.watch(greetingProvider);

    return Scaffold(
      appBar: AppBar(
        title: const Text('ConsumerWidget'),
      ),
      body: Center(
        child: Text(greeting),
      ),
    );
  }
}

预期结果

text
应用启动后,顶部标题显示“ConsumerWidget”,页面中央显示:
欢迎使用 Riverpod

实际设备的窗口尺寸、字体和系统样式可能不同,但两处文本应一致。

watch 与 read 不要混用

ref.watch 适合放在 build 中读取需要展示的状态,因为它会建立响应式依赖。Provider 的结果变化时,Riverpod 能让依赖该结果的 Widget 重新构建。

ref.read 更适合事件回调中的一次性访问,例如按钮点击时调用某个 Notifier 的方法。把 read 用来渲染页面,通常意味着当前 Widget 不会订阅后续变化。

WidgetRef 的使用边界

WidgetRef 由 Riverpod 在构建 Widget 时提供,不要把它保存成全局变量或长期字段。需要读取状态时,在 build 或事件回调所在的 Widget 上下文中使用当前 ref 即可。

如果只有页面中的很小一块区域依赖 Riverpod,普通 Widget 加局部 Consumer 可以缩小重建范围;如果整个页面都频繁读取 Provider,ConsumerWidget 通常更简洁。选择哪一种并不改变 Provider 本身,区别只在于 Widget 从哪里获得 WidgetRef。

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

目录与阅读设置

阅读设置

17

记录一个想法

用 ConsumerWidget 读取状态

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

登录哪都通