再起動後も残るキャッシュ
spring.cache.type: disk はエントリを 1 件ずつディスクに保持します。そのため結果はアプリを再起動しても残ります。昨日スマートフォンが受け取った API の応答も、次の起動ではネットワークなしで手元にあります。
なぜ
メモリ上のキャッシュは起動のたびに空になります。スマートフォンではユーザーがアプリを開くたび、Web ではページを読み込むたびです。同じ応答をまた問い合わせることになります。ディスク上のストアならそれを保持できます。ただしメモリより応答が遅いので、このキャッシュは Future を返すメソッド向けです。
例
spring:
cache:
type: disk # simple: メモリ、disk: 再起動をまたいで保持
disk:
time-to-live: 1h # 実時間で数える(再起動をまたぐ)
max-size: 50MB # キャッシュごと。古く書かれたものから消える
version: 2.1.0 # 別のバージョンのエントリは読まない
caches:
profiles: { time-to-live: 10m }
@Component()
class Profiles {
Profiles(this.api);
final PassportApi api;
@Cacheable('profiles')
Future<Profile> find(String steamId) => api.profile(steamId);
}
仕組み
- 置き場所。 アプリケーションの
CacheStoreです。Flutter アプリではファイルのcacheの場所(システムが消すことがある。ブラウザーでは IndexedDB)で、Flutter スターターが用意します。それ以外ではフォルダーspring.cache.disk.directory(既定は.spring/cache)です。1 エントリ 1 ファイルでspring/caches/<キャッシュ>/<鍵のハッシュ>.jsonに、書いたときの鍵、期限、バージョン、値を保存します。 - ファイルではなくデータ。 このキャッシュが保持するのはメソッドの結果です。アプリがダウンロードするファイル(画像、動画)は Flutter スターターのリソースのキャッシュ、
spring.flutter.resources.cache.*が保持します。spring/caches/の隣にある専用のフォルダーで、上限も別です。どちらも相手の上限に数えられず、片方を消してももう片方は残ります。 - 値。 アプリケーションの
ObjectMapperで JSON にします。対象はString、数値、bool、null、マッパーが読めるオブジェクト(@Introspected()か JSON シリアライザー)、それらのList、Set、Map<String, …>、そしてアドレスを持つResourceです。Resourceはアドレスだけを保存するので、Flutter スターターが保持するファイルは両方で 1 つのコピーで済みます。それ以外の値は保持せず、ログに一度だけ出します。空のコレクションも要素の型が分からないため保持しません。 - 応答は後から。 これらのキャッシュは
AsyncCache(Spring のCache.retrieve)です。インターセプターはFutureを返すメソッドでこれを待ちます。Futureを返さないメソッドに使うと、メソッドとキャッシュの名前を示して起動時にエラーになります。 - 複数のストア。 Spring の
CompositeCacheManagerは、キャッシュ名を複数のマネージャーに問い合わせます。Spring にはないLayeredCacheManagerは、速いキャッシュを遅いキャッシュの前に置きます。遅い層で見つかった値は前の速い層にコピーされ、put と evict はすべての層に届きます。
@Configuration()
class CacheConfig {
@Bean()
@Primary()
CacheManager memory() => InMemoryCacheManager(
defaultSpec: const CacheSpec(timeToLive: Duration(minutes: 1)),
);
@Bean()
CacheManager disk(CacheStore store, ObjectMapper mapper,
Introspector introspector) =>
DiskCacheManager(store: store, mapper: mapper,
introspector: introspector, timeToLive: const Duration(days: 1));
@Bean()
CacheManager layered(CacheManager memory, CacheManager disk) =>
LayeredCacheManager([memory, disk]);
}
- ファイルを鍵に。 Spring と同じく、リソースはアドレスで等しいかが決まります。同じアドレスのファイルが変わっても、そこから作った結果は期限まで残ります。
spring.cache.resource-version: trueにすると、Flutter スターターが保持するリソースの鍵はアドレスと内容のバージョン(ダイジェスト)になり、新しいファイルは新しい鍵になります。ダイジェストはファイル全体から計算するので、既定ではオフです。
プロパティ
| キー | 既定値 | 意味 |
|---|---|---|
spring.cache.type |
simple |
disk でエントリをディスクに保持 |
spring.cache.disk.time-to-live |
なし | エントリの寿命(実時間) |
spring.cache.disk.caches.<name>.time-to-live |
全体の値 | 1 つのキャッシュの寿命 |
spring.cache.disk.max-size |
なし | キャッシュごとの最大バイト数 |
spring.cache.disk.directory |
.spring/cache |
CacheStore の Bean がない場合のフォルダー |
spring.cache.disk.version |
なし | エントリを書き、読むときのバージョン |
spring.cache.resource-version |
false |
リソースを内容のバージョンで鍵にする |