首页
/ Riverpod 3.0 重大变更:Ref API 重构与迁移指南

Riverpod 3.0 重大变更:Ref API 重构与迁移指南

2025-06-02 18:55:50作者:滑思眉Philip

核心变更概述

Riverpod 作为 Flutter 状态管理库的标杆,即将迎来 3.0 版本的重大架构调整。本次重构的核心目标是简化 API 设计,将原先分散在 Ref 上的功能进行合理拆分和重新组织。最显著的变化是:

  • 废弃 Ref 的类型参数(使其变为可选)
  • 将状态监听等职责迁移到 Notifier 体系
  • 标记 Ref 为密封类(@sealed)
  • 停止生成 MyProviderRef 类型

被废弃的 API 清单

以下 Ref 相关功能将在 3.0 版本中被移除:

  1. Ref 的类型参数(如 Ref<String>
  2. Ref 的状态相关方法:
    • .state
    • .future
    • .notifier
    • .listenSelf
  3. 所有 Ref 的子类
  4. 代码生成器产生的 MyProviderRef 类型

迁移策略详解

1. 监听自身状态的变化

旧版本中,我们通常在 Provider 内使用 ref.listenSelf 来监听状态变化:

final routerProvider = Provider<GoRouter>((ref) {
  ref.listenSelf((previous, next) {
    debugPrint("路由状态变化");
    debugPrint('从 $previous 变为 $next');
  });
});

新版本中,这类功能将迁移到 Notifier 体系。对于需要监听自身状态的场景,应该转换为类形式的 Provider:

@riverpod
class RouterObserver extends _$RouterObserver {
  @override
  String build() {
    listenSelf((previous, next) {
      debugPrint("路由状态变化");
      debugPrint('从 $previous 变为 $next');
    });
    return '初始状态';
  }
}

2. 状态访问方式的改变

原先通过 ref.state 访问的状态,现在应该通过 Notifier 的 state 属性直接访问:

// 旧方式
final value = ref.state;

// 新方式(在 Notifier 子类中)
final value = state;

3. 异步状态处理

对于异步状态,不再使用 ref.future,而是应该:

// 在 AsyncNotifier 中直接使用 future 属性
final data = await future;

架构设计理念

这次重构体现了 Riverpod 团队对单一职责原则的贯彻:

  1. 职责分离:将状态管理(Notifier)与依赖引用(Ref)的职责明确划分
  2. 简化核心:Ref 回归其本质 - 作为获取其他 provider 的引用工具
  3. 类型安全:通过代码生成确保类型安全,而非依赖运行时类型参数

迁移时间规划

建议开发者:

  1. 立即开始适配新 API,使用 // ignore: deprecated_member_use 临时抑制警告
  2. 逐步将现有 Provider 迁移到类形式
  3. 利用 Riverpod 的代码生成工具自动处理大部分迁移工作

常见问题解决方案

Q:我的现有代码大量使用了 Ref 子类怎么办?

A:逐步将这些自定义逻辑迁移到 Notifier 的 build 方法中,或通过组合多个简单 Provider 来实现。

Q:类型参数移除后如何保证类型安全?

A:代码生成器(riverpod_generator)会在编译期确保类型正确,这比运行时的类型参数更可靠。

Q:是否必须立即迁移?

A:不是强制性的,但建议在新项目中直接使用新 API,旧项目可以分阶段迁移。

这次架构调整虽然带来了一些迁移成本,但从长期来看将使 Riverpod 的 API 更加清晰、易于维护,并为未来的功能扩展打下坚实基础。理解这些变化背后的设计理念,将帮助开发者更好地运用这个强大的状态管理库。

登录后查看全文
热门项目推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
861
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K