クラス RedisCache
java.lang.ObjectSE
org.springframework.cache.support.AbstractValueAdaptingCache
org.springframework.data.redis.cache.RedisCache
- 実装されているすべてのインターフェース:
Cache
Redis をキャッシュデータの基礎となるストアとして使用する
Cache 実装。RedisCacheManager を使用して RedisCache インスタンスを作成します。
- 導入:
- 2.0
- 作成者:
- Christoph Strobl, Mark Paluch, Piotr Mionskowski, Jos Roseboom, John Blum
ネストされたクラスの要約
インターフェース org.springframework.cache.Cache から継承されたネストクラス / インターフェース
Cache.ValueRetrievalException, Cache.ValueWrapperコンストラクターの概要
コンストラクター修飾子コンストラクター説明protectedRedisCache(StringSE name, RedisCacheWriter cacheWriter, RedisCacheConfiguration cacheConfiguration) 指定されたnameSE およびRedisCacheConfigurationで新しいRedisCacheを作成し、RedisCacheWriterを使用してキャッシュ操作をサポートする Redis コマンドを実行します。メソッドのサマリー
修飾子と型メソッド説明voidclear()void指定されたkeyPatternSE に一致するキーをクリアします。voidこのキャッシュのすべての統計カウンターとゲージをリセットします。protected StringSEconvertKey(ObjectSE key) keyを、キャッシュキーの作成に使用されるStringSE に変換します。protected StringSEcreateCacheKey(ObjectSE key) 直列化される前にキャッシュキーを作成するためのカスタマイズフック。protected @Nullable ObjectSEdeserializeCacheValue(byte[] value) 指定されたバイト配列を実際のcache valueSE に逆直列化します。voidbooleanevictIfPresent(ObjectSE key) <T> @Nullable Tget(ObjectSE key, CallableSE<T> valueLoader) 初期化時にこのRedisCacheを構成するために使用されるRedisCacheConfigurationを取得します。protected RedisCacheWriterRedis をキャッシュ操作に適応させるために使用される、構成されたRedisCacheWriterを取得します。protected ConversionServicegetName()このキャッシュインスタンスのCacheStatisticsスナップショットを返します。booleanprotected <T> TloadCacheValue(ObjectSE key, CallableSE<T> valueLoader) 指定されたvalueLoaderSE を使用してObjectSE をロードします。protected @Nullable ObjectSEprotected @Nullable ObjectSEpreProcessCacheValue(@Nullable ObjectSE value) オブジェクトをRedisSerializerに渡す前に呼び出されるカスタマイズフック。void@Nullable Cache.ValueWrapperputIfAbsent(ObjectSE key, @Nullable ObjectSE value) <T> CompletableFutureSE<T>retrieve(ObjectSE key, SupplierSE<CompletableFutureSE<T>> valueLoader) protected byte[]serializeCacheKey(StringSE cacheKey) 指定されたcache keySE を直列化します。protected byte[]serializeCacheValue(ObjectSE value) valueSE を直列化してバイト配列としてキャッシュします。クラス org.springframework.cache.support.AbstractValueAdaptingCache から継承されたメソッド
fromStoreValue, get, get, isAllowNullValues, toStoreValue, toValueWrapper
コンストラクターの詳細
RedisCache
protected RedisCache(StringSE name, RedisCacheWriter cacheWriter, RedisCacheConfiguration cacheConfiguration) 指定されたnameSE およびRedisCacheConfigurationで新しいRedisCacheを作成し、RedisCacheWriterを使用してキャッシュ操作をサポートする Redis コマンドを実行します。- パラメーター:
name- このCacheの場合はnameSE。null であってはなりません。cacheWriter-RedisCacheWriterは、必要な Redis コマンドを実行することでRedisCache操作を実行していました。null であってはなりません。cacheConfiguration-RedisCacheConfigurationは作成時にこのRedisCacheに適用されます。null であってはなりません。- 例外:
IllegalArgumentExceptionSE- 指定されたRedisCacheWriterまたはRedisCacheConfigurationが null であるか、このRedisCacheの指定されたStringSE 名が null の場合。
メソッドの詳細
getCacheConfiguration
初期化時にこのRedisCacheを構成するために使用されるRedisCacheConfigurationを取得します。- 戻り値:
- 初期化時にこの
RedisCacheを構成するために使用される不変のRedisCacheConfiguration。
getCacheWriter
Redis をキャッシュ操作に適応させるために使用される、構成されたRedisCacheWriterを取得します。- 戻り値:
- 構成された
RedisCacheWriterは、Redis をキャッシュ操作に適応させるために使用されます。
getConversionService
- 戻り値:
- 構成された
ConversionServiceは、キャッシュ内のエントリにアクセスするときにcache keysSE をStringSE に変換するために使用されます。 - 関連事項:
getName
getNativeCache
getStatistics
このキャッシュインスタンスのCacheStatisticsスナップショットを返します。統計は、バッキング Redis データストアからではなく、キャッシュインスタンスごとに蓄積されます。
- 戻り値:
- この
RedisCacheのCacheStatisticsオブジェクト。 - 導入:
- 2.4
get
loadCacheValue
指定されたvalueLoaderSE を使用してObjectSE をロードします。- 型パラメーター:
T- ロードされたcache valueSE のtypeSE。- パラメーター:
key-keySE は、ロードされたcache valueSE にマップされます。valueLoader- 指定されたkeySE のvalueSE をロードするために使用されるCallableSE オブジェクト。- 戻り値:
- ロードされた
valueSE。
lookup
- 次で指定:
- クラス
AbstractValueAdaptingCacheのlookup
put
putIfAbsent
clear
public void clear()clear
指定されたkeyPatternSE に一致するキーをクリアします。キャッシュキーが Redis パターンを使用してこれらのキーをマッチングできる形式でフォーマットされている場合に便利です。実際の消去は、非同期または遅延方式で実行され、その後のルックアップでエントリが引き続き表示される可能性があります。これは、たとえばトランザクションキャッシュデコレータの場合です。
invalidate()を使用して、エントリの即時削除を保証します。- パラメーター:
keyPattern-patternSE は Redis キーと一致してクリアされていました。- 導入:
- 3.0
invalidate
public boolean invalidate()clearStatistics
public void clearStatistics()このキャッシュのすべての統計カウンターとゲージをリセットします。- 導入:
- 2.4
evict
evictIfPresent
retrieve
retrieve
public <T> CompletableFutureSE<T> retrieve(ObjectSE key, SupplierSE<CompletableFutureSE<T>> valueLoader) preProcessCacheValue
オブジェクトをRedisSerializerに渡す前に呼び出されるカスタマイズフック。- パラメーター:
value- null でもかまいません。- 戻り値:
- 前処理された値。null にすることができます。
serializeCacheKey
指定されたcache keySE を直列化します。- パラメーター:
cacheKey-cache keySE を直列化します。null であってはなりません。- 戻り値:
- 指定された直列化された
cache keySE からのバイトの配列。決して null ではありません。 - 関連事項:
serializeCacheValue
valueSE を直列化してバイト配列としてキャッシュします。deserializeCacheValue
指定されたバイト配列を実際のcache valueSE に逆直列化します。- パラメーター:
value- 逆直列化するバイトの配列。null であってはなりません。- 戻り値:
- 構成された値
RedisSerializationContext.SerializationPairを使用してバイト配列から逆直列化されたObjectSE。null にすることもできます。 - 関連事項:
createCacheKey
直列化される前にキャッシュキーを作成するためのカスタマイズフック。- パラメーター:
key- null になることはありません。- 戻り値:
- 決して null にはなりません。
convertKey
keyを、キャッシュキーの作成に使用されるStringSE に変換します。- パラメーター:
key- null になることはありません。- 戻り値:
- 決して null にはなりません。
- 例外:
IllegalStateExceptionSE-keyをStringSE に変換できない場合。