クラス 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 @Nullable... cacheNamesArg) 指定されたキャッシュ名とデフォルトのCacheableOperationに基づいてCacheRequestHandlerAdviceインスタンスを作成します。方法の概要
修飾子と型メソッド説明voidprotected @Nullable ObjectSEdoInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback, ObjectSE target, Message<?> message) サブクラスは、このメソッドを実装して、MessageHandlerに動作を適用します。protected voidonInit()サブクラスは、初期化ロジック用にこれを実装できます。voidsetCacheManager(CacheManager cacheManager) voidsetCacheOperations(CacheOperation... cacheOperations) CacheRequestHandlerAdvice.IntegrationCacheAspectを介してAbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message)メソッドに適用されるCacheOperationのセットを構成します。voidsetCacheResolver(CacheResolver cacheResolver) voidsetErrorHandler(CacheErrorHandler errorHandler) キャッシュプロバイダーによってスローされたエラーの処理に使用するCacheErrorHandlerインスタンスを設定します。voidsetKeyExpression(Expression keyExpression) リクエストメッセージに対して実行時にキャッシュキーを評価するように SpEL 式を構成します。voidsetKeyExpressionString(StringSE keyExpression) リクエストメッセージに対して実行時にキャッシュキーを評価するように、SpEL スタイルで式を構成します。voidsetKeyFunction(FunctionSE<Message<?>, ?> keyFunction) FunctionSE を構成して、リクエストメッセージに対して実行時にキャッシュキーを評価します。クラス org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice から継承されたメソッド
getComponentType, invoke, unwrapExceptionIfNecessary, unwrapThrowableIfNecessaryクラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, 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
FunctionSE を構成して、リクエストメッセージに対して実行時にキャッシュキーを評価します。- パラメーター:
keyFunction- キャッシュキーの生成に使用するFunctionSE。
setKeyExpression
リクエストメッセージに対して実行時にキャッシュキーを評価するように SpEL 式を構成します。- パラメーター:
keyExpression- キャッシュキーの生成に使用する式。
afterSingletonsInstantiated
public void afterSingletonsInstantiated()- 次で指定:
- インターフェース
SmartInitializingSingletonのafterSingletonsInstantiated
onInit
protected void onInit()クラスからコピーされた説明:IntegrationObjectSupportサブクラスは、初期化ロジック用にこれを実装できます。- オーバーライド:
- クラス
IntegrationObjectSupportのonInit
doInvoke
protected @Nullable ObjectSE doInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback, ObjectSE target, Message<?> message) クラスからコピーされた説明:AbstractRequestHandlerAdviceサブクラスは、このメソッドを実装して、MessageHandlerに動作を適用します。callback.execute() はハンドラーメソッドを呼び出し、その結果、null を返します。
- 次で指定:
- クラス
AbstractRequestHandlerAdviceのdoInvoke - パラメーター:
callback- サブクラスは、このインターフェースで execute() メソッドを呼び出して、ハンドラーメソッドを呼び出します。target- ターゲットハンドラー。message- ハンドラーに送信されるメッセージ。- 戻り値:
MessageHandlerを呼び出した後の結果。