Flutter数据缓存插件cache_x的使用

Flutter数据缓存插件CacheX的使用

介绍

CacheX 是一个适用于 Flutter 的可行的数据缓存包，支持加密存储任何类型的数据。它使用 SharedPreference 作为存储介质，并在后台使用 AES 加密和解密数据，以确保数据的安全性。

工作原理

缓存本质上是简单的键值对数据保存过程。CacheX 采用这种方式进行数据缓存。由于安全问题，我们不能直接保存原始数据。因此，CacheX 在缓存数据或从缓存中获取数据时，会在后台使用 AES 加密和解密。

示例项目截图

入门指南

1. 添加依赖

首先，在 pubspec.yml 文件中添加 CacheX 依赖：

dependencies:
  cache_x: ^latest

请从 pub.dev 获取最新版本号。

2. 初始化 CacheX

在应用的 main 函数中初始化 CacheX。密码长度必须为 128/192/256 位（即 16、24 或 32 个字符）。

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化密码
  String password = 'CBoaDQIQAgceGg8dFAkMDBEOECEZCxg=';

  // 初始化 CacheX
  final cacheX = CacheXCore();
  await cacheX.init(password: password);

  // 执行应用的其他初始化工作
  runApp(MyApp());
}

3. 保存和获取数据

你可以使用 CacheX 保存和获取不同类型的数据。以下是一个完整的示例代码，展示了如何保存和获取布尔值、双精度浮点数、整数、字符串和字符串列表。

import 'package:cache_x/cache_x.dart';
import 'package:flutter/material.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化密码
  String password = 'CBoaDQIQAgceGg8dFAkMDBEOECEZCxg=';

  // 初始化 CacheX
  final cacheX = CacheXCore();
  await cacheX.init(password: password);

  // 设置值
  await cacheX.saveBool(key: 'dark_mode', value: true);
  await cacheX.saveDouble(key: 'user_rating', value: 4.5);
  await cacheX.saveInt(key: 'user_age', value: 25);
  await cacheX.saveString(key: 'user_name', value: 'Tanvir');
  await cacheX.saveStringList(
    key: 'favorite_colors',
    value: ['Red', 'Green', 'Blue'],
  );

  // 获取值
  print('Dark Mode: ${await cacheX.getBool(key: 'dark_mode', defaultValue: false)}');
  print('User Rating: ${await cacheX.getDouble(key: 'user_rating', defaultValue: 0.0)}');
  print('User Age: ${await cacheX.getInt(key: 'user_age', defaultValue: 0)}');
  print('User Name: ${await cacheX.getString(key: 'user_name', defaultValue: 'Unknown')}');
  print('Favorite Colors: ${await cacheX.getStringList(key: 'favorite_colors', defaultValue: [])}');
  print('All Keys: ${await cacheX.getKeys()}');

  // 检查是否存在某个键
  print('Does key "user_name" exist? ${await cacheX.containsKey(key: 'user_name')}');

  // 删除某个键
  await cacheX.remove(key: 'user_name');
  print('User Name after removal: ${await cacheX.getString(key: 'user_name', defaultValue: 'Unknown')}');

  // 清除所有缓存
  await cacheX.clear();
  print('All Keys after clearing: ${await cacheX.getKeys()}');
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'CacheX Example',
      home: Scaffold(
        appBar: AppBar(
          title: Text('CacheX Example'),
        ),
        body: Center(
          child: Text('Check the console for cached data!'),
        ),
      ),
    );
  }
}

注意事项

• 密码长度：密码必须是 128/192/256 位（即 16、24 或 32 个字符）。否则会抛出异常。
• 默认值：在 get 方法中提供 defaultValue，否则如果键不存在或数据类型不匹配，将返回 null。
• 异步操作：所有 save 方法都返回 Future<bool>，因此需要使用 await 来获取结果。
• 异常处理：CacheX 可能会抛出以下几种异常：
  • CacheXException：当 CacheXCore 初始化失败或发生其他内部错误时。
  • StorageException：当保存或获取数据时发生错误时。
  • EncryptionException：当加密或解密数据时发生错误时。

高级用法：与 Parse Server 集成

如果你在项目中使用了 parse_server_sdk_flutter，可以将 CacheX 作为默认的核心存储库。只需在初始化 Parse 时指定 CoreStoreCacheXImpl 即可。

import 'package:cache_x/core_store_cacheX_impl.dart';
import 'package:parse_server_sdk_flutter/parse_server_sdk_flutter.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化 Parse
  await Parse().initialize(
    'your_app_id',
    'your_server_url',
    clientKey: 'your_client_key',
    liveQueryUrl: 'your_live_query_url',
    coreStore: await CoreStoreCacheXImpl.getInstance(
      password: 'u0TCHVOIiEFVwOqqDo1OnLfd3Kx7yaRt',
    ),
    debug: true,
    autoSendSessionId: true,
  );

  // 现在可以直接使用 CacheX 进行本地存储
  final cacheX = CacheXCore.instance;
  await cacheX.saveString(key: 'ft1', value: 'Tanvir');
  print(await cacheX.getString(key: 'ft1'));
}