CacheX for Flutter #

A feasible caching library for Flutter. Save any encrypted string.

Inspired by CacheX for Android

How does it work ? #

Caching is just a simple key-value pair data saving procedure. CacheX follows the same approach. CacheX uses SharedPreference as storage for caching data. Since we really can't just save the original data because of security issues. CacheX uses AES encryption & decryption behind the scene when you are caching data or fetching data from the cache.

Getting Started #

First you have to add the package dependency in pubspec.yml

cache_x: ^latest

Get the version from pub.flutter-io.cn

In the main Function of your App #

void main() async {
    WidgetsFlutterBinding.ensureInitialized();

    // Initialize 128byte password (16 Charecter)
    String password = 'CBoaDQIQAgceGg8d';

    // Initialize CacheX with the password
    await CacheXCore().init(password: password);

    // Do your apps essential works

    // Then anywhere in your app use it to save string
    print(await CacheXCore.instance.saveData(key: 'ft1', value: 'Tanvir'));
    // Get String
    print(await CacheXCore.instance.getData(key: 'ft1'));
}

Also youcan save the instance in a veriable then use the veriable.

/// CacheXCore type of veriable cacheX
final cacheX = CacheXCore();
/// Init the CacheX
await cacheX.init(password: password);
cacheX.saveData(key: 'ft1', value: 'Tanvir');
cacheX.getData(key: 'ft1');

Things to keep in mind #

• CacheXCore.instance.saveData(String key, String value) will return Future<bool> so you have to use await to get the result of it and it will throw exception if there any.

• CacheXCore.instance.getData(String key) will return Future<String> so to get the string you have to use await and it will throw exception if there any.

Exceptions in the Package #

• StorageException
  • If there any exception saving or getting data it will throw StorageException. The exception message starts with String StorageException:.
• EncryptionException
  • If there any exception encrypting or decrypting the data it will throw EncryptionException. The exception message will start with String EncryptionException:.

Other Projects #

TransitionX, Rounded Button, CacheX