okaryo / api_response_cache Goto Github PK

このパッケージを使うと嬉しいこと

• 外部APIに対するリクエストを必要最小限にし、APIの負荷とコスト(特に従量課金の場合)をする削減
• 外部APIの変更やサーバーダウンといったAPIに依存することで発生するリスクを最小限にする
• ユーザーにとっては無駄なリクエストを送らなくて良いので端末フレンドリーなアプリ設計に近づけることができる

技術詳細

• 外部APIのリクエスト結果をキャッシュする
• キャッシュ保持期間内であれば、APIにリクエストを送らずにローカルキャッシュのデータを返す
• エラーが起こればキャッシュを返すorエラーをそのまま返す
  • これは設定で選択できるようにする

まだ決まっていないこと

• キャッシュ戦略について
  • 期間を設定するようなタイプと、x月x日までのような期日タイプがありそう
  • 期間タイプ
    • Durationを設定し、キャッシュの保持期間は最後に送ったリクエスト日時+Durationまでとする
  • 期日タイプ
    • キャッシュを保持するのは指定されたDateTimeまで
      • でもその場合ってキャッシュが効くのは最初の時期だけで、それが過ぎたら毎回リクエスト送ってしまうことにならん？
      • これはボツ
      • 期日タイプでやりたいことは、期間タイプ+日付を跨いだらキャッシュは使わないのようなことにすれば実現できそう

他のアイデア

• アプリのバージョンが更新されたときは生存期間内であってもキャッシュからではなく、APIからデータを取得する
  • これも設定で選択可能にする
  • 一度設定してしまうとデータが一定期間固定化されてしまうので、アプリの更新に合わせてデータも最新にリフレッシュできると嬉しそう
• APIのレスポンスによってはそれをそのままローカルストレージに保存してはまずそうなものもありそう
  • secureStorage: trueみたいなオプションでセキュアな保存方法を使えるようにするのもあり？