Flutter 缓存管理器：Config、FileService 和 FileServiceResponse 源码解析（三）

2024-01-12 05:49:50

前言

在深入了解 Flutter 缓存管理器 (FCM) 的内部机制之前，我们已经探索了 CacheManager 和 StreamCacheManager 类的运作方式。现在，让我们深入研究构成 FCM 核心基础的三个关键类：Config、FileService 和 FileServiceResponse。

Config 抽象类

Config 是一个抽象类，用于定义 CacheManager 的配置。以下是 Config 的一些属性和构造函数参数的简要解释：

cacheKey: 用于存储文件和数据库文件名的文件夹的名称。
maxFileSize: 允许存储的单个文件的最大大小（以字节为单位）。
maxCacheSize: 允许的整个缓存的最大大小（以字节为单位）。
maxAgeCacheObject: 缓存对象的最长有效期（以毫秒为单位）。
maxCacheObjects: 允许存储在缓存中的最大对象数。
fileExtension: 用于存储的文件的扩展名。
webContentsMimeType: 用于 web 请求的 MIME 类型。

Config 类充当缓存管理器的配置中心，允许开发人员根据其特定需求定制缓存行为。

FileService

FileService 是一个抽象类，定义了与文件系统交互的操作。它提供了以下方法：

downloadFile: 从给定的 URL 下载文件并将其保存在缓存中。
readFile: 从缓存中读取文件。
deleteFile: 从缓存中删除文件。
exists: 检查文件是否存在于缓存中。
getAllFiles: 获取缓存中的所有文件。

FileService 为缓存管理器提供了一个抽象层，使其实现与文件系统无关。

FileServiceResponse

FileServiceResponse 是一个类，表示 FileService 操作的结果。它具有以下属性：

file: 下载或读取的文件（如果操作成功）。
exception: 如果操作失败，则为遇到的异常。
isSuccessful: 表示操作是否成功。

FileServiceResponse 提供了一个简洁的方式来处理文件服务操作的结果。

源码解析

让我们深入研究每个类的源码，以了解它们的工作原理：

Config

/// Config defines the configurations for CacheManager.
abstract class Config {
  const Config({
    this.cacheKey,
    this.maxFileSize,
    this.maxCacheSize,
    this.maxAgeCacheObject,
    this.maxCacheObjects,
    this.fileExtension,
    this.webContentsMimeType,
  });

  /// A key used as folder name to store the file and db files.
  final String cacheKey;

  /// The maximum file size in bytes that can be stored.
  final int maxFileSize;

  /// The total maximum size of the cache in bytes.
  final int maxCacheSize;

  /// The max age of a cache object in milliseconds.
  final int maxAgeCacheObject;

  /// The maximum number of cache objects that can be stored.
  final int maxCacheObjects;

  /// The file extension used for the stored files.
  final String fileExtension;

  /// The mimeType of web contents
  final String webContentsMimeType;
}

FileService

/// An abstract class that defines the operations with the file system.
abstract class FileService {
  /// Downloads a file from the given url and saves it in the cache.
  Future<FileServiceResponse> downloadFile(String url);

  /// Reads the file from the cache.
  Future<FileServiceResponse> readFile(String url);

  /// Deletes the file from the cache.
  Future<FileServiceResponse> deleteFile(String url);

  /// Check if a file exists in the cache.
  Future<bool> exists(String url);

  /// Gets all files in the cache.
  Future<List<File>> getAllFiles();
}

FileServiceResponse

/// A class represents the result of a file service operation.
class FileServiceResponse {
  FileServiceResponse({this.file, this.exception, this.isSuccessful});

  /// The file that was downloaded or read.
  final File file;

  /// The exception that was thrown if the operation failed.
  final Exception exception;

  /// A flag indicating whether the operation was successful.
  final bool isSuccessful;
}