跨平台开发 / 系统课时

用 ref.listen 处理副作用

用 ref.listen 处理副作用

本篇解决状态变化后执行提示、跳转、日志记录等副作用的问题。通过 ref.listen 可以监听 Provider 状态变化,并把非界面输出逻辑从 build 方法中分离出来。

学习目标

  • 理解 ref.listen 处理副作用的使用场景
  • 掌握监听状态变化并执行操作的方法
  • 避免在 build 中直接触发不可控副作用

为什么需要 ref.listen

Flutter 的 build 方法应该主要负责描述界面。如果在 build 中直接弹提示、跳转页面或发送请求,可能因为多次重建导致副作用重复执行。

ref.listen 专门用于观察 Provider 变化。当监听到新旧状态发生变化时,可以执行一次额外动作,例如显示 SnackBar、记录日志或进入下一页面。

在 ConsumerWidget 中监听状态变化

下面示例监听登录状态。当用户登录成功时触发提示,而不是让界面构建过程负责执行提示逻辑。

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

final loginProvider = StateProvider<bool>((ref) => false);

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

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    ref.listen<bool>(loginProvider, (previous, next) {
      if (next == true) {
        // 状态变化后执行一次副作用
        ScaffoldMessenger.of(context).showSnackBar(
          const SnackBar(content: Text('登录成功')),
        );
      }
    });

    return Scaffold(
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            ref.read(loginProvider.notifier).state = true;
          },
          child: const Text('登录'),
        ),
      ),
    );
  }
}

预期结果

text
点击“登录”按钮后,loginProvider 从 false 变为 true。
页面显示一次“登录成功”提示。

ref.listen 的使用边界

ref.listen 适合处理没有直接界面返回值的行为,例如:

  • 显示消息提示
  • 根据状态变化跳转页面
  • 上报业务事件
  • 输出调试日志

如果目标是显示状态本身,应使用 ref.watch。监听只是为了捕获变化并执行额外动作,不应该替代正常的数据绑定。

处理监听逻辑时的注意事项

监听回调中应避免修改同一个状态形成循环。例如监听 A 状态后立即修改 A 状态,可能导致连续触发。

对于需要在页面生命周期内管理的监听,可以使用 ConsumerStatefulWidget 或在 Provider 生命周期中组织监听逻辑,让副作用的创建和销毁更加明确。

合理使用 ref.listen 可以让界面代码保持纯粹:watch 负责展示,read 负责主动操作,listen 负责响应变化后的额外行为。

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

目录与阅读设置

阅读设置

17

记录一个想法

用 ref.listen 处理副作用

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

登录哪都通