Flutter基础缓存功能插件dart_basic_cache的使用

DartBasicCache

DartBasicCache 是一个简单的缓存包，允许你在 Dart 应用程序中轻松地缓存数据。

安装

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

dependencies:
  dart_basic_cache: ^1.0.0

特性

• 简单易用的缓存包。
• 基于唯一 URL 缓存和存储数据。
• 在指定时长后自动使缓存数据失效。
• 提供快速访问缓存数据，避免重复的网络请求。
• 支持可选的内存和/或文件存储缓存。
• 适用于 Flutter 和 Dart 项目。

使用

导入 dart_basic_cache 库：

import 'package:dart_basic_cache/dart_basic_cache.dart';

创建 DartBasicCache 的实例：

var cache = DartBasicCache();

初始化缓存（可选）：

await cache.init(cacheFileName: 'my_cache', cacheTimeHour: 2);

这将使用名为 “my_cache” 的文件名和 2 小时的缓存时长来初始化缓存。

缓存数据：

await cache.cacheData('https://api.example.com/data', jsonData);

这将使用指定的 URL 作为唯一标识符来缓存 jsonData。

检索缓存数据：

var data = await cache.getDataFromCache('https://api.example.com/data');
if (data != null) {
  // 使用缓存的数据
} else {
  // 数据未在缓存中找到
}

这将为指定的 URL 检索缓存数据。如果数据可用且未过期，则返回该数据；否则返回 null。

删除缓存数据：

await cache.deleteCachedData('https://api.example.com/data');

这将删除指定 URL 的缓存数据。

示例

这是一个完整的示例，演示如何使用 DartBasicCache 缓存和检索来自 API 的数据：

import 'package:flutter/material.dart';
import 'package:dart_basic_cache/dart_basic_cache.dart';
import 'package:http/http.dart' as http;

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await DartBasicCache().init();
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'DartBasicCache 示例',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

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

class _MyHomePageState extends State<MyHomePage> {
  final cache = DartBasicCache();
  final apiUrl = 'https://api.example.com/data';
  String? cachedData;

  [@override](/user/override)
  void initState() {
    super.initState();
    fetchData();
  }

  Future<void> fetchData() async {
    setState(() {
      cachedData = null;
    });

    final data = await cache.getDataFromCache(apiUrl);

    if (data != null) {
      setState(() {
        cachedData = data;
      });
    } else {
      final response = await http.get(Uri.parse(apiUrl));

      if (response.statusCode == 200) {
        final fetchedData = response.body;
        await cache.cacheData(apiUrl, fetchedData);
        setState(() {
          cachedData = fetchedData;
        });
      }
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('DartBasicCache 示例'),
      ),
      body: Center(
        child: cachedData != null
            ? Text(
                '缓存数据：\n$cachedData',
                textAlign: TextAlign.center,
              )
            : CircularProgressIndicator(),
      ),
    );
  }
}