Flutter文件缓存管理插件cache_manager的使用

Flutter 文件缓存管理插件 cache_manager 的使用

cache_manager 是一个用于处理 Flutter 应用程序缓存的强大工具。它为 iOS 和 Android 平台提供了支持。

安装

在 pubspec.yaml 文件中添加依赖项：

dependencies:
  cache_manager: ^<最新版本>

强大功能

缓存工具

• CacheManagerUtils.conditionalCache({key, valueType, actionIfNull, actionIfNotNull})

  根据缓存值进行条件构建。actionIfNull 和 actionIfNotNull 是动态参数，用于导航视图、渲染 UI、调试值等。valueType 表示缓存的数据类型（StringValue、BoolValue、IntValue、DoubleValue）。

• CacheManagerUtils.cacheTextBuilder(textStyle, cacheKey})

  用于缓存值的文本构建器。cacheKey 是用于寻址缓存的键。如果缓存缺失，将返回 ‘Invalid cache’。使用 textStyle 来设置缓存值的样式。

读取缓存

• ReadCache.getJson(key)：获取存储为缓存的 JSON。
• ReadCache.getString(key)：获取存储为缓存的字符串。
• ReadCache.getBool(key)：获取存储为缓存的布尔值。
• ReadCache.getInt(key)：获取存储为缓存的整数。
• ReadCache.getDouble(key)：获取存储为缓存的双精度浮点数。

写入缓存

• WriteCache.setJson(key,value)：将 JSON 设置为缓存。
• WriteCache.setString(key,value)：将字符串设置为缓存。
• WriteCache.setInt(key,value)：将整数设置为缓存。
• WriteCache.setBool(key,value)：将布尔值设置为缓存。
• WriteCache.setDouble(key,value)：将双精度浮点数设置为缓存。
• WriteCache.setListString(key,value)：将字符串列表设置为缓存。

删除缓存

• DeleteCache.deleteKey(key,[takeAction])：删除缓存并在缓存被删除时执行操作（可选）。

示例：带有缓存用户 ID 的登录流程

以下是一个示例，展示了如何在登录视图中使用缓存用户 ID。

// 登录视图中的附加函数
Future<String?> login({
    required BuildContext context,
    required String email,
    required String password,
  }) async {
    try {
      var userId = await _authenticationService.login(
          context: context, email: email, password: password);
      await WriteCache.setString(key: "cache", value: userId!);
    } catch (e) {
      print(e); // 如果发生错误，进行处理
   }
 }
 
// 欢迎页面视图
import 'dart:async';
import 'package:cache_manager/cache_manager.dart';
import 'package:flutter/material.dart';

class SplashView extends StatefulWidget {
  [@override](/user/override)
  _SplashViewState createState() => _SplashViewState();
}

class _SplashViewState extends State<SplashView> {
  Future initiateCache() async {
    return CacheManagerUtils.conditionalCache(
        key: "cache",
        valueType: ValueType.StringValue,
        actionIfNull: () {
          Navigator.of(context).pushNamed(AppRoutes.LoginRoute);
        },
        actionIfNotNull: () {
          Navigator.of(context).pushNamed(AppRoutes.HomeRoute);
        });
  }

  [@override](/user/override)
  void initState() {
    Timer(Duration(seconds: 1), initiateCache);
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Text("演示应用程序"),
      ),
    );
  }
}

// 主页视图
import 'package:cache_manager/core/cache_manager_utils.dart';
import 'package:cache_manager/core/delete_cache_service.dart';
import 'package:flutter/material.dart';

class HomeView extends StatefulWidget {
  [@override](/user/override)
  _HomeViewState createState() => _HomeViewState();
}

class _HomeViewState extends State<HomeView> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: CacheManagerUtils.cacheTextBuilder(
            textStyle: TextStyle(color: Colors.white), cacheKey: "cache"),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          DeleteCache.deleteKey(
              "cache", Navigator.of(context).pushNamed(AppRoutes.LoginRoute));
        },
      ),
    );
  }
}