クラス RedisCacheConfiguration

メソッドの詳細

• defaultCacheConfig

  public static RedisCacheConfiguration defaultCacheConfig()

  以下を使用したデフォルトの RedisCacheConfiguration:

  キーの有効期限

  永遠

  null 値をキャッシュする

  はい

  プレフィックスキャッシュキー

  はい

  デフォルト接頭部

  [ 実際のキャッシュ名 ]

  キーシリアライザー

  StringRedisSerializer

  値シリアライザー

  JdkSerializationRedisSerializer

  変換サービス

  default キャッシュキーコンバーターを備えた DefaultFormattingConversionService

  戻り値:

  新しい RedisCacheConfiguration。

• defaultCacheConfig

  public static RedisCacheConfiguration defaultCacheConfig(@Nullable ClassLoaderSE classLoader)

  以下を使用して、ClassLoaderSE を指定してデフォルトの RedisCacheConfiguration を作成します。

  キーの有効期限

  永遠

  null 値をキャッシュする

  はい

  プレフィックスキャッシュキー

  はい

  デフォルト接頭部

  [ 実際のキャッシュ名 ]

  キーシリアライザー

  StringRedisSerializer

  値シリアライザー

  JdkSerializationRedisSerializer

  変換サービス

  default キャッシュキーコンバーターを備えた DefaultFormattingConversionService

  パラメーター:

  classLoader - JdkSerializationRedisSerializer による逆直列化に使用される ClassLoaderSE。

  戻り値:

  新しい RedisCacheConfiguration。

  導入:

  2.1

• prefixCacheNameWith

  public RedisCacheConfiguration prefixCacheNameWith(StringSE prefix)

  指定された値を cache name の前に付けます。
  生成されるキャッシュキーは prefix + cache name + "::" + cache entry key になります。

  パラメーター:

  prefix - キャッシュ名の前に付けるプレフィックス。

  戻り値:

  新しい RedisCacheConfiguration。

  導入:

  2.3

  関連事項:

  • computePrefixWith(CacheKeyPrefix)
  • CacheKeyPrefix.prefixed(String)

• computePrefixWith

  public RedisCacheConfiguration computePrefixWith(CacheKeyPrefix cacheKeyPrefix)

  指定された CacheKeyPrefix を使用して、関数入力としてキャッシュ名を指定した実際の Redis キーのプレフィックスを計算します。

  パラメーター:

  cacheKeyPrefix - null であってはなりません。

  戻り値:

  新しい RedisCacheConfiguration。

  導入:

  2.0.4

  関連事項:

  • CacheKeyPrefix

• disableCachingNullValues

  public RedisCacheConfiguration disableCachingNullValues()

  null 値のキャッシュを無効にします。
  null 値を含む Cache.put(Object, Object) 操作はエラーになることに注意してください。Redis には何も書き込まれず、何も削除されません。既存のキーは、以前とまったく同じ値でその後も存在します。

  戻り値:

  新しい RedisCacheConfiguration。

• disableKeyPrefix

  public RedisCacheConfiguration disableKeyPrefix()

  キャッシュキープレフィックスの使用を無効にします。
  注 : Cache.clear() を使用すると、Redis のキーが意図せず削除される可能性があります。プレフィックスを無効にするときは、必ず専用の Redis インスタンスを使用してください。

  戻り値:

  新しい RedisCacheConfiguration。

• enableTimeToIdle

  public RedisCacheConfiguration enableTimeToIdle()

  Cache.get(Object) などの Cache 読み取り操作でアイドル時間 (TTI) の有効期限を有効にします。

  このオプションを有効にすると、Cache 書き込み操作と同じ TTL expiration policy から Cache 読み取り操作が適用されます。実際には、これにより、GET の代わりに Redis GETEX コマンドが呼び出されます。

  Redis は TTI の概念をサポートせず、TTL のみをサポートします。ただし、TTL 有効期限が読み取りと書き込みの両方のすべての Cache 操作に同様に適用され、有効期限付きで渡された Cache 操作がアプリケーション全体で一貫して使用される場合、事実上、アプリケーションは TTI 有効期限のような動作を実現できます。

  Redis 6.2.0 以降が必要です。

  戻り値:

  この RedisCacheConfiguration。

  導入:

  3.2.0

  関連事項:

  • GETEX

• entryTtl

  public RedisCacheConfiguration entryTtl(DurationSE ttl)

  キャッシュエントリに適用する ttl を設定します。Duration.ZEROSE を使用して、永遠のキャッシュを宣言します。

  パラメーター:

  ttl - null であってはなりません。

  戻り値:

  新しい RedisCacheConfiguration。

• entryTtl

  public RedisCacheConfiguration entryTtl(RedisCacheWriter.TtlFunction ttlFunction)

  TTL function を設定して、キャッシュエントリの存続時間を計算します。

  パラメーター:

  ttlFunction - キャッシュエントリの存続時間を計算するための RedisCacheWriter.TtlFunction は null であってはなりません。

  戻り値:

  新しい RedisCacheConfiguration。

  導入:

  3.2

• serializeKeysWith

  public RedisCacheConfiguration serializeKeysWith(RedisSerializationContext.SerializationPair<StringSE> keySerializationPair)

  キャッシュキーの逆直列化 / 直列化に使用される RedisSerializationContext.SerializationPair を定義します。

  パラメーター:

  keySerializationPair - null であってはなりません。

  戻り値:

  新しい RedisCacheConfiguration。

• serializeValuesWith

  public RedisCacheConfiguration serializeValuesWith(RedisSerializationContext.SerializationPair<?> valueSerializationPair)

  キャッシュ値の逆直列化 / 直列化に使用される RedisSerializationContext.SerializationPair を定義します。

  パラメーター:

  valueSerializationPair - null であってはなりません。

  戻り値:

  新しい RedisCacheConfiguration。

• withConversionService

  public RedisCacheConfiguration withConversionService(ConversionService conversionService)

  キャッシュキーから StringSE への変換に使用される ConversionService を定義します。

  パラメーター:

  conversionService - null であってはなりません。

  戻り値:

  新しい RedisCacheConfiguration。

• getAllowCacheNullValues

  public boolean getAllowCacheNullValues()

  戻り値:

  null のキャッシュが許可されている場合は true。

• isTimeToIdleEnabled

  public boolean isTimeToIdleEnabled()

  キャッシュに対してアイドル時間 (TTI) の有効期限が有効になっているかどうかを決定します。

  enableTimeToIdle() を使用してオプトインし、キャッシュのアイドル時間 (TTI) 有効期限を有効にします。

  戻り値:

  アイドル時間 (TTI) の有効期限が構成され、キャッシュが有効になっている場合は true。デフォルトは false です。

  導入:

  3.2.0

  関連事項:

  • GETEX

• usePrefix

  public boolean usePrefix()

  戻り値:

  キャッシュキーの前に getKeyPrefixFor(String) が存在する場合は接頭辞を付ける必要がある場合、または Cache.getName() に解決されるデフォルトの場合は true。

• getConversionService

  public ConversionService getConversionService()

  戻り値:

  キャッシュキーから StringSE への変換に使用される ConversionService。null になることはありません。

• getKeyPrefix

  public CacheKeyPrefix getKeyPrefix()

  構成された CacheKeyPrefix を取得します。

  戻り値:

  構成された CacheKeyPrefix

• getKeyPrefixFor

  public StringSE getKeyPrefixFor(StringSE cacheName)

  指定された cacheName の計算されたキープレフィックスを取得します。

  戻り値:

  決して null にはなりません。

  導入:

  2.0.4

• getKeySerializationPair

  public RedisSerializationContext.SerializationPair<StringSE> getKeySerializationPair()

  戻り値:

  決して null にはなりません。

• getValueSerializationPair

  public RedisSerializationContext.SerializationPair<ObjectSE> getValueSerializationPair()

  戻り値:

  決して null にはなりません。

• getTtl

  @DeprecatedSE(since="3.2") public DurationSE getTtl()

  使用すべきではありません。

  3.2 以来。代わりに getTtlFunction() を使用してください。

  entryTtl(TtlFunction) を使用して RedisCacheWriter.TtlFunction が構成されている場合は、キャッシュエントリのキー / 値に基づいて計算された TTL expiration timeoutSE を返します。

  それ以外の場合、キャッシュ構成中に entryTtl(Duration) が呼び出された場合は、ユーザー指定の固定 DurationSE を返します。

  戻り値:

  構成された TTL expirationSE

• getTtlFunction

  public RedisCacheWriter.TtlFunction getTtlFunction()

  キャッシュキーの有効期限 (TTL) の有効期限を計算するために使用される RedisCacheWriter.TtlFunction を取得します。

  戻り値:

  RedisCacheWriter.TtlFunction はキャッシュエントリの有効期限 (TTL) を計算するために使用されます。決して null ではありません。

• addCacheKeyConverter

  public void addCacheKeyConverter(Converter<?,StringSE> cacheKeyConverter)

  適切な Object.toString() メソッドが存在しない場合に、キャッシュキーの StringSE 表現を抽出するための Converter を追加します。

  パラメーター:

  cacheKeyConverter - Converter は、キャッシュキーを StringSE に変換するために使用されます。

  例外:

  IllegalStateExceptionSE - getConversionService() が Converter 登録を許可しない場合。

  導入:

  2.2

  関連事項:

  • Converter

• configureKeyConverters

  public void configureKeyConverters(ConsumerSE<ConverterRegistry> registryConsumer)

  キャッシュキーの抽出に使用される基礎となる ConversionService を構成します。

  パラメーター:

  registryConsumer - ConsumerSE は、構成された ConverterRegistry に Converter を登録するために使用されます。決して null ではありません。

  例外:

  IllegalStateExceptionSE - getConversionService() が Converter 登録を許可しない場合。

  導入:

  2.2

  関連事項:

  • ConverterRegistry

• registerDefaultConverters

  public static void registerDefaultConverters(ConverterRegistry registry)

  デフォルトのキャッシュ key converters を登録します。

  次のコンバーターが登録されます。

  • UTF-8 エンコーディングを使用した StringSE から byte byte[]。
  • SimpleKey から StringSE

  パラメーター:

  registry - key converters が登録されている ConverterRegistry。null であってはなりません。

  関連事項:

  • ConverterRegistry