Flutter数据流缓存插件cache_stream的使用

这个插件可以帮助你在应用中缓存数据，并在请求时从缓存中流式传输这些数据，即使在离线状态下也能提高你的应用速度并改善加载时间。

你可以使用该插件来缓存Dart框架支持的任何类型的数据。

特性

• 缓存任何类型的数据，以便离线使用或更快地渲染。
• 应用安装规则以验证每个被安装的流。
• 如果不再需要从缓存中卸载/刷新流。
• （可选）设置刷新率，以便在间隔内更新流。
• 强制刷新流以覆盖缓存。

使用

要使用此插件，在你的 pubspec.yaml 文件中添加 cache_stream 作为依赖项。

示例

导入库

import 'package:cache_stream/cache_stream.dart';

安装流

CacheStream cacheManager = CacheStream();

// 提供一个 Map<S,M<S,D>> 的已安装条目到缓存流
cacheManager.mount({
    'flights': {
        'data': () async {
            return await FlightController.index();
        },
        // 可选
        'rules': (data){
            return data['flight'].isNotEmpty;
        },
    },
    'tickets': {
        'data': () async {
            return await TicketController.index();
        },
        'rules': (data) => data.isNotEmpty,
    }

    // 每隔60秒刷新一次 | null
    // 你可以省略 Duration 或将其设置为 null 进行一次性操作

}, Duration(seconds: 60));

获取流

final flights = await cacheManager.stream(
    'flights', 
    fallback: () async {
        // 如果找不到流、网络错误或有错误发生
        return await FlightController.index();
    },
    // 可选
    callback: (data) {
        // 我们已经获取到了数据 - 所以让我们转换最终结果
        return flightToModel(data);
    }
);

如果你需要强制覆盖缓存以流式传输最新数据，则可以在方法中提供一个 refresh 标志。这将尝试从之前指定的源重新安装流。

final flights = await cacheManager.stream(
    'flights', 
    refresh: true,
    //...
);

卸载流

有三种基本方式可以卸载或刷新内存中的流。

// 卸载仅停止刷新计时器（如果在安装调用中设置了）
cacheManager.unmount();

// 卸载并刷新所有已安装的数据流
cacheManager.unmount({});

// 卸载并刷新先前已安装的特定流
cacheManager.unmount({
    'flights',
    'tickets'
});

注意事项

当试图缓存 Dart 对象时，CacheStream 将抛出致命异常。这是 Dart 预期的行为。要解决此问题，你需要在任何获取或返回对象模型的安装调用中定义一个 toJson 方法。

//flight.dart

//...
Map<String, dynamic> toJson() => {
    'id': id,
    'name': name,
    'departure': departure,
    'planeId': planeId,
    'organization': organization
};

限制

该插件不能在一个单一的流上安装 N(+1) 层。这意味着如果两个相同的流安装了“定时器”，只有最后一个安装的流会被监视（即为了避免应用程序中出现多个时间计数器）。

例如，如果我们有一个名为 “flights” 的流在 flightScreen.dart 中这样安装：

cacheManager.mount({
    'flights': {
        //...
    },
}, Duration(seconds: 60));

而在 ticketScreen.dart 中也安装了同一个流，但指定了不同的刷新计时器。

cacheManager.mount({
    'flights': {
        //...
    },
}, Duration(seconds: 30));

每次你从其中一个屏幕切换时，计时器会为当前屏幕重新安装，导致对同一流（如 “flights”）发出 2(+) 个总的刷新计时器，这可能会成为应用程序的负担或导致延迟，具体取决于流的上下文（如 API 调用或重量级 Future）。

为了避免这个问题，建议为流使用唯一的名称。但是，如果你确实需要再次安装流（可能为了获取新数据然后获取它），则不要在安装时设置刷新计时器或在调用流时使用 refresh 标志。

cacheManager.mount({
    'flights': {
        //...
    },
} /* Duration(seconds: 30) */); //<= 移除 Duration