hurshi/dio-http-cache
http cache lib for Flutter dio like RxCache
baixar do githubdio-http-cache
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.
Add Dependency
dependencies:
dio_http_cache: ^0.3.x #latest version
QuickStart
-
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)), );
The advanced
-
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)
- Get data from network first.
- If getting data from network succeeds, store or refresh cache.
- If getting data from network fails or no network avaliable, try get data from cache instead of an error.
-
-
Use “CacheConfig” to config default params
- baseUrl: it’s optional; If you don’t have set baseUrl in CacheConfig, when you call
deleteCache
, you need provide full path like"https://www.google.com/search?q=hello"
, but not just"search?q=hello"
. - encrypt / decrypt: these two must be used together to encrypt the disk cache data, you can also zip data here.
- defaultMaxAge: use
Duration(day:7)
as default. - defaultaMaxStale: similar with DefaultMaxAge.
- databasePath: database path.
- databaseName: database name.
- skipMemoryCache: false defalut.
- skipDiskCache: false default.
- maxMemoryCacheCount: 100 defalut.
- defaultRequestMethod: use “POST” as default, it will be used in
delete caches
. - diskStore: custom disk storage.
- baseUrl: it’s optional; If you don’t have set baseUrl in CacheConfig, when you call
-
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 }
Example for maxAge and maxStale
_dio.post(
"https://www.exmaple.com",
data: {'k': "keyword"},
options:buildCacheOptions(
Duration(days: 3),
maxStale: Duration(days: 7),
)
)
- 0 ~ 3 days : Return data from cache directly (irrelevant with network).
- 3 ~ 7 days:
- Get data from network first.
- If getting data from network succeeds, refresh cache.
- If getting data from network fails or no network avaliable, try get data from cache instead of an error.
- 7 ~ ∞ days: It won’t use cache anymore, and the cache will be deleted at the right time.
License
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.
![](/images/banner-woo.jpg)
recomendações de excelentes projetos relacionados a hurshi/dio-http-cache para download
AppFlowy
47859
AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
localsend
33797
An open-source cross-platform alternative to AirDrop
spotube
23772
🎧 Open source Spotify client that doesn't require Premium nor uses Electron! Available for both desktop & mobile!
revanced-manager
15035
💊 Application to use ReVanced on Android
gsy_github_app_flutter
14559
Flutter 超完整的开源项目,功能丰富,适合学习和日常使用。GSYGithubApp系列的优势:我们目前已经拥有Flutter、Weex、ReactNative、kotlin 四个版本。 功能齐全,项目框架内技术涉及面广,完成度高,持续维护,配套文章,适合全面学习,对比参考。跨平台的开源Github客户端App,更好的体验,更丰富的功能,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验Σ( ̄。 ̄ノ)ノ。同款Weex版本 : https://github.com/CarGuo/GSYGithubAppWeex 、同款React Native版本 : https://github.com/CarGuo/GSYGithubApp 、原生 kotlin 版本 https://github.com/CarGuo/GSYGithubAppKotlin
dio
12249
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
gopeed
11832
A modern download manager that supports all platforms. Built with Golang and Flutter.
bloc
11441
A predictable state management library that helps implement the BLoC design pattern
getx
9899
Open screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.
flame
8846
A Flutter based game engine.
flutter_deer
7595
🦌 Flutter 练习项目(包括集成测试、可访问性测试)。内含完整UI设计图,更贴近真实项目的练习。Flutter practice project (including integration testing and accessibility testing). Contains complete UI design drawings for a more realistic practice project.
fish-redux
7343
An assembled flutter application framework.
hiddify-next
7232
Multi-platform auto-proxy client, supporting Sing-box, X-ray, TUIC, Hysteria, Reality, Trojan, SSH etc. It’s an open-source, secure and ad-free.
ente
6686
Fully open source, End to End Encrypted alternative to Google Photos and Apple Photos
fl_chart
6451
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
pixez-flutter
6360
一个支持免代理直连及查看动图的第三方Pixiv flutter客户端
Flutter-Responsive-Admin-Panel-or-Dashboard
6355
Responsive Admin Panel or Dashboard using Flutter
aidea
6021
AIdea 是一款支持 GPT 以及国产大语言模型通义千问、文心一言等,支持 Stable Diffusion 文生图、图生图、 SDXL1.0、超分辨率、图片上色的全能型 APP。
riverpod
5828
A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
pikapika
5463
美观易用且无广告的漫画和游戏客户端,同时支持MacOS,Windows,Android,iOS。