Flutter图片缓存管理插件flutter_cache_manager的使用

简介

flutter_cache_manager 是一个用于下载和缓存文件到应用程序缓存目录的库。它提供了多种设置来控制文件在缓存中的保留时间，并利用 HTTP 缓存控制头（Cache-Control）高效地获取文件。

主要功能

• 缓存文件：通过 getSingleFile、getFileStream 等方法从网络下载并缓存文件。
• 自定义配置：允许用户根据需求调整缓存策略，如最大缓存对象数量、文件过期时间等。
• 图像处理：提供 ImageCacheManager 混入，支持按指定尺寸缩放图像后存储于缓存中。

使用方法

基本用法

获取单个文件

var file = await DefaultCacheManager().getSingleFile(url);

此代码段将尝试从缓存中读取文件；如果不存在，则会从给定 URL 下载文件并将其保存到本地缓存中。

获取文件流

Stream<FileResponse> stream = DefaultCacheManager().getFileStream(url, withProgress: true);

使用 getFileStream 方法可以获取一个包含缓存文件和新下载文件（如果有）的流。设置 withProgress 参数为 true 可以接收下载进度信息。

直接下载文件

await DefaultCacheManager().downloadFile(url);

该方法直接从互联网下载文件而不检查缓存。

仅从缓存中获取文件

var cachedFile = await DefaultCacheManager().getFileFromCache(url);
if (cachedFile == null) {
  // 文件不在缓存中
}

添加文件到缓存

await DefaultCacheManager().putFile(filePath);

这允许手动将本地文件添加到缓存系统中。

移除或清空缓存

// 移除特定文件
await DefaultCacheManager().removeFile(url);

// 清空所有缓存文件
await DefaultCacheManager().emptyCache();

图像缓存管理

对于图像资源，可以通过 ImageCacheManager 提供的 getImageFile 方法进行特殊处理：

Stream<FileResponse> imageStream = DefaultCacheManager().getImageFile(
  url,
  maxHeight: 200,
  maxWidth: 300,
);

这样不仅可以缓存原始图像，还能根据需要调整大小后再缓存，从而节省存储空间。

自定义配置

为了满足更复杂的业务逻辑，你可以创建自己的 CacheManager 实例并配置不同的参数：

class CustomCacheManager {
  static const key = 'customCacheKey';
  static CacheManager instance = CacheManager(
    Config(
      key,
      stalePeriod: Duration(days: 7),
      maxNrOfCacheObjects: 20,
      repo: JsonCacheInfoRepository(databaseName: key),
      fileSystem: IOFileSystem(key),
      fileService: HttpFileService(),
    ),
  );
}

注意：确保每个 CacheManager 的 key 是唯一的，避免多个实例之间产生冲突。

示例代码

以下是一个完整的示例应用，展示了如何结合上述功能在一个简单的页面中实现文件下载与缓存管理：

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

void main() {
  runApp(MyApp());
}

const url = 'https://picsum.photos/200/300';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: CacheManagerPage(),
    );
  }
}

class CacheManagerPage extends StatefulWidget {
  @override
  _CacheManagerPageState createState() => _CacheManagerPageState();
}

class _CacheManagerPageState extends State<CacheManagerPage> {
  Stream<FileResponse>? fileStream;

  void _downloadFile() async {
    setState(() {
      fileStream = DefaultCacheManager().getFileStream(url, withProgress: true);
    });
  }

  void _clearCache() async {
    await DefaultCacheManager().emptyCache();
    setState(() {
      fileStream = null;
    });
  }

  void _removeFile() async {
    await DefaultCacheManager().removeFile(url);
    setState(() {
      fileStream = null;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Flutter Cache Manager Example')),
      body: Center(
        child: fileStream == null
            ? ElevatedButton(
                onPressed: _downloadFile,
                child: Text('Download Image'),
              )
            : StreamBuilder<FileResponse>(
                stream: fileStream!,
                builder: (context, snapshot) {
                  if (!snapshot.hasData || snapshot.data == null) {
                    return CircularProgressIndicator();
                  } else {
                    final file = snapshot.data!.file;
                    return Column(
                      mainAxisAlignment: MainAxisAlignment.center,
                      children: [
                        Image.file(file),
                        SizedBox(height: 20),
                        Row(
                          mainAxisAlignment: MainAxisAlignment.spaceEvenly,
                          children: [
                            ElevatedButton(onPressed: _removeFile, child: Text('Remove File')),
                            ElevatedButton(onPressed: _clearCache, child: Text('Clear Cache')),
                          ],
                        ),
                      ],
                    );
                  }
                },
              ),
      ),
    );
  }
}

这个例子演示了如何使用 flutter_cache_manager 插件来管理和显示远程图片，并提供了清除缓存和移除单个文件的功能按钮。希望这段代码能够帮助你更好地理解和应用这个强大的工具！