Skip to content
develop
Switch branches/tags
Go to file
Code
This branch is even with deakjahn:develop.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

README.md

flutter_cache_manager

pub package Build Status codecov

A CacheManager to download and cache files in the cache directory of the app. Various settings on how long to keep a file can be changed.

It uses the cache-control http header to efficiently retrieve files.

The more basic usage is explained here. See the complete docs for more info.

Usage

The cache manager can be used to get a file on various ways The easiest way to get a single file is call .getSingleFile.

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

getFileStream(url) returns a stream with the first result being the cached file and later optionally the downloaded file.

getFileStream(url, withProgress: true) when you set withProgress on true, this stream will also emit DownloadProgress when the file is not found in the cache.

downloadFile(url) directly downloads from the web.

getFileFromCache only retrieves from cache and returns no file when the file is not in the cache.

putFile gives the option to put a new file into the cache without downloading it.

removeFile removes a file from the cache.

emptyCache removes all files from the cache.

Custom Cache Key

By default the cache uses the url as the cache key. However, a custom cache key can be specified instead, meaning that files requested by url can be accessed from the cache using key. This is useful for scenarios where the URL for a resource can change, but the resource itself stays the same. Some examples include:

  1. Files stored in Firebase, where getDownloadURL can return a different URL for the same file

  2. Using pre-signed URLs from services such as AWS S3 or CloudFront, where the expiration time is embedded in the URL and causes the URLs to change over time.

To specify a custom key, use the optional key parameter when getting the file:

final file = await cacheManager.getSingleFile(
  'http://example.com/resource',
  key: 'MySpecialCacheKey',
)

The custom key must be used for each subsequent access to the file in order for the cached version to be used.

Using a custom key would typically be used when accessing a resource by ID (eg using a record from a database)

final file = await cacheManager.getSingleFile(
  resource.getDownloadURL(),
  key: resource.id
);

Settings

The cache manager is customizable by extending the BaseCacheManager. Below is an example with other settings for the maximum age of files, maximum number of objects and a custom FileService. The key parameter in the constructor and the getFilePath method are mandatory.


class CustomCacheManager extends BaseCacheManager {
  static const key = "customCache";

  static CustomCacheManager _instance;

  factory CustomCacheManager() {
    if (_instance == null) {
      _instance = new CustomCacheManager._();
    }
    return _instance;
  }

  CustomCacheManager._() : super(key,
      maxAgeCacheObject: Duration(days: 7),
      maxNrOfCacheObjects: 20);

  Future<String> getFilePath() async {
    var directory = await getTemporaryDirectory();
    return p.join(directory.path, key);
  }
}

If the file is located on Firebase Storage it can be accessed by using the provided FirebaseHttpFileService. Wherever the url is provided now becomes a Firebase Storage path, e.g. getFileStream(firebaseStoragePath).


class FirebaseCacheManager extends BaseCacheManager {
  static const key = 'firebaseCache';

  static FirebaseCacheManager _instance;

  factory FirebaseCacheManager() {
    _instance ??= FirebaseCacheManager._();
    return _instance;
  }

  FirebaseCacheManager._() : super(key, fileService: FirebaseHttpFileService());

  @override
  Future<String> getFilePath() async {
    var directory = await getTemporaryDirectory();
    return p.join(directory.path, key);
  }
}

How it works

By default the cached files are stored in the temporary directory of the app. This means the OS can delete the files any time.

Information about the files is stored in a database using sqflite. The file name of the database is the key of the cacheManager, that's why that has to be unique.

This cache information contains the end date till when the file is valid and the eTag to use with the http cache-control.

About

Generic cache manager for flutter

Resources

License

Packages

No packages published