Riverpod中ref.listen在前后值相同时仍被调用的异常问题

核心原因 #

Riverpod 的 ref.listen 默认不会自动过滤前后相等的状态更新——只要 Provider 的状态被重新设置（哪怕新值和旧值完全一致），监听器就会被触发，而非仅在值真正变化时执行。

场景分析 #

• 首次触发：初始值为 null，Provider 更新为某个 MyObject 实例，previous != next，所以打印 false，符合预期。
• 后续多次触发：Provider 的状态被重复设置为与当前值相等的内容（可能是同一对象引用，或自定义类未正确重写 == 导致判断为相等），但因为状态被重新赋值，监听器依然触发，此时 previous == next，所以打印 true。

解决方案 #

1. 用 listenWhen 过滤触发条件

通过 listenWhen 参数手动指定监听器的触发规则，仅当前后值真正不同时执行逻辑：

ref.listen<MyObject?>(
  myObjectProvider,
  (previous, next) {
    debugPrint("showBottomSheet: ${previous == next}");
    // 在这里执行显示 bottomSheet 的逻辑
  },
  // 仅当前后值不相等时触发监听器
  listenWhen: (previous, next) => previous != next,
);

2. 确保自定义类正确重写 == 和 hashCode

如果 MyObject 是自定义类，必须重写这两个方法，才能让 previous != next 准确判断内容是否变化（而非仅判断对象引用）：

class MyObject {
  final String id;
  final String content;

  MyObject({required this.id, required this.content});

  @override
  bool operator ==(Object other) =>
      identical(this, other) ||
      other is MyObject &&
          runtimeType == other.runtimeType &&
          id == other.id &&
          content == other.content;

  @override
  int get hashCode => id.hashCode ^ content.hashCode;
}

3. 在状态管理源头上避免无效更新

如果使用 StateNotifier，可以在内部判断，仅当新状态与当前状态不同时才赋值，减少不必要的更新：

class MyObjectNotifier extends StateNotifier<MyObject?> {
  MyObjectNotifier() : super(null);

  void updateObject(MyObject? newObject) {
    if (state != newObject) {
      state = newObject;
    }
  }
}

内容的提问来源于stack exchange，提问作者DeKekem