クラス CacheRequestHandlerAdvice
java.lang.ObjectSE
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice
org.springframework.integration.handler.advice.CacheRequestHandlerAdvice
- 実装されたすべてのインターフェース:
Advice
、Interceptor
、MethodInterceptor
、Aware
、BeanFactoryAware
、BeanNameAware
、InitializingBean
、SmartInitializingSingleton
、ApplicationContextAware
、ComponentSourceAware
、ExpressionCapable
、NamedComponent
public class CacheRequestHandlerAdvice
extends AbstractRequestHandlerAdvice
implements SmartInitializingSingleton
AbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message)
の結果をキャッシュするための AbstractRequestHandlerAdvice
実装。すべてのキャッシュ操作 (cacheable、put、evict) をサポートします。デフォルトでは、提供された cacheNames
には cacheable のみが適用されます。デフォルトのキャッシュ key
は、リクエストメッセージの payload
です。- 導入:
- 5.2
- 作成者:
- Artem Bilan, Ngoc Nhan
- 関連事項:
ネストされたクラスのサマリー
クラス org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice から継承されたネストクラス / インターフェース
AbstractRequestHandlerAdvice.ExecutionCallback, AbstractRequestHandlerAdvice.ThrowableHolderException
フィールドのサマリー
クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
EXPRESSION_PARSER, logger
コンストラクターの概要
コンストラクターコンストラクター説明CacheRequestHandlerAdvice
(StringSE... cacheNamesArg) 指定されたキャッシュ名とデフォルトのCacheableOperation
に基づいてCacheRequestHandlerAdvice
インスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明void
protected ObjectSE
doInvoke
(AbstractRequestHandlerAdvice.ExecutionCallback callback, ObjectSE target, Message<?> message) サブクラスは、このメソッドを実装して、MessageHandler
に動作を適用します。protected void
onInit()
サブクラスは、初期化ロジック用にこれを実装できます。void
setCacheManager
(CacheManager cacheManager) void
setCacheOperations
(CacheOperation... cacheOperations) CacheRequestHandlerAdvice.IntegrationCacheAspect
を介してAbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message)
メソッドに適用されるCacheOperation
のセットを構成します。void
setCacheResolver
(CacheResolver cacheResolver) void
setErrorHandler
(CacheErrorHandler errorHandler) キャッシュプロバイダーによってスローされたエラーの処理に使用するCacheErrorHandler
インスタンスを設定します。void
setKeyExpression
(Expression keyExpression) リクエストメッセージに対して実行時にキャッシュキーを評価するように SpEL 式を構成します。void
setKeyExpressionString
(StringSE keyExpression) リクエストメッセージに対して実行時にキャッシュキーを評価するように、SpEL スタイルで式を構成します。void
setKeyFunction
(FunctionSE<Message<?>, ?> keyFunction) Function
SE を構成して、リクエストメッセージに対して実行時にキャッシュキーを評価します。クラス org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice から継承されたメソッド
invoke, unwrapExceptionIfNecessary, unwrapThrowableIfNecessary
クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getComponentType, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString
コンストラクターの詳細
CacheRequestHandlerAdvice
指定されたキャッシュ名とデフォルトのCacheableOperation
に基づいてCacheRequestHandlerAdvice
インスタンスを作成します。これは、setCacheOperations(org.springframework.cache.interceptor.CacheOperation...)
によってオーバーライドできます。- パラメーター:
cacheNamesArg
- アドバイスで使用するキャッシュの名前。- 関連事項:
メソッドの詳細
setCacheOperations
CacheRequestHandlerAdvice.IntegrationCacheAspect
を介してAbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message)
メソッドに適用されるCacheOperation
のセットを構成します。これは、Caching
アノテーションによって提供される手法に似ています。- パラメーター:
cacheOperations
- 使用するCacheOperation
の配列。- 関連事項:
setCacheManager
一部のCacheOperation
に共通のCacheManager
が付属していない場合は、共通のCacheManager
を構成します。同様のアプローチについては、CacheConfig
アノテーションを参照してください。- パラメーター:
cacheManager
- 使用するCacheManager
。- 関連事項:
setCacheResolver
一部のCacheOperation
に共通のCacheResolver
が付属していない場合は、共通のCacheResolver
を構成します。同様のアプローチについては、CacheConfig
を参照してください。- パラメーター:
cacheResolver
- 使用するCacheResolver
。- 関連事項:
setErrorHandler
キャッシュプロバイダーによってスローされたエラーの処理に使用するCacheErrorHandler
インスタンスを設定します。- パラメーター:
errorHandler
- 使用するCacheErrorHandler
。- 関連事項:
setKeyExpressionString
リクエストメッセージに対して実行時にキャッシュキーを評価するように、SpEL スタイルで式を構成します。- パラメーター:
keyExpression
- キャッシュキーの生成に使用する式。
setKeyFunction
Function
SE を構成して、リクエストメッセージに対して実行時にキャッシュキーを評価します。- パラメーター:
keyFunction
- キャッシュキーの生成に使用するFunction
SE。
setKeyExpression
リクエストメッセージに対して実行時にキャッシュキーを評価するように SpEL 式を構成します。- パラメーター:
keyExpression
- キャッシュキーの生成に使用する式。
afterSingletonsInstantiated
public void afterSingletonsInstantiated()- 次で指定:
- インターフェース
SmartInitializingSingleton
のafterSingletonsInstantiated
onInit
protected void onInit()クラスからコピーされた説明:IntegrationObjectSupport
サブクラスは、初期化ロジック用にこれを実装できます。- オーバーライド:
- クラス
IntegrationObjectSupport
のonInit
doInvoke
@Nullable protected ObjectSE doInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback, ObjectSE target, Message<?> message) クラスからコピーされた説明:AbstractRequestHandlerAdvice
サブクラスは、このメソッドを実装して、MessageHandler
に動作を適用します。callback.execute() はハンドラーメソッドを呼び出し、その結果、null を返します。
- 次で指定:
- クラス
AbstractRequestHandlerAdvice
のdoInvoke
- パラメーター:
callback
- サブクラスは、このインターフェースで execute() メソッドを呼び出して、ハンドラーメソッドを呼び出します。target
- ターゲットハンドラー。message
- ハンドラーに送信されるメッセージ。- 戻り値:
MessageHandler
を呼び出した後の結果。