Cacheable (Spring Framework API)

```
@TargetSE(valueSE={TYPESE,METHODSE})
 @RetentionSE(valueSE=RUNTIMESE)
 @InheritedSE
 @DocumentedSE
public @interface Cacheable
```
メソッド（またはクラス内のすべてのメソッド）を呼び出した結果をキャッシュできることを示すアノテーション。
推奨メソッドが呼び出されるたびに、キャッシュ動作が適用され、指定された引数に対してメソッドがすでに呼び出されているかどうかがチェックされます。実用的なデフォルトでは、単にメソッドパラメーターを使用してキーを計算しますが、key() 属性を介して SpEL 式を提供するか、デフォルトの KeyGenerator 実装を置き換えることができます（keyGenerator() を参照）。
計算されたキーの値がキャッシュに見つからない場合、ターゲットメソッドが呼び出され、戻り値が関連するキャッシュに保存されます。OptionalSE 戻り値の型は自動的にアンラップされることに注意してください。Optional 値が存在SEする場合、関連するキャッシュに保存されます。Optional 値が存在しない場合、null は関連するキャッシュに保存されます。
このアノテーションをメタアノテーションとして使用して、属性をオーバーライドしたカスタム合成アノテーションを作成できます。
導入:
3.1
作成者:
Costin Leau, Phillip Webb, Stephane Nicoll, Sam Brannen
関連事項:
CacheConfig

オプション要素のサマリー

オプション要素
修飾子と型	オプションの要素と説明
`StringSE`	`cacheManager` デフォルト `CacheResolver` がまだ設定されていない場合に作成するために使用するカスタム `CacheManager` の Bean 名。
`StringSE[]`	`cacheNames` メソッド呼び出しの結果が保存されるキャッシュの名前。
`StringSE`	`cacheResolver` 使用するカスタム `CacheResolver` の Bean 名。
`StringSE`	`condition` メソッドキャッシュを条件付きにするために使用される Spring Expression Language（SpEL）式。
`StringSE`	`key` キーを動的に計算するための Spring Expression Language（SpEL）式。
`StringSE`	`keyGenerator` 使用するカスタム `KeyGenerator` の Bean 名。
`boolean`	`sync` 複数のスレッドが同じキーの値をロードしようとしている場合は、基になるメソッドの呼び出しを同期します。
`StringSE`	`unless` メソッドのキャッシュを拒否するために使用される Spring 式言語（SpEL）式。
`StringSE[]`	`value` `cacheNames()` のエイリアス。

- 要素の詳細
  - value
```
@AliasFor(value="cacheNames")
public abstract StringSE[] value
```
    cacheNames() のエイリアス。
    デフォルト:
    {}
- - cacheNames
```
@AliasFor(value="value")
public abstract StringSE[] cacheNames
```
    メソッド呼び出しの結果が保存されるキャッシュの名前。
    名前を使用して、特定の Bean 定義の修飾子の値または Bean 名に一致するターゲットキャッシュ（1 つまたは複数）を決定できます。
    導入:
    4.2
    関連事項:
    value(), CacheConfig.cacheNames()
    デフォルト:
    {}
- - key
```
public abstract 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
```
public abstract StringSE keyGenerator
```
    使用するカスタム KeyGenerator の Bean 名。
    key() 属性と相互に排他的です。
    関連事項:
    CacheConfig.keyGenerator()
    デフォルト:
    ""
- - cacheManager
```
public abstract StringSE cacheManager
```
    デフォルト CacheResolver がまだ設定されていない場合に作成するために使用するカスタム CacheManager の Bean 名。
    cacheResolver() 属性と相互に排他的です。
    関連事項:
    SimpleCacheResolver, CacheConfig.cacheManager()
    デフォルト:
    ""
- - cacheResolver
```
public abstract StringSE cacheResolver
```
    使用するカスタム CacheResolver の Bean 名。
    関連事項:
    CacheConfig.cacheResolver()
    デフォルト:
    ""
- - condition
```
public abstract StringSE condition
```
    メソッドキャッシュを条件付きにするために使用される Spring Expression Language（SpEL）式。
    デフォルトは "" です。つまり、メソッドの結果は常にキャッシュされます。
    SpEL 式は、次のメタデータを提供する専用のコンテキストに対して評価します。
    - それぞれ methodSE、ターゲットオブジェクト、影響を受けるキャッシュへの参照用の #root.method、#root.target、#root.caches。
    - メソッド名（#root.methodName）およびターゲットクラス（#root.targetClass）のショートカットも利用できます。
    - メソッドの引数はインデックスでアクセスできます。たとえば、2 番目の引数は #root.args[1]、#p1、#a1 を介してアクセスできます。その情報が利用可能な場合、引数は名前でアクセスすることもできます。
    デフォルト:
    ""
- - unless
```
public abstract StringSE unless
```
    メソッドのキャッシュを拒否するために使用される Spring 式言語（SpEL）式。
    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
```
public abstract boolean sync
```
    複数のスレッドが同じキーの値をロードしようとしている場合は、基になるメソッドの呼び出しを同期します。同期にはいくつかの制限があります。
    1. unless() はサポートされていません
    2. 指定できるキャッシュは 1 つだけです
    3. 他のキャッシュ関連の操作は組み合わせることができません
    これは事実上ヒントであり、使用している実際のキャッシュプロバイダーは同期された方法でサポートしない場合があります。実際のセマンティクスの詳細については、プロバイダーのドキュメントを確認してください。
    導入:
    4.3
    関連事項:
    Cache.get(Object, Callable)
    デフォルト:
    false

アノテーション型 Cacheable

オプション要素のサマリー

要素の詳細

value

cacheNames

key

keyGenerator

cacheManager

cacheResolver

condition

unless

sync