Flutter本地缓存管理插件king_cache的使用

Flutter本地缓存管理插件king_cache的使用

简介

king_cache 是一个用于缓存API结果的Flutter插件。通过缓存API结果，当您再次调用相同的API时，它将返回缓存的结果而不是重新发起API请求。这有助于减少API调用次数并提升应用的用户体验。该插件基于文件系统进行缓存，并提供了多种功能来管理缓存，如设置缓存过期时间、记录日志、清除缓存等。

主要特性

• 缓存API结果：可以缓存API的响应数据。
• 设置缓存过期时间：可以为缓存设置过期时间，确保数据的新鲜度。
• 管理缓存：提供添加、删除、清除缓存的功能。
• 记录日志：可以记录缓存操作的日志，方便调试和追踪。
• 清除日志：可以清除所有日志。
• 分享日志：可以将日志分享给其他应用或设备。

快速开始

1. 添加依赖

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

dependencies:
  king_cache: ^latest_version

2. 导入包

在 Dart 文件中导入 king_cache 包：

import 'package:king_cache/king_cache.dart';

3. 使用插件

以下是一个完整的示例代码，展示了如何使用 king_cache 插件进行缓存管理和日志记录。

完整示例代码

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

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) => const MaterialApp(
        title: 'King Cache Example',
        home: MyHomePage(title: 'King Cache Example'),
      );
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  void initState() {
    super.initState();
    // 设置API的基础URL
    KingCache.setBaseUrl('https://jsonplaceholder.typicode.com/');
    // 设置请求头
    KingCache.setHeaders({'Content-Type': 'application/json'});
    // 添加表单数据（可选）
    KingCache.appendFormData({'token': '1234567890'});
  }

  [@override](/user/override)
  Widget build(BuildContext context) => Scaffold(
        appBar: AppBar(title: Text(widget.title)),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              // 调用API并缓存结果
              TextButton(
                onPressed: () async {
                  await KingCache().storeLog('Call Json Place Holder API');
                  await KingCache.cacheViaRest(
                    'todos/1', // API路径
                    method: HttpMethod.get, // 请求方法
                    onSuccess: (data) {
                      // 成功回调
                      debugPrint(data);
                      KingCache.storeLog('Response: $data');
                    },
                    onError: (data) => debugPrint('On Error: ${data.message}'), // 错误回调
                    apiResponse: (data) => debugPrint('Api Response: ${data.message}'), // API响应回调
                    isCacheHit: (isHit) => debugPrint('Is Cache Hit: $isHit'), // 是否命中缓存
                    shouldUpdate: false, // 是否强制更新缓存
                    expiryTime: DateTime.now().add(const Duration(hours: 1)), // 缓存过期时间
                  );
                },
                child: const Text('Json Place Holder API'),
              ),
              // 获取日志
              TextButton(
                onPressed: () async {
                  final logs = await KingCache().getLogs;
                  debugPrint(logs);
                },
                child: const Text('Get Logs'),
              ),
              // 清除日志
              TextButton(
                onPressed: () => KingCache().clearLog(),
                child: const Text('Clear Logs'),
              ),
              // 清除所有缓存
              TextButton(
                onPressed: () => KingCache().clearAllCache(),
                child: const Text('Clear All Cache'),
              ),
              // 分享日志
              TextButton(
                onPressed: () => KingCache().shareLogs(),
                child: const Text('Share Logs'),
              ),
            ],
          ),
        ),
      );
}