インターフェース Cache

メソッドの詳細

• getName

  StringSE getName()

  キャッシュ名を返します。

• getNativeCache

  ObjectSE getNativeCache()

  基になるネイティブキャッシュプロバイダーを返します。

• get

  @Nullable Cache.ValueWrapper get(ObjectSE key)

  このキャッシュが指定されたキーをマップする値を返します。

  キャッシュにこのキーのマッピングが含まれていない場合は、null を返します。そうでない場合、キャッシュされた値（null 自体である可能性があります）が Cache.ValueWrapper で返されます。

  パラメーター:

  key - 関連する値が返されるキー

  戻り値:

  このキャッシュが指定されたキーをマップする値。Cache.ValueWrapper 内に含まれ、キャッシュされた null 値も保持する場合があります。返されるストレート null は、キャッシュにこのキーのマッピングが含まれていないことを意味します。

  関連事項:

  • get(Object, Class)
  • get(Object, Callable)

• get

  @Nullable <T> T get(ObjectSE key, @Nullable ClassSE<T> type)

  このキャッシュが指定されたキーをマップする値を返します。一般的に、戻り値がキャストされる型を指定します。

  メモ: この get のバリアントでは、キャッシュされた null 値とキャッシュエントリがまったく見つからないことを区別できません。代わりに、その目的のために標準の get(Object) バリアントを使用してください。

  パラメーター:

  key - 関連する値が返されるキー

  type - 戻り値の必要な型 (型チェックをバイパスする null の場合があります。キャッシュで null 値が見つかった場合、指定された型は無関係です)

  戻り値:

  このキャッシュが指定されたキー（null 自体である場合があります）をマップする値、またはキャッシュにこのキーのマッピングが含まれていない場合は null 

  例外:

  IllegalStateExceptionSE - キャッシュエントリが見つかったが、指定された型と一致しなかった場合

  導入:

  4.0

  関連事項:

  • get(Object)

• get

  @Nullable <T> T get(ObjectSE key, CallableSE<T> valueLoader)

  このキャッシュが指定されたキーをマップする値を返し、必要に応じて valueLoader からその値を取得します。このメソッドは、従来の「キャッシュされている場合は返す、そうでない場合は作成、キャッシュして返す」パターンの単純な代替を提供します。

  可能な場合、実装は、同じキーへの同時アクセスの場合に指定された valueLoader が 1 回だけ呼び出されるように、ロード操作が同期されることを確認する必要があります。

  valueLoader が例外をスローした場合、Cache.ValueRetrievalException にラップされます

  パラメーター:

  key - 関連する値が返されるキー

  戻り値:

  このキャッシュが指定されたキーをマップする値

  例外:

  Cache.ValueRetrievalException - valueLoader が例外をスローした場合

  導入:

  4.3

  関連事項:

  • get(Object)

• retrieve

  @Nullable default CompletableFutureSE<?> retrieve(ObjectSE key)

  このキャッシュが指定されたキーをマップする値を CompletableFutureSE でラップして返します。この操作はブロックしてはなりませんが、対応する値がすぐに使用できる場合は、完了した CompletableFutureSE を返すことができます。

  キャッシュにこのキーのマッピングが含まれていないことがすぐに判断できる場合 (たとえば、メモリ内のキーマップを通じて)、null を返すことができます。それ以外の場合、キャッシュされた値は CompletableFutureSE に返され、null は後から判断されたキャッシュミスを示します。ネストされた Cache.ValueWrapper は、null 許容のキャッシュされた値を示す可能性があります。null 値がサポートされていない場合は、キャッシュされた値がプレーン要素として表されることもあります。呼び出しコードは、このメソッドによって返される結果のすべてのバリアントを処理できるように準備する必要があります。

  パラメーター:

  key - 関連する値が返されるキー

  戻り値:

  このキャッシュが指定されたキーをマップする値。CompletableFutureSE 内に含まれます。キャッシュミスが後で決定された場合は空になる可能性もあります。ストレートな null が返された場合は、キャッシュがこのキーのマッピングが含まれていないと即座に判断されたことを意味します。CompletableFuture 内に含まれる Cache.ValueWrapper は、潜在的に null であるキャッシュされた値を示します。これは、通常の CompletableFuture に含まれる null がキャッシュミスを示す、後で決定されるシナリオでは賢明です。ただし、キャッシュが null 値の実際のキャッシュをサポートしていない場合は、余分なレベルの値の折り返しを回避してプレーン値を返すこともあります。Spring のキャッシュ処理は、こうしたすべての実装戦略に対応できます。

  導入:

  6.1

  関連事項:

  • retrieve(Object, Supplier)

• retrieve

  default <T> CompletableFutureSE<T> retrieve(ObjectSE key, SupplierSE<CompletableFutureSE<T>> valueLoader)

  このキャッシュが指定されたキーをマップする値を返し、必要に応じて valueLoader からその値を取得します。このメソッドは、CompletableFutureSE に基づいた、従来の「キャッシュされている場合は返す、そうでない場合は作成、キャッシュして返す」パターンの単純な代替手段を提供します。この操作はブロックしないでください。

  可能な場合、実装は、同じキーへの同時アクセスの場合に指定された valueLoader が 1 回だけ呼び出されるように、ロード操作が同期されることを確認する必要があります。

  このメソッドでは、NULL 値は常にユーザーレベルの null 値を示します。提供された CompletableFutureSE ハンドルは値を生成するか、例外を生成します。valueLoader が例外を発生させた場合、その例外は返された CompletableFuture ハンドルに伝播されます。

  パラメーター:

  key - 関連する値が返されるキー

  戻り値:

  このキャッシュが指定されたキーをマップする値。CompletableFutureSE 内に含まれますが、null になることはありません。提供された Future は、値を生成するか、例外を発生させることが期待されます。

  導入:

  6.1

  関連事項:

  • retrieve(Object)
  • get(Object, Callable)

• put

  void put(ObjectSE key, @Nullable ObjectSE value)

  指定された値をこのキャッシュ内の指定されたキーに関連付けます。

  キャッシュに以前にこのキーのマッピングが含まれていた場合、古い値は指定された値に置き換えられます。

  実際の登録は非同期方式または遅延方式で実行できますが、その後の検索ではエントリがまだ表示されていない可能性があります。これは、たとえばトランザクションキャッシュデコレータの場合です。putIfAbsent(java.lang.Object, java.lang.Object) を使用して、即時登録を保証します。

  キャッシュが CompletableFutureSE およびリアクティブインタラクションと互換性があると想定されている場合、put 操作は事実上ノンブロッキングであり、バックエンドのライトスルーは非同期で発生する必要があります。これは、retrieve(Object) および retrieve(Object, Supplier) をサポートするように実装および構成されたキャッシュとともに行われます。

  パラメーター:

  key - 指定された値が関連付けられるキー

  value - 指定されたキーに関連付けられる値

  関連事項:

  • putIfAbsent(Object, Object)

• putIfAbsent

  @Nullable default Cache.ValueWrapper putIfAbsent(ObjectSE key, @Nullable ObjectSE value)

  指定された値が設定されていない場合、指定された値をこのキャッシュ内の指定されたキーと原子的に関連付けます。

  これは次と同等です:

  
   ValueWrapper existingValue = cache.get(key);
   if (existingValue == null) {
       cache.put(key, value);
   }
   return existingValue;
   

  ただし、アクションはアトミックに実行されます。すべてのすぐに使用できる CacheManager 実装は put をアトミックに実行できますが、操作は、たとえば、存在の確認とそれに続く put という非アトミックな方法で 2 つのステップで実装することもできます。詳細については、使用しているネイティブキャッシュ実装のドキュメントを確認してください。

  デフォルトの実装は、上記のコードスニペットの行に沿って get(Object) および put(Object, Object) に委譲します。

  パラメーター:

  key - 指定された値が関連付けられるキー

  value - 指定されたキーに関連付けられる値

  戻り値:

  このキャッシュが指定されたキー（null 自体の場合もある）をマップする値、またはこの呼び出しの前にキャッシュにそのキーのマッピングが含まれていなかった場合は null したがって、null を返すことは、指定された value がキーに関連付けられていることを示すインジケーターです。

  導入:

  4.1

  関連事項:

  • put(Object, Object)

• evict

  void evict(ObjectSE key)

  このキーが存在する場合、このキャッシュからこのキーのマッピングを削除します。

  実際のエビクションは非同期方式または遅延方式で実行できますが、その後のルックアップではおそらくエントリが引き続き表示されます。これは、たとえばトランザクションキャッシュデコレータの場合です。evictIfPresent(java.lang.Object) を使用して、即時の削除を保証します。

  キャッシュが CompletableFutureSE およびリアクティブインタラクションと互換性があると想定されている場合、エビクト操作は事実上ノンブロッキングであり、バックエンドのライトスルーは非同期で発生する必要があります。これは、retrieve(Object) および retrieve(Object, Supplier) をサポートするように実装および構成されたキャッシュとともに行われます。

  パラメーター:

  key - マッピングがキャッシュから削除されるキー

  関連事項:

  • evictIfPresent(Object)

• evictIfPresent

  default boolean evictIfPresent(ObjectSE key)

  このキーが存在する場合は、このキーのマッピングを削除し、以降の検索ではキーがすぐに見えないことを期待します。

  デフォルトの実装は evict(Object) に委譲し、キーの事前存在が未確定の場合は false を返します。キャッシュプロバイダー、特にキャッシュデコレータは、可能であれば即時の削除を実行し (たとえば、トランザクション内で一般的に遅延されるキャッシュ操作の場合)、指定されたキーの事前存在を確実に判定することが推奨されます。

  パラメーター:

  key - マッピングがキャッシュから削除されるキー

  戻り値:

  キャッシュに以前にこのキーのマッピングがあることがわかっていた場合は true、ない場合は false (または事前の存在を判断できなかった場合)

  導入:

  5.2

  関連事項:

  • evict(Object)

• clear

  void clear()

  すべてのマッピングを削除してキャッシュをクリアします。

  実際の消去は、非同期または遅延方式で実行され、その後のルックアップでエントリが引き続き表示される可能性があります。これは、たとえばトランザクションキャッシュデコレータの場合です。invalidate() を使用して、エントリの即時削除を保証します。

  キャッシュが CompletableFutureSE およびリアクティブインタラクションと互換性があると想定されている場合、クリア操作は事実上ノンブロッキングであり、バックエンドのライトスルーは非同期で発生する必要があります。これは、retrieve(Object) および retrieve(Object, Supplier) をサポートするように実装および構成されたキャッシュとともに行われます。

  関連事項:

  • invalidate()

• invalidate

  default boolean invalidate()

  すべてのマッピングを削除してキャッシュを無効にし、以降のルックアップではすべてのエントリがすぐに表示されないようにします。

  戻り値:

  キャッシュにマッピングがあることがわかっている場合は true、マッピングがない場合は false (または、エントリの事前の存在を判別できなかった場合)

  導入:

  5.2

  関連事項:

  • clear()