アノテーションインターフェース Cacheable

要素の詳細

• value

  @AliasFor("cacheNames") StringSE[] value

  cacheNames() のエイリアス。

  デフォルト:

  {}

• cacheNames

  @AliasFor("value") StringSE[] cacheNames

  メソッド呼び出しの結果が保存されるキャッシュの名前。

  名前はターゲットキャッシュを決定するために使用され、通常は CacheManager.getCache(java.lang.String) に委譲される構成された cacheResolver() を介して解決されます。

  通常、これは単一のキャッシュ名になります。複数の名前が指定されている場合、定義の順序でキャッシュヒットについて参照され、すべての名前が新しくキャッシュされた同じ値に対する put/evict リクエストを受け取ります。

  非同期 / リアクティブキャッシュアクセスでは、ターゲットキャッシュによっては、指定されたすべてのキャッシュを完全に参照できない場合があることに注意してください。後で決定されたキャッシュミス (Redis など) の場合、それ以降のキャッシュは参照されなくなります。結果として、非同期キャッシュモード設定で複数のキャッシュ名を指定することは、早期に決定されたキャッシュミス (Caffeine など) の場合にのみ意味を持ちます。

  導入:

  4.2

  関連事項:

  • value()
  • CacheConfig.cacheNames()

  デフォルト:

  {}

• key

  StringSE key

  キーを動的に計算するための Spring Expression Language（SpEL）式。

  デフォルトは "" です。つまり、カスタム keyGenerator() が構成されていない限り、すべてのメソッドパラメーターがキーと見なされます。

  SpEL 式は、次のメタデータを提供する専用のコンテキストに対して評価します。

  • それぞれ methodSE、ターゲットオブジェクト、影響を受けるキャッシュへの参照用の #root.method、#root.target、#root.caches。
  • メソッド名（#root.methodName）およびターゲットクラス（#root.targetClass）のショートカットも利用できます。
  • メソッドの引数はインデックスでアクセスできます。たとえば、2 番目の引数は #root.args[1]、#p1、#a1 を介してアクセスできます。その情報が利用可能な場合、引数は名前でアクセスすることもできます。

  デフォルト:

  ""

• keyGenerator

  StringSE keyGenerator

  使用するカスタム KeyGenerator の Bean 名。

  key() 属性と相互に排他的です。

  関連事項:

  • CacheConfig.keyGenerator()

  デフォルト:

  ""

• cacheManager

  StringSE cacheManager

  デフォルト CacheResolver がまだ設定されていない場合に作成するために使用するカスタム CacheManager の Bean 名。

  cacheResolver() 属性と相互に排他的です。

  関連事項:

  • SimpleCacheResolver
  • CacheConfig.cacheManager()

  デフォルト:

  ""

• cacheResolver

  StringSE cacheResolver

  使用するカスタム CacheResolver の Bean 名。

  関連事項:

  • CacheConfig.cacheResolver()

  デフォルト:

  ""

• condition

  StringSE condition

  Spring メソッドのキャッシュを条件付きにするために使用される式言語 (SpEL) 式。条件が true と評価された場合、結果をキャッシュします。

  デフォルトは "" です。つまり、メソッドの結果は常にキャッシュされます。

  SpEL 式は、次のメタデータを提供する専用のコンテキストに対して評価します。

  • それぞれ methodSE、ターゲットオブジェクト、影響を受けるキャッシュへの参照用の #root.method、#root.target、#root.caches。
  • メソッド名（#root.methodName）およびターゲットクラス（#root.targetClass）のショートカットも利用できます。
  • メソッドの引数はインデックスでアクセスできます。たとえば、2 番目の引数は #root.args[1]、#p1、#a1 を介してアクセスできます。その情報が利用可能な場合、引数は名前でアクセスすることもできます。

  デフォルト:

  ""

• unless

  StringSE unless

  Spring メソッドのキャッシュを拒否するために使用される式言語 (SpEL) 式。条件が true と評価された場合、結果のキャッシュを拒否します。

  condition() とは異なり、この式はメソッドが呼び出された後に評価されるため、result を参照できます。

  デフォルトは "" です。つまり、キャッシュが拒否されることはありません。

  SpEL 式は、次のメタデータを提供する専用のコンテキストに対して評価します。

  • メソッド呼び出しの結果への参照については、#result。Optional などのサポートされているラッパーの場合、#result はラッパーではなく実際のオブジェクトを参照します
  • それぞれ methodSE、ターゲットオブジェクト、影響を受けるキャッシュへの参照用の #root.method、#root.target、#root.caches。
  • メソッド名（#root.methodName）およびターゲットクラス（#root.targetClass）のショートカットも利用できます。
  • メソッドの引数はインデックスでアクセスできます。たとえば、2 番目の引数は #root.args[1]、#p1、#a1 を介してアクセスできます。その情報が利用可能な場合、引数は名前でアクセスすることもできます。

  導入:

  3.2

  デフォルト:

  ""

• sync

  boolean sync

  複数のスレッドが同じキーの値をロードしようとしている場合は、基になるメソッドの呼び出しを同期します。同期にはいくつかの制限があります。

  1. unless() はサポートされていません
  2. 指定できるキャッシュは 1 つだけです
  3. 他のキャッシュ関連の操作は組み合わせることができません

  これは事実上ヒントであり、選択したキャッシュプロバイダーが実際には同期された方法でサポートしていない可能性があります。実際のセマンティクスの詳細については、プロバイダーのドキュメントを確認してください。

  導入:

  4.3

  関連事項:

  • Cache.get(Object, Callable)

  デフォルト:

  false