dio_cache 0.1.0-beta

A plugin for dio that caches responses for better optimization and offline data access.

example/example.dart

import 'dart:io';

import 'package:dio/dio.dart';
import 'package:dio_cache/dio_cache.dart';
import 'package:logging/logging.dart';

main() async {
  // Displaying logs
  Logger.root.level = Level.ALL;
  Logger.root.onRecord.listen((record) {
    print('${record.level.name}: ${record.time}: ${record.message}');
  });

  // Add the interceptor with optional options
  final cacheInterceptor = CacheInterceptor(
    store: BackupCacheStore(
       backupStore: FileCacheStore(Directory(".cache"))
    ),
    options: const CacheInterceptorRequestExtra(
      expiry: const Duration(minutes: 30)
    ),
  );
  final dio = Dio()
  ..interceptors.add(cacheInterceptor);

  // The first request will get data and add it to cache
  final distantResponse = await dio.get("http://www.flutter.dev");
  print("Distant -> statusCode: ${distantResponse.statusCode}, data : ${distantResponse.data.substring(0,20)}...");

  await Future.delayed(const Duration(seconds: 5));

  // The second request will use the cached value
  final cachedResponse = await dio.get("http://www.flutter.dev");
  print("Cached -> statusCode: ${cachedResponse.statusCode}, data : ${distantResponse.data.substring(0,20)}...");

  // To get more info about the cache
  final cachedExtra = CacheInterceptorResponseExtra.fromExtra(cachedResponse);
  if(cachedExtra.isFromCache) {
    print("expiry: ${cachedExtra.cache.expiry}, downloadedAt: ${cachedExtra.cache.downloadedAt}");
  }


  // The new request will get data and add it to cache
  final forcedResponse = await dio.get("http://www.flutter.dev", options: Options(
    extra: CacheInterceptorRequestExtra(
      forceUpdate: true
    ).toExtra(),
  ) );
  print("Forced -> statusCode: ${forcedResponse.statusCode}, data : ${forcedResponse.data.substring(0,20)}...");

   // To get more info about the cache
  final forcedCachedExtra = CacheInterceptorResponseExtra.fromExtra(cachedResponse);
  print("isFromCache: ${forcedCachedExtra.isFromCache}");

  // To invalidate a cached request
  await cacheInterceptor.store.invalidate("GET", "http://www.flutter.dev");
}