クラス NoOpCache
- 実装されたすべてのインターフェース:
Cache
Cache
実装。実際に格納するのではなく、キャッシュにアイテムを受け入れるだけです。
- 導入:
- 4.3.4
- 作成者:
- Costin Leau, Stephane Nicoll
- 関連事項:
ネストされたクラスのサマリー
インターフェース org.springframework.cache.Cache から継承されたネストクラス / インターフェース
Cache.ValueRetrievalException, Cache.ValueWrapper
コンストラクターのサマリー
方法の概要
修飾子と型メソッド説明void
clear()
すべてのマッピングを削除してキャッシュをクリアします。void
このキーが存在する場合、このキャッシュからこのキーのマッピングを削除します。boolean
evictIfPresent
(ObjectSE key) このキーが存在する場合は、このキーのマッピングを削除し、以降の検索ではキーがすぐに見えないことを期待します。このキャッシュが指定されたキーをマップする値を返します。<T> T
このキャッシュが指定されたキーをマップする値を返します。一般的に、戻り値がキャストされる型を指定します。<T> T
get
(ObjectSE key, CallableSE<T> valueLoader) このキャッシュが指定されたキーをマップする値を返し、必要に応じてvalueLoader
からその値を取得します。getName()
キャッシュ名を返します。基になるネイティブキャッシュプロバイダーを返します。boolean
すべてのマッピングを削除してキャッシュを無効にし、以降のルックアップではすべてのエントリがすぐに表示されないようにします。void
指定された値をこのキャッシュ内の指定されたキーに関連付けます。putIfAbsent
(ObjectSE key, ObjectSE value) 指定された値が設定されていない場合、指定された値をこのキャッシュ内の指定されたキーと原子的に関連付けます。このキャッシュが指定されたキーをマップする値をCompletableFuture
SE でラップして返します。<T> CompletableFutureSE<T>
retrieve
(ObjectSE key, SupplierSE<CompletableFutureSE<T>> valueLoader) このキャッシュが指定されたキーをマップする値を返し、必要に応じてvalueLoader
からその値を取得します。
コンストラクターの詳細
NoOpCache
指定された名前でNoOpCache
インスタンスを作成します。- パラメーター:
name
- キャッシュの名前
メソッドの詳細
getName
インターフェースからコピーされた説明:Cache
キャッシュ名を返します。getNativeCache
インターフェースからコピーされた説明:Cache
基になるネイティブキャッシュプロバイダーを返します。- 次で指定:
- インターフェース
Cache
のgetNativeCache
get
インターフェースからコピーされた説明:Cache
このキャッシュが指定されたキーをマップする値を返します。キャッシュにこのキーのマッピングが含まれていない場合は、
null
を返します。そうでない場合、キャッシュされた値(null
自体である可能性があります)がCache.ValueWrapper
で返されます。- 次で指定:
- インターフェース
Cache
のget
- パラメーター:
key
- 関連する値が返されるキー- 戻り値:
- このキャッシュが指定されたキーをマップする値。
Cache.ValueWrapper
内に含まれ、キャッシュされたnull
値も保持する場合があります。返されるストレートnull
は、キャッシュにこのキーのマッピングが含まれていないことを意味します。 - 関連事項:
get
インターフェースからコピーされた説明:Cache
このキャッシュが指定されたキーをマップする値を返します。一般的に、戻り値がキャストされる型を指定します。メモ: この
get
のバリアントでは、キャッシュされたnull
値とキャッシュエントリがまったく見つからないことを区別できません。代わりに、その目的のために標準のCache.get(Object)
バリアントを使用してください。get
インターフェースからコピーされた説明:Cache
このキャッシュが指定されたキーをマップする値を返し、必要に応じてvalueLoader
からその値を取得します。このメソッドは、従来の「キャッシュされている場合は返す、そうでない場合は作成、キャッシュして返す」パターンの単純な代替を提供します。可能な場合、実装は、同じキーへの同時アクセスの場合に指定された
valueLoader
が 1 回だけ呼び出されるように、ロード操作が同期されることを確認する必要があります。valueLoader
が例外をスローした場合、Cache.ValueRetrievalException
にラップされますretrieve
インターフェースからコピーされた説明:Cache
このキャッシュが指定されたキーをマップする値をCompletableFuture
SE でラップして返します。この操作はブロックしてはなりませんが、対応する値がすぐに使用できる場合は、完了したCompletableFuture
SE を返すことができます。キャッシュにこのキーのマッピングが含まれていないことがすぐに判断できる場合 (たとえば、メモリ内のキーマップを通じて)、
null
を返すことができます。それ以外の場合、キャッシュされた値はCompletableFuture
SE に返され、null
は後から判断されたキャッシュミスを示します。ネストされたCache.ValueWrapper
は、null 許容のキャッシュされた値を示す可能性があります。null 値がサポートされていない場合は、キャッシュされた値がプレーン要素として表されることもあります。呼び出しコードは、このメソッドによって返される結果のすべてのバリアントを処理できるように準備する必要があります。- 次で指定:
- インターフェース
Cache
のretrieve
- パラメーター:
key
- 関連する値が返されるキー- 戻り値:
- このキャッシュが指定されたキーをマップする値。
CompletableFuture
SE 内に含まれます。キャッシュミスが後で決定された場合は空になる可能性もあります。ストレートなnull
が返された場合は、キャッシュがこのキーのマッピングが含まれていないと即座に判断されたことを意味します。CompletableFuture
内に含まれるCache.ValueWrapper
は、潜在的にnull
であるキャッシュされた値を示します。これは、通常の CompletableFuture に含まれるnull
がキャッシュミスを示す、後で決定されるシナリオでは賢明です。ただし、キャッシュがnull
値の実際のキャッシュをサポートしていない場合は、余分なレベルの値の折り返しを回避してプレーン値を返すこともあります。Spring のキャッシュ処理は、こうしたすべての実装戦略に対応できます。 - 関連事項:
retrieve
public <T> CompletableFutureSE<T> retrieve(ObjectSE key, SupplierSE<CompletableFutureSE<T>> valueLoader) インターフェースからコピーされた説明:Cache
このキャッシュが指定されたキーをマップする値を返し、必要に応じてvalueLoader
からその値を取得します。このメソッドは、CompletableFuture
SE に基づいた、従来の「キャッシュされている場合は返す、そうでない場合は作成、キャッシュして返す」パターンの単純な代替手段を提供します。この操作はブロックしないでください。可能な場合、実装は、同じキーへの同時アクセスの場合に指定された
valueLoader
が 1 回だけ呼び出されるように、ロード操作が同期されることを確認する必要があります。このメソッドでは、NULL 値は常にユーザーレベルの
null
値を示します。提供されたCompletableFuture
SE ハンドルは値を生成するか、例外を生成します。valueLoader
が例外を発生させた場合、その例外は返されたCompletableFuture
ハンドルに伝播されます。- 次で指定:
- インターフェース
Cache
のretrieve
- パラメーター:
key
- 関連する値が返されるキー- 戻り値:
- このキャッシュが指定されたキーをマップする値。
CompletableFuture
SE 内に含まれますが、null
になることはありません。提供された Future は、値を生成するか、例外を発生させることが期待されます。 - 関連事項:
put
インターフェースからコピーされた説明:Cache
指定された値をこのキャッシュ内の指定されたキーに関連付けます。キャッシュに以前にこのキーのマッピングが含まれていた場合、古い値は指定された値に置き換えられます。
実際の登録は非同期方式または遅延方式で実行できますが、その後の検索ではエントリがまだ表示されていない可能性があります。これは、たとえばトランザクションキャッシュデコレータの場合です。
Cache.putIfAbsent(java.lang.Object, java.lang.Object)
を使用して、即時登録を保証します。キャッシュが
CompletableFuture
SE およびリアクティブインタラクションと互換性があると想定されている場合、put 操作は事実上ノンブロッキングであり、バックエンドのライトスルーは非同期で発生する必要があります。これは、Cache.retrieve(Object)
およびCache.retrieve(Object, Supplier)
をサポートするように実装および構成されたキャッシュとともに行われます。putIfAbsent
インターフェースからコピーされた説明:Cache
指定された値が設定されていない場合、指定された値をこのキャッシュ内の指定されたキーと原子的に関連付けます。これは次と同等です:
ただし、アクションはアトミックに実行されます。すべてのすぐに使用できるValueWrapper existingValue = cache.get(key); if (existingValue == null) { cache.put(key, value); } return existingValue;
CacheManager
実装は put をアトミックに実行できますが、操作は、たとえば、存在の確認とそれに続く put という非アトミックな方法で 2 つのステップで実装することもできます。詳細については、使用しているネイティブキャッシュ実装のドキュメントを確認してください。デフォルトの実装は、上記のコードスニペットの行に沿って
Cache.get(Object)
およびCache.put(Object, Object)
に委譲します。- 次で指定:
- インターフェース
Cache
のputIfAbsent
- パラメーター:
key
- 指定された値が関連付けられるキーvalue
- 指定されたキーに関連付けられる値- 戻り値:
- このキャッシュが指定されたキー(
null
自体の場合もある)をマップする値、またはこの呼び出しの前にキャッシュにそのキーのマッピングが含まれていなかった場合はnull
したがって、null
を返すことは、指定されたvalue
がキーに関連付けられていることを示すインジケーターです。 - 関連事項:
evict
インターフェースからコピーされた説明:Cache
このキーが存在する場合、このキャッシュからこのキーのマッピングを削除します。実際のエビクションは非同期方式または遅延方式で実行できますが、その後のルックアップではおそらくエントリが引き続き表示されます。これは、たとえばトランザクションキャッシュデコレータの場合です。
Cache.evictIfPresent(java.lang.Object)
を使用して、即時の削除を保証します。キャッシュが
CompletableFuture
SE およびリアクティブインタラクションと互換性があると想定されている場合、エビクト操作は事実上ノンブロッキングであり、バックエンドのライトスルーは非同期で発生する必要があります。これは、Cache.retrieve(Object)
およびCache.retrieve(Object, Supplier)
をサポートするように実装および構成されたキャッシュとともに行われます。evictIfPresent
インターフェースからコピーされた説明:Cache
このキーが存在する場合は、このキーのマッピングを削除し、以降の検索ではキーがすぐに見えないことを期待します。デフォルトの実装は
Cache.evict(Object)
に委譲し、キーの事前存在が未確定の場合はfalse
を返します。キャッシュプロバイダー、特にキャッシュデコレータは、可能であれば即時の削除を実行し (たとえば、トランザクション内で一般的に遅延されるキャッシュ操作の場合)、指定されたキーの事前存在を確実に判定することが推奨されます。- 次で指定:
- インターフェース
Cache
のevictIfPresent
- パラメーター:
key
- マッピングがキャッシュから削除されるキー- 戻り値:
- キャッシュに以前にこのキーのマッピングがあることがわかっていた場合は
true
、ない場合はfalse
(または事前の存在を判断できなかった場合) - 関連事項:
clear
public void clear()インターフェースからコピーされた説明:Cache
すべてのマッピングを削除してキャッシュをクリアします。実際の消去は、非同期または遅延方式で実行され、その後のルックアップでエントリが引き続き表示される可能性があります。これは、たとえばトランザクションキャッシュデコレータの場合です。
Cache.invalidate()
を使用して、エントリの即時削除を保証します。キャッシュが
CompletableFuture
SE およびリアクティブインタラクションと互換性があると想定されている場合、クリア操作は事実上ノンブロッキングであり、バックエンドのライトスルーは非同期で発生する必要があります。これは、Cache.retrieve(Object)
およびCache.retrieve(Object, Supplier)
をサポートするように実装および構成されたキャッシュとともに行われます。invalidate
public boolean invalidate()インターフェースからコピーされた説明:Cache
すべてのマッピングを削除してキャッシュを無効にし、以降のルックアップではすべてのエントリがすぐに表示されないようにします。- 次で指定:
- インターフェース
Cache
のinvalidate
- 戻り値:
- キャッシュにマッピングがあることがわかっている場合は
true
、マッピングがない場合はfalse
(または、エントリの事前の存在を判別できなかった場合) - 関連事項: