インターフェース CachingConfigurer

すべての既知のサブインターフェース:
JCacheConfigurer
すべての既知の実装クラス:
CachingConfigurerSupportJCacheConfigurerSupport

public interface CachingConfigurer
@EnableCaching でアノテートされた @Configuration クラスによって実装されるインターフェースで、キャッシュの解決方法と、アノテーション駆動型キャッシュ管理用のキーの生成方法を明示的に指定する必要があります。

一般的な例とコンテキストについては @EnableCaching を参照してください。詳細な手順については、cacheManager()cacheResolver()keyGenerator()errorHandler() を参照してください。

導入:
3.1
作成者:
Chris Beams, Stephane Nicoll
関連事項:
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    default CacheManager
    アノテーション駆動型キャッシュ管理に使用するキャッシュマネージャー Bean を返します。
    CacheResolver Bean を返し、アノテーション駆動型キャッシュ管理の通常のキャッシュを解決するために使用します。
    キャッシュ関連エラーの処理に使用する CacheErrorHandler を返します。
    default KeyGenerator
    アノテーション駆動型キャッシュ管理に使用するキージェネレーター Bean を返します。
  • メソッドの詳細

    • cacheManager

      @Nullable default CacheManager cacheManager()
      アノテーション駆動型のキャッシュ管理に使用するキャッシュマネージャー Bean を返します。デフォルトの CacheResolver は、このキャッシュマネージャーでバックグラウンドで初期化されます。キャッシュ解決をより細かく管理するには、CacheResolver を直接設定することを検討してください。

      実装では、キャッシュマネージャーがコンテキストのライフサイクルに参加できるように、@Bean を明示的に宣言する必要があります。例:

       @Configuration
       @EnableCaching
       class AppConfig implements CachingConfigurer {
           @Bean // important!
           @Override
           CacheManager cacheManager() {
               // configure and return CacheManager instance
           }
           // ...
       }
       
      より完全な例については、@EnableCaching を参照してください。
    • cacheResolver

      @Nullable default CacheResolver cacheResolver()
      CacheResolver Bean を返し、アノテーション駆動型キャッシュ管理の通常のキャッシュを解決するために使用します。これは、使用する CacheManager を指定する代替のより強力なオプションです。

      cacheManager() と cacheResolver() の両方が設定されている場合、キャッシュマネージャーは無視されます。

      実装では、キャッシュリゾルバーがコンテキストのライフサイクルに参加できるように、@Bean を明示的に宣言する必要があります。例:

       @Configuration
       @EnableCaching
       class AppConfig implements CachingConfigurer {
           @Bean // important!
           @Override
           CacheResolver cacheResolver() {
               // configure and return CacheResolver instance
           }
           // ...
       }
       
      より完全な例については、EnableCaching を参照してください。
    • keyGenerator

      @Nullable default KeyGenerator keyGenerator()
      アノテーション駆動型キャッシュ管理に使用するキージェネレーター Bean を返します。

      デフォルトでは、SimpleKeyGenerator が使用されます。より完全な例については、@EnableCaching を参照してください。

    • errorHandler

      @Nullable default CacheErrorHandler errorHandler()
      キャッシュ関連エラーの処理に使用する CacheErrorHandler を返します。

      デフォルトでは、例外をクライアントに返す SimpleCacheErrorHandler が使用されています。より完全な例については、@EnableCaching を参照してください。