アノテーションインターフェース CacheEvict
@TargetSE({TYPESE,METHODSE})
@RetentionSE(RUNTIMESE)
@InheritedSE
@DocumentedSE
@Reflective
public @interface CacheEvict
メソッド(またはクラスのすべてのメソッド)が
cache evict 操作をトリガーすることを示すアノテーション。このアノテーションをメタアノテーションとして使用して、属性をオーバーライドしたカスタム合成アノテーションを作成できます。
- 導入:
- 3.1
- 作成者:
- Costin Leau, Stephane Nicoll, Sam Brannen
- 関連事項:
オプション要素の概要
オプション要素修飾子と型オプションの要素説明booleanキャッシュ内のすべてのエントリが削除されるかどうか。booleanメソッドが呼び出される前にエビクションが発生するかどうか。デフォルトCacheResolverがまだ設定されていない場合に作成するために使用するカスタムCacheManagerの Bean 名。StringSE[]キャッシュの排除操作に使用するキャッシュの名前。使用するカスタムCacheResolverの Bean 名。キャッシュエビクション操作を条件付きにするために使用される Spring 式言語(SpEL)式。キーを動的に計算するための Spring Expression Language(SpEL)式。使用するカスタムKeyGeneratorの Bean 名。StringSE[]cacheNames()のエイリアス。
要素の詳細
value
cacheNames()のエイリアス。他の属性が不要な場合に使用することを目的としています。例:
@CacheEvict("books")- デフォルト:
{}
cacheNames
key
StringSE keyキーを動的に計算するための Spring Expression Language(SpEL)式。デフォルトは
""です。つまり、カスタムkeyGenerator()が設定されていない限り、すべてのメソッドパラメーターがキーと見なされます。SpEL 式は、次のメタデータを提供する専用のコンテキストに対して評価します。
#resultは、メソッド呼び出しの結果への参照です。これは、beforeInvocation()がfalseの場合にのみ使用できます。Optionalなどのサポートされているラッパーの場合、#resultはラッパーではなく実際のオブジェクトを参照します- それぞれ
methodSE、ターゲットオブジェクト、影響を受けるキャッシュへの参照用の#root.method、#root.target、#root.caches。 - メソッド名(
#root.methodName)およびターゲットクラス(#root.targetClass)のショートカットも利用できます。 - メソッドの引数はインデックスでアクセスできます。たとえば、2 番目の引数は
#root.args[1]、#p1、#a1を介してアクセスできます。その情報が利用可能な場合、引数は名前でアクセスすることもできます。
- デフォルト:
""
keyGenerator
cacheManager
StringSE cacheManagerデフォルトCacheResolverがまだ設定されていない場合に作成するために使用するカスタムCacheManagerの Bean 名。cacheResolver()属性と相互に排他的です。- 関連事項:
- デフォルト:
""
cacheResolver
condition
StringSE conditionSpring キャッシュ削除操作を条件付きにするために使用される式言語 (SpEL) 式。条件がtrueと評価された場合、そのキャッシュを削除します。デフォルトは
""です。つまり、キャッシュの追い出しは常に実行されます。SpEL 式は、次のメタデータを提供する専用のコンテキストに対して評価します。
- それぞれ
methodSE、ターゲットオブジェクト、影響を受けるキャッシュへの参照用の#root.method、#root.target、#root.caches。 - メソッド名(
#root.methodName)およびターゲットクラス(#root.targetClass)のショートカットも利用できます。 - メソッドの引数はインデックスでアクセスできます。たとえば、2 番目の引数は
#root.args[1]、#p1、#a1を介してアクセスできます。その情報が利用可能な場合、引数は名前でアクセスすることもできます。
- デフォルト:
""
- それぞれ
allEntries
boolean allEntriesキャッシュ内のすべてのエントリが削除されるかどうか。デフォルトでは、関連付けられたキーの値のみが削除されます。
このパラメーターを
trueに設定し、key()を指定することはできないことに注意してください。- デフォルト:
false
beforeInvocation
boolean beforeInvocationメソッドが呼び出される前にエビクションが発生するかどうか。この属性を
trueに設定すると、メソッドの結果(つまり、例外をスローしたかどうか)に関係なく、エビクションが発生します。デフォルトは
falseです。つまり、アドバイスされたメソッドが正常に呼び出された後(つまり、呼び出しが例外をスローしなかった場合のみ)、キャッシュの排除操作が行われます。- デフォルト:
false