Riverpod使用Freezed copyWith更新未变更状态却触发重建问题

问题描述 #

原本认为Riverpod仅会在状态值发生变化时触发组件重建，但实际发现即便状态值未改变，每次设置状态时都会触发重建。具体案例中TestWidget每秒都会重建，即便state == cloneState返回true，这与预期不符，请问遗漏了什么？

复现代码 #

@Freezed(genericArgumentFactories: true)
class Model with _$Model {
  const factory Model({required int id}) = _Model;
}

class Manager {
  static StateProvider<Model> modelProvider =
      StateProvider<Model>((ref) => Model(id: 1));
  Manager() {
    Stream.periodic(Duration(seconds: 1)).take(1000).listen((event) {
      ref.read(modelProvider.notifier).update((state) {
        var cloneState = state.copyWith();
        print("${state == cloneState}"); // 打印true
        return cloneState;
      });
    });
  }
}

class TestWidget extends ConsumerWidget {
  const TestWidget();

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    var model = ref.watch(Manager.modelProvider);
    print("model change......................"); // 每秒打印一次
    return Text(model.id.toString());
  }
}

原因与解决方案 #

核心原因 #

Riverpod的StateProvider默认行为是只要调用update或直接赋值state，就会触发所有监听者的通知，不会自动对比新旧状态的相等性。即使新状态和旧状态的内容完全一致（如你的cloneState和原state），只要是新的对象实例，StateProvider依然会通知监听者，导致组件重建。

解决方案 #

有两种常见方式实现“仅状态实际变更时触发重建”：

1. 手动添加相等性判断
   在update方法中先对比新旧状态，只有当两者不相等时才返回新状态，否则返回原状态：

ref.read(modelProvider.notifier).update((state) {
  var cloneState = state.copyWith();
  if (state == cloneState) {
    return state; // 状态未变更，返回原对象，跳过通知
  }
  return cloneState;
});

2. 使用更精细化的状态管理类
   如果需要长期维护的复杂状态，推荐使用StateNotifier替代StateProvider。StateNotifier允许你在内部控制状态更新逻辑，只有当状态真正变化时才调用state = newValue：

class ModelNotifier extends StateNotifier<Model> {
  ModelNotifier() : super(Model(id: 1));

  void updateModel() {
    final cloneState = state.copyWith();
    if (state != cloneState) { // 手动判断相等性
      state = cloneState;
    }
  }
}

// 定义Provider
final modelProvider = StateNotifierProvider<ModelNotifier, Model>((ref) => ModelNotifier());

补充说明 #

Freezed生成的类默认实现了值相等性（即==会比较对象的所有字段内容，而非内存地址），所以你的state == cloneState判断是有效的，但StateProvider本身不会利用这个判断来优化通知逻辑，需要开发者手动处理。

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