Dio-http-cache is a cache library for Dio ( http client for flutter ), like Rxcache in Android.
Dio-http-cache uses sqflite as disk cache, and LRU strategy as memory cache.
Inspired by flutter_cache_manager.
dependencies:
dio_http_cache: ^0.3.x #latest version
Add a dio-http-cache interceptor in Dio :
dio.interceptors.add(DioCacheManager(CacheConfig(baseUrl: "http://www.google.com")).interceptor);
Set maxAge for a request :
Dio().get(
"http://www.google.com",
options: buildCacheOptions(Duration(days: 7)),
);
Custom your config by buildCacheOptions :
primaryKey: By default, host + path
is used as the primaryKey, and you can also customize it.
subKey: By default, query ( data or queryParameters) is used as subKey, and you can specify the subKey when it's necessary, for example:
buildCacheOptions(Duration(days: 7), subKey: "page=1")
maxAge: set the cache time. If the value is null or not setted, it will try to get maxAge and maxStale from response headers.
maxStale: set stale time. When an error (like 500,404) occurs before maxStale, try to return cache.
buildCacheOptions(Duration(days: 7), maxStale: Duration(days: 10))
forceRefresh: false default.
buildCacheOptions(Duration(days: 7), forceRefresh: true)
Use "CacheConfig" to config default params
deleteCache
, you need provide full path like "https://www.google.com/search?q=hello"
, but not just "search?q=hello"
.Duration(day:7)
as default.delete caches
.How to clear expired cache
Just ignore it, that is automatic.
But if you insist : DioCacheManager.clearExpired();
How to delete caches
No matter what subKey is, delete local cache if primary matched.
// Automatically parses primarykey from path
_dioCacheManager.deleteByPrimaryKey(path, requestMethod: "POST");
Delete local cache when both primaryKey and subKey matched.
// delete local cache when both primaryKey and subKey matched.
_dioCacheManager.deleteByPrimaryKeyAndSubKey(path, requestMethod: "GET");
INPORTANT: If you have additional parameters when requesting the http interface, you must take them with it, for example:
_dio.get(_url, queryParameters: {'k': keyword},
options: buildCacheOptions(Duration(hours: 1)))
//delete the cache:
_dioCacheManager.deleteByPrimaryKeyAndSubKey(_url, requestMethod: "GET", queryParameters:{'k': keyword});
_dio.post(_url, data: {'k': keyword},
options: buildCacheOptions(Duration(hours: 1)))
//delete the cache:
_dioCacheManager.deleteByPrimaryKeyAndSubKey(_url, requestMethod: "POST", data:{'k': keyword});
Delete local cache by primaryKey and optional subKey if you know your primarykey and subkey exactly.
// delete local cache by primaryKey and optional subKey
_dioCacheManager.delete(primaryKey,{subKey,requestMethod});
How to clear All caches (expired or not)
_dioCacheManager.clearAll();
How to know if the data come from Cache
if (null != response.headers.value(DIO_CACHE_HEADER_KEY_DATA_SOURCE)) {
// data come from cache
} else {
// data come from net
}
_dio.post(
"https://www.exmaple.com",
data: {'k': "keyword"},
options:buildCacheOptions(
Duration(days: 3),
maxStale: Duration(days: 7),
)
)
Copyright 2019 Hurshi
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.