すべてのプロパティ
spring_boot_starter_cache が読むすべてのプロパティです。これらはスターターが作る cacheManager の Bean を設定します。アプリケーションが独自の CacheManager (または cacheResolver という名前の Bean) を宣言すると、cacheManagerFromProperties を通す場合を除き、もう適用されません。例外は spring.cache.resource-version で、これはマネージャーにかかわらずキャッシュのインターセプターが読みます。スターターのメタデータ (lib/spring_gen/spring_metadata.json) にも同じ 12 個のキーが列挙されています。
使う理由
結果がどれだけ新しいままか、キャッシュがどれだけのメモリやディスクを使ってよいか、再起動後も残すかどうかは、環境によって決まります。開発では短く、本番では調整し、一部のテストでは無効にし、スマートフォンのアプリではディスクに置きます。プロパティを使えば、ビルドなしでそれらを変えられます。
例
メモリ上に:
# lib/resources/application.yml
spring:
cache:
type: simple
cache-names: books,prices,authors
simple:
time-to-live: 10m
max-size: 1000
caches:
prices:
time-to-live: 30s
"[books.byIsbn]":
max-size: 200
同じ内容を .properties で:
# lib/resources/application.properties
spring.cache.type=simple
spring.cache.cache-names=books,prices,authors
spring.cache.simple.time-to-live=10m
spring.cache.simple.max-size=1000
spring.cache.simple.caches.prices.time-to-live=30s
spring.cache.simple.caches[books.byIsbn].max-size=200
ディスク上に。結果は再起動後も残ります:
# lib/resources/application.yml
spring:
cache:
type: disk
resource-version: true
disk:
time-to-live: 1h
max-size: 50MB
version: 2.1.0
caches:
profiles:
time-to-live: 10m
同じ内容を .properties で:
# lib/resources/application.properties
spring.cache.type=disk
spring.cache.resource-version=true
spring.cache.disk.time-to-live=1h
spring.cache.disk.max-size=50MB
spring.cache.disk.version=2.1.0
spring.cache.disk.caches.profiles.time-to-live=10m
プロパティ
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
spring.cache.type |
generic、simple、disk、none |
アプリケーションが Cache の Bean を持てば generic、なければ simple |
キャッシュマネージャーの種類。generic: アプリケーションの Cache の Bean の SimpleCacheManager (少なくとも一つ必要)。simple: メモリ上のキャッシュ (InMemoryCacheManager)。disk: ディスク上のキャッシュで、エントリーは再起動後も残る (DiskCacheManager。再起動後も残るキャッシュ を参照)。none: 何もキャッシュしないため、メソッドは常に実行される (NoOpCacheManager)。それ以外の値は起動を失敗させる。 |
spring.cache.cache-names |
List<String> |
空: キャッシュは必要に応じて作られる | キャッシュの固定の集合 (books,authors、または YAML のリスト)。その場合、別のキャッシュを指定するアノテーションは失敗する。 |
spring.cache.simple.time-to-live |
Duration |
なし | エントリーは書かれてからこれだけ経つと期限切れになる (10m、30s、PT1H、またはミリ秒)。Caffeine のティッカーと同じく単調時計で測られる: システムの時計を設定しても有効期限は動かない。0 は何も保持しない。負の値は起動を失敗させる。 |
spring.cache.simple.max-size |
int |
なし | キャッシュごとの最大のエントリー数。いっぱいになると、最も長く使われていないエントリーが出ていく。0 は何も保持しない。負の値は起動を失敗させる。 |
spring.cache.simple.caches.<name>.time-to-live |
Duration |
全体のもの | このキャッシュについて、spring.cache.simple.time-to-live と同じ。負の値は起動を失敗させる。 |
spring.cache.simple.caches.<name>.max-size |
int |
全体のもの | このキャッシュについて、spring.cache.simple.max-size と同じ。負の値は起動を失敗させる。 |
spring.cache.disk.time-to-live |
Duration |
なし | エントリーは書かれてからこれだけ経つと期限切れになる。実時間で測られるため、再起動をまたいで数えられる。0 は何も保持しない。負の値は起動を失敗させる。 |
spring.cache.disk.caches.<name>.time-to-live |
Duration |
全体のもの | このキャッシュについて、spring.cache.disk.time-to-live と同じ。負の値は起動を失敗させる。 |
spring.cache.disk.max-size |
DataSize (50MB) |
なし | キャッシュごとに保持する最大のバイト数。超えると、古く書かれたものから消える。数えるのはそのキャッシュ自身のフォルダー (spring/caches/<name>/) だけ: Flutter スターターがダウンロードするファイルには専用の上限 spring.flutter.resources.cache.max-size がある (ネットワーク上のリソース を参照)。 |
spring.cache.disk.directory |
フォルダー | 作業フォルダーの .spring/cache |
CacheStore の Bean が置き場所を与えないときにエントリーを置くフォルダー。サーバーや Flutter のないプログラムが該当する。Flutter アプリはエントリーをファイルの cache の場所に置くため、そこではこのキーは何もしない。 |
spring.cache.disk.version |
テキスト | なし: すべてのエントリーを読む | エントリーを書くときのバージョン。別のバージョンのエントリーは読まないため、新しいバージョンで変わったものから作った結果は作り直される。 |
spring.cache.resource-version |
bool |
false |
内容のバージョンを知っているリソース (Flutter スターターが保持するファイル) から作る鍵を、アドレスとそのバージョンにするかどうか。そうすると、同じアドレスで変わったファイルから作った結果は作り直される。タイプにかかわらず、SimpleKeyGenerator が作る鍵 (key も keyGenerator もない操作) に適用される。バージョンはファイル全体のダイジェストなので、デフォルトではオフ。 |
spring.main.startup-checks.enabled |
bool |
未設定: デバッグビルドとプロファイルビルド | 実行時ではなくジェネレーターが読む。起動時チェックの cacheOperationValidator がビルドに含まれるかどうか。true: すべてのビルドに含める。false: どのビルドにも含めない。未設定: デバッグビルドとプロファイルビルドだけ。リリースビルドにはそのコードがなく、誤ったアノテーションはそのメンバーの最初の呼び出しで失敗する。 |
simple.* のキーは type=simple に、disk.* のキーは type=disk に適用されます。キャッシュごとの値はすべて、キャッシュがまだ存在するかどうかにかかわらず、起動時にチェックされます。
値の書き方
- 期間:
500ms、30s、10m、1h、ISO 8601 (PT1H)、または単なるミリ秒の数値。Durations を参照してください。 - データ量:
512KB、50MB、1GB、または単なるバイト数。DataSize を参照してください。 - ドットを含むキャッシュ名: 角括弧に入れます。
spring.cache.simple.caches[books.byIsbn].max-size。YAML ではキー"[books.byIsbn]":。spring.cache.disk.caches[books.byIsbn].time-to-liveも同じです。simple.cachesでは、そのまま書いても動きます。キーの末尾がプロパティ (max-size、time-to-live、またはmaxSize、max_size、MAXSIZE) で、残りがキャッシュ名です。 - 環境変数:
SPRING_CACHE_TYPE=disk、SPRING_CACHE_SIMPLE_TIME_TO_LIVE=10m、SPRING_CACHE_DISK_MAX_SIZE=50MB、SPRING_CACHE_SIMPLE_CACHES_BOOKS_MAX_SIZE=5(または..._MAXSIZE)。SPRING_CACHE_SIMPLE_CACHES_*では、キャッシュ名は小文字になり、その中の_はドットです (..._BOOKS_BYISBN_MAX_SIZEはbooks.byisbnを設定します)。
Spring (Java) との対応
spring.cache.type と spring.cache.cache-names は Spring Boot のものです。ここでの type が知っているのは generic、simple、disk、none で (caffeine、redis、jcache... はありません)、disk はこのスターター独自のものです。spring.cache.simple.*、spring.cache.disk.*、spring.cache.resource-version もこのスターターのものです。Spring Boot の simple タイプには設定がなく、そちらでは有効期間とサイズは spring.cache.caffeine.spec や spring.cache.redis.* から来て、結果を再起動後も残すには Redis のようなストアを使います。