Flutter缓存管理插件sraph_cache的使用

Sraph Cache

基于 shared_preferences 并添加了可监听的缓存功能。

使用方法

要使用此插件，请在 pubspec.yaml 文件中将其作为依赖项添加：

dependencies:
  sraph_cache: ^版本号

然后运行以下命令以获取依赖项：

flutter pub get

示例代码

以下是展示如何使用该 API 的小示例。

写入数据

void main() async {
  // 初始化缓存。
  await Cache.ensureInitialized();

  // 将整数值保存到 'counter' 键中。
  await Cache.set<int>('counter', 10);

  // 将布尔值保存到 'repeat' 键中。
  await Cache.set<bool>('repeat', true);

  // 将双精度浮点数保存到 'decimal' 键中。
  await Cache.set<double>('decimal', 1.5);

  // 将字符串保存到 'action' 键中。
  await Cache.set<String>('action', 'Start');

  // 将字符串列表保存到 'items' 键中。
  await Cache.set<List<String>>('items', ['Earth', 'Moon', 'Sun']);
}

读取数据

void main() {
  // 尝试从 'counter' 键中读取数据。如果不存在，则返回 null。
  final int? counter = Cache.get<int>('counter');

  // 尝试从 'repeat' 键中读取数据。如果不存在，则返回 null。
  final bool? repeat = Cache.get<bool>('repeat');

  // 尝试从 'decimal' 键中读取数据。如果不存在，则返回 null。
  final double? decimal = Cache.get<double>('decimal');

  // 尝试从 'action' 键中读取数据。如果不存在，则返回 null。
  final String? action = Cache.get<String>('action');

  // 尝试从 'items' 键中读取数据。如果不存在，则返回 null。
  final List<String>? items = Cache.get<List<String>>('items');

  print('Counter: $counter');
  print('Repeat: $repeat');
  print('Decimal: $decimal');
  print('Action: $action');
  print('Items: $items');
}

删除条目

void main() async {
  // 尝试删除 'counter' 键的数据。
  final success = await Cache.remove('counter');

  if (success) {
    print('Data removed successfully.');
  } else {
    print('Failed to remove data.');
  }
}

监听变化

通过 ValueListenableBuilder 可以监听缓存的变化：

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

class CacheListener extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return ValueListenableBuilder(
      valueListenable: Cache.listenable(),
      builder: (context, value, child) {
        return Text('Cache Value: $value');
      },
    );
  }
}

void main() async {
  // 初始化缓存。
  await Cache.ensureInitialized();

  // 设置一个初始值。
  await Cache.set<String>('key', 'Initial Value');

  runApp(MaterialApp(
    home: Scaffold(
      appBar: AppBar(title: Text('Cache Listener')),
      body: CacheListener(),
    ),
  ));
}