Riverpod Provider传递多命名参数的正确方式及缓存方案

你遇到的核心问题是：Riverpod中带参数的Notifier默认是Family Provider，每个参数组合对应一个独立的Provider实例。当某个参数组合的实例不再被任何组件监听时，Riverpod会自动销毁它，导致之前的请求结果缓存丢失。

要让不同参数对应的请求结果都能被缓存且不被销毁，有两种常用方案：

方案一：永久保留所有参数组合的缓存 #

直接在Notifier类中设置keepAlive属性为true，这样每个参数组合的实例即使没有监听者，也会一直保持存活，缓存不会被清理：

@riverpod
class FetchProducts extends _$FetchProducts {
  // 开启永久存活，保留所有参数组合的缓存
  @override
  bool get keepAlive => true;

  @override
  Future<List<Product>> build({
    required String? specificProductId,
    required String? clientUid,
  }) async {
    if (specificProductId != null) {
      // 执行Network request-1
      return await yourApiClient.fetchProductById(specificProductId);
    } else if (clientUid != null && clientUid.isNotEmpty) {
      // 执行Network request-2
      return await yourApiClient.fetchProductsByClient(clientUid);
    } else {
      // 执行Network request-3
      return await yourApiClient.fetchAllProducts();
    }
  }
}

这种方式简单直接，但要注意：如果参数组合非常多，可能会占用较多内存，适合参数组合有限的场景。

方案二：带超时的智能缓存 #

如果不想永久保留所有缓存，可以结合ref.keepAlive()和定时器，实现“无监听时延迟销毁，重新监听时取消销毁”的逻辑，兼顾缓存和内存占用：

@riverpod
class FetchProducts extends _$FetchProducts {
  @override
  Future<List<Product>> build({
    required String? specificProductId,
    required String? clientUid,
  }) async {
    // 让实例暂时保持存活
    final keepAliveLink = ref.keepAlive();
    Timer? cleanupTimer;

    // 组件取消监听时，启动5分钟后销毁的定时器
    ref.onCancel(() {
      cleanupTimer = Timer(const Duration(minutes: 5), () {
        keepAliveLink.close(); // 关闭存活链接，实例会被销毁
      });
    });

    // 组件重新监听时，取消销毁定时器
    ref.onResume(() {
      cleanupTimer?.cancel();
    });

    // 清理资源
    ref.onDispose(() {
      cleanupTimer?.cancel();
    });

    // 网络请求逻辑
    if (specificProductId != null) {
      return await yourApiClient.fetchProductById(specificProductId);
    } else if (clientUid != null && clientUid.isNotEmpty) {
      return await yourApiClient.fetchProductsByClient(clientUid);
    } else {
      return await yourApiClient.fetchAllProducts();
    }
  }
}

这种方式下，当某个参数组合的实例没有监听者时，会等待5分钟后销毁；如果在这期间有组件再次使用该参数组合，定时器会被取消，缓存继续保留。

关键原理说明 #

Riverpod的Family Provider会根据你传入的参数生成唯一的实例标识，不同参数组合对应不同的实例。通过keepAlive相关配置，我们可以控制这些实例的生命周期，避免未被监听时被立即销毁，从而保留对应的请求结果缓存。

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