https://github.com/spring-projects/spring-data-examples/ (英語) にある専用の Spring Data サンプルリポジトリで、キー値ストアのさまざまなサンプルを見つけることができます。詳細については、ドキュメント、次のブログエントリ (英語) を参照してください。

Spring Boot は、Spring Data モジュールの最新バージョンを選択します。それでも新しいバージョンにアップグレードする場合は、spring-data-bom.version プロパティを、使用するトレーニングバージョンとイテレーションに設定します。

詳細については、Spring Boot のドキュメント ( "Spring Data Bom" で検索) を参照してください。

Spring Data モジュールの現在のバージョンには、Spring Framework 6.0.13 以降が必要です。モジュールは、そのマイナーバージョンの古いバグ修正バージョンでも動作する可能性があります。ただし、その世代内の最新バージョンを使用することを強くお勧めします。

リファレンスドキュメントのこのパートでは、Spring Data Redis が提供するコア機能について説明しています。Key-Value モジュールの概念とセマンティクス、およびさまざまなストア名前空間の構文について説明します。Key-Value ストア、Spring、Spring Data の例の概要については、NoSQL と KeyValue ストアの学習を参照してください。このドキュメントは、Spring Data Redis サポートのみに言及しており、ユーザーが Key-Value ストレージと Spring の概念に精通していることを前提としています。

"Redis サポート" では、Redis モジュールの機能セットを紹介しています。

"Redis リポジトリ" では、Redis のリポジトリサポートが導入されています。

このドキュメントは、Spring Data Redis（SDR）サポートのリファレンスガイドです。

アプリケーションのアップグレードを決定したら、ドキュメントの残りの部分で特定の機能に関する詳細情報を見つけることができます。このドキュメントの最後に、メジャーバージョンの移行に固有の移行ガイドがあります。

Spring Data のドキュメントはバージョン固有であり、そこに記載されている情報は、そのバージョンの最新の変更点を含んでいます。

作業環境をセットアップする簡単な方法は、Pleiades All in One (JDK, STS, Lombok 付属) 、STS (英語) で Spring ベースのプロジェクトを作成することです。

まず、実行中の Redis サーバーをセットアップする必要があります。

STS で Spring プロジェクトを作成するには:

リポジトリも参照できます (英語) 。

Spring Redis には Redis 2.6 以上が必要であり、Spring Data Redis は、Redis 用の 2 つの一般的なオープンソース Java ライブラリである Lettuce [GitHub] (英語) および Jedis [GitHub] (英語) と統合されます。

Redis サポートは、いくつかのコンポーネントを提供します。ほとんどのタスクでは、高レベルの抽象化とサポートサービスが最良の選択です。いつでも、レイヤー間を移動できることに注意してください。例: Redis と直接通信するために、低レベルの接続（またはネイティブライブラリ）を取得できます。

Redis および Spring を使用する場合の最初のタスクの 1 つは、IoC コンテナーを介してストアに接続することです。これを行うには、Java コネクター（またはバインディング）が必要です。選択したライブラリに関係なく、Spring Data Redis API の 1 つのセット（すべてのコネクターで一貫して動作する）のみを使用する必要があります。org.springframework.data.redis.connection パッケージと、Redis へのアクティブな接続を操作および取得するための RedisConnection および RedisConnectionFactory インターフェースです。

次の例に示すように、高可用性 Redis を処理するために、Spring Data Redis は RedisSentinelConfiguration を使用して Redis Sentinel (英語) をサポートしています。

場合によっては、センチネルの 1 つと直接対話する必要があります。RedisConnectionFactory.getSentinelConnection() または RedisConnection.getSentinelCommands() を使用すると、最初に構成されたアクティブな Sentinel にアクセスできます。

ほとんどのユーザーは、RedisTemplate とそれに対応するパッケージ org.springframework.data.redis.core を使用する可能性があります。テンプレートは、その豊富な機能セットにより、実際、Redis モジュールの中心的なクラスです。テンプレートは、Redis インタラクションの高レベルの抽象化を提供します。RedisConnection は、バイナリ値（byte 配列）を受け入れて返す低レベルのメソッドを提供しますが、テンプレートは直列化と接続管理を処理し、ユーザーがそのような詳細を処理する必要がなくなります。

さらに、テンプレートは、次の表で説明するように、特定の型または特定のキー（KeyBound インターフェースを介して）に対して作業するための豊富な汎用インターフェースを提供する操作ビュー（Redis コマンドリファレンス (英語) からのグループ化に続く）を提供します。

構成が完了すると、テンプレートはスレッドセーフになり、複数のインスタンスで再利用できます。

RedisTemplate は、ほとんどの操作に Java ベースのシリアライザーを使用します。これは、テンプレートによって書き込まれた、または読み取られたオブジェクトはすべて、Java を介して直列化および逆直列化されることを意味します。テンプレートの直列化メカニズムを変更できます。Redis モジュールは、org.springframework.data.redis.serializer パッケージで利用可能ないくつかの実装を提供します。詳細については、シリアライザーを参照してください。enableDefaultSerializer プロパティを false に設定することにより、任意のシリアライザーを null に設定し、生のバイト配列で RedisTemplate を使用することもできます。テンプレートでは、すべてのキーが null 以外である必要があることに注意してください。ただし、基礎となるシリアライザーが値を受け入れる限り、値は null にすることができます。詳細については、各シリアライザーの Javadoc を参照してください。

特定のテンプレートビューが必要な場合は、ビューを依存関係として宣言し、テンプレートを挿入します。次の例に示すように、コンテナーは自動的に変換を実行し、opsFor[X] 呼び出しを排除します。

Redis に格納されているキーと値が java.lang.String であることが非常に一般的であるため、Redis モジュールは、RedisConnection と RedisTemplate に、それぞれ StringRedisConnection （およびその DefaultStringRedisConnection 実装）と StringRedisTemplate の 2 つの拡張機能を提供し、集中的な文字列操作の便利なワンストップソリューションとして提供します。テンプレートと接続は、String キーにバインドされるだけでなく、下にある StringRedisSerializer を使用します。つまり、保存されているキーと値は人間が読める形式です（Redis とコードの両方で同じエンコーディングが使用されていると仮定します）。次のリストは例を示しています。

他の Spring テンプレートと同様に、RedisTemplate および StringRedisTemplate を使用すると、RedisCallback インターフェースを介して Redis と直接通信できます。この機能は、RedisConnection と直接通信するため、完全に制御できます。StringRedisTemplate が使用されている場合、コールバックは StringRedisConnection のインスタンスを受け取ることに注意してください。次の例は、RedisCallback インターフェースの使用方法を示しています。

フレームワークの観点から、Redis に格納されるデータはバイトのみです。Redis 自体はさまざまな型をサポートしていますが、ほとんどの場合、これらはデータが表すものではなく、データの格納方法を指します。情報を文字列に変換するか、その他のオブジェクトに変換するかは、ユーザーが決定します。

Spring Data では、ユーザー（カスタム）型と生データ（およびその逆）の間の変換は、org.springframework.data.redis.serializer パッケージの Redis で処理されます。

このパッケージには、名前が示すように、直列化プロセスを処理する 2 種類のシリアライザーが含まれています。

これらのバリアントの主な違いは、RedisSerializer は主に byte[] に直列化されるのに対し、リーダーとライターは ByteBuffer を使用することです。

複数の実装が利用可能です（このドキュメントですでにメンションされている 2 つを含む）:

ただし、Spring OXM サポートを介したオブジェクト / XML マッピングに OxmSerializer を使用することも、JSON [Wikipedia] (英語) 形式でデータを格納するために Jackson2JsonRedisSerializer または GenericJackson2JsonRedisSerializer を使用することもできます。

ストレージ形式は値だけに限定されないことに注意してください。キー、値、またはハッシュに制限なく使用できます。

データは、Redis 内のさまざまなデータ構造を使用して保存できます。Jackson2JsonRedisSerializer は、オブジェクトを JSON [Wikipedia] (英語) 形式に変換できます。理想的には、JSON はプレーンキーを使用して値として保存できます。Redis ハッシュを使用すると、構造化オブジェクトのより高度なマッピングを実現できます。Spring Data Redis は、データをハッシュにマッピングするためのさまざまな戦略を提供します（ユースケースによって異なります）。

Spring Data は、Spring Framework の JMS 統合と機能および命名が類似した、Redis 専用のメッセージング統合を提供します。

Redis メッセージングは、機能の 2 つの領域に大きく分けることができます。

これは、パブリッシュ / サブスクライブ（略して Pub/ サブ）と呼ばれることが多いパターンの例です。RedisTemplate クラスは、メッセージの生成に使用されます。Java EE のメッセージ駆動型 Bean スタイルと同様の非同期受信の場合、Spring Data は、メッセージ駆動型 POJO（MDP）の作成に使用される専用のメッセージリスナーコンテナーを提供し、同期受信の場合は RedisConnection 契約を提供します。

org.springframework.data.redis.connection および org.springframework.data.redis.listener パッケージは、Redis メッセージングのコア機能を提供します。

Redis Streams は、抽象的なアプローチでログデータ構造をモデル化します。通常、ログは追加専用のデータ構造であり、最初から、ランダムな位置で、新しいメッセージをストリーミングすることによって消費されます。

Redis ストリームは、大きく 2 つの機能領域に分けることができます。

このパターンは Pub/Sub と類似していますが、主な違いはメッセージの永続性とメッセージの消費メソッドにあります。

Pub/Sub は一時的なメッセージのブロードキャストに依存していますが（つまり、聞いていない場合はメッセージを見逃します）、Redis ストリームは、ストリームがトリミングされるまでメッセージを保持する永続的な追加専用データ型を使用します。消費のもう 1 つの違いは、Pub/Sub がサーバー側のサブスクリプションを登録することです。Redis は到着メッセージをクライアントにプッシュしますが、Redis ストリームはアクティブなポーリングを必要とします。

org.springframework.data.redis.connection および org.springframework.data.redis.stream パッケージは、Redis ストリームのコア機能を提供します。

Redis は、multi、exec、discard コマンドを介したトランザクション (英語) のサポートを提供します。これらの操作は RedisTemplate で利用できます。ただし、RedisTemplate は、トランザクション内のすべての操作を同じ接続で実行することが保証されているわけではありません。

Spring Data Redis は、Redis トランザクションを使用する場合など、同じ connection で複数の操作を実行する必要がある場合に使用する SessionCallback インターフェースを提供します。次の例では、multi メソッドを使用しています。

RedisTemplate は、その値、ハッシュキー、ハッシュ値シリアライザーを使用して、exec のすべての結果を逆直列化してから返します。トランザクション結果のカスタムシリアライザーを渡すことができる追加の exec メソッドがあります。

Redis は、パイプライン化 (英語) のサポートを提供します。これには、応答を待たずにサーバーに複数のコマンドを送信し、単一のステップで応答を読み取ることが含まれます。パイプライン処理は、同じリストに多くの要素を追加するなど、複数のコマンドを連続して送信する必要がある場合にパフォーマンスを向上させることができます。

Spring Data Redis は、パイプラインでコマンドを実行するためのいくつかの RedisTemplate メソッドを提供します。パイプライン操作の結果を気にしない場合は、標準の execute メソッドを使用して、pipeline 引数に true を渡すことができます。次の例に示すように、executePipelined メソッドは、提供された RedisCallback または SessionCallback をパイプラインで実行し、結果を返します。

前の例では、パイプラインのキューからアイテムの一括右ポップを実行します。results List には、ポップされたすべてのアイテムが含まれています。RedisTemplate は、値、ハッシュキー、ハッシュ値シリアライザーを使用して、返される前にすべての結果を逆直列化するため、前の例で返される項目は文字列です。パイプライン化された結果のカスタムシリアライザーを渡すことができる追加の executePipelined メソッドがあります。

パイプライン化されたコマンドの結果を返すためにこの値は破棄されるため、RedisCallback から返される値は null である必要があることに注意してください。

Redis バージョン 2.6 以降は、eval (英語) および evalsha (英語) コマンドを介した Lua スクリプトの実行をサポートします。Spring Data Redis は、直列化を処理し、Redis スクリプトキャッシュを自動的に使用するスクリプトを実行するための高レベルの抽象化を提供します。

スクリプトは、RedisTemplate および ReactiveRedisTemplate の execute メソッドを呼び出すことによって実行できます。どちらも、構成可能な ScriptExecutor （または ReactiveScriptExecutor）を使用して、提供されたスクリプトを実行します。デフォルトでは、ScriptExecutor （または ReactiveScriptExecutor）が、提供されたキーと引数の直列化とスクリプト結果の逆直列化を処理します。これは、テンプレートのキーと値のシリアライザーを介して行われます。スクリプト引数と結果のカスタムシリアライザーを渡すことができる追加のオーバーロードがあります。

デフォルトの ScriptExecutor は、スクリプトの SHA1 を取得し、最初に evalsha の実行を試み、スクリプトが Redis スクリプトキャッシュにまだ存在しない場合は eval にフォールバックすることにより、パフォーマンスを最適化します。

次の例では、Lua スクリプトを使用して、一般的な「チェックアンドセット」シナリオを実行します。これは、一連のコマンドをアトミックに実行する必要があり、あるコマンドの動作が別のコマンドの結果に影響されるため、Redis スクリプトの理想的な使用例です。

上記のコードは、ブール値を返すことが期待される checkandset.lua というファイルを指す RedisScript を構成します。スクリプト resultType は、Long、Boolean、List のいずれか、逆直列化された値の型である必要があります。スクリプトが使い捨てステータス（具体的には OK）を返す場合は、null にすることもできます。

次に、上記の checkAndSet メソッドがスクリプトを実行します。スクリプトは、トランザクションまたはパイプラインの一部として SessionCallback 内で実行できます。詳細については、"Redis トランザクション" および "パイプライン" を参照してください。

Spring Data によって提供されるスクリプトサポート Redis では、Spring タスクおよびスケジューラーの抽象化を使用して、Redis スクリプトを定期的に実行するようにスケジュールすることもできます。詳細については、Spring Framework のドキュメントを参照してください。

Spring Redis は、org.springframework.data.redis.cache パッケージを介した Spring キャッシュ抽象化の実装を提供します。Redis をバッキング実装として使用するには、次のように RedisCacheManager を構成に追加します。

RedisCacheManager の動作は RedisCacheManagerBuilder で構成でき、デフォルトの RedisCacheConfiguration、トランザクションの動作、事前定義されたキャッシュを設定できます。

前の例に示されているように、RedisCacheManager では、キャッシュごとに構成を定義できます。

RedisCacheManager で作成された RedisCache の動作は、RedisCacheConfiguration で定義されます。この構成では、次の例に示すように、バイナリストレージ形式との間で変換するためのキーの有効期限、プレフィックス、RedisSerializer 実装を設定できます。

RedisCacheManager は、バイナリ値の読み取りと書き込みのために、デフォルトでロックフリーの RedisCacheWriter になります。ロックフリーキャッシングはスループットを向上させます。エントリロックがない場合、putIfAbsent メソッドと clean メソッドの非アトミックコマンドが重複する可能性があります。これらのコマンドでは、Redis に複数のコマンドを送信する必要があるためです。対応するロックは、明示的なロックキーを設定し、このキーの存在をチェックすることでコマンドの重複を防ぎます。これにより、追加のリクエストと潜在的なコマンド待機時間が発生します。

ロックは、キャッシュエントリごとではなく、キャッシュレベルに適用されます。

次のようにロック動作にオプトインすることができます。

デフォルトでは、キャッシュエントリの key には、実際のキャッシュ名の前に 2 つのコロンが続きます。この動作は、静的プレフィックスと計算プレフィックスに変更できます。

次の例は、静的プレフィックスを設定する方法を示しています。

キャッシュの実装では、デフォルトで KEYS と DEL を使用してキャッシュをクリアします。KEYS は、大きなキースペースでパフォーマンスの課題を引き起こす可能性があります。デフォルトの RedisCacheWriter を BatchStrategy で作成して、SCAN ベースのバッチ戦略に切り替えることができます。SCAN 戦略では、過剰な Redis コマンドのラウンドトリップを回避するためにバッチサイズが必要です。

次の表に、RedisCacheManager のデフォルト設定を示します。

次の表に、RedisCacheConfiguration のデフォルト設定を示します。

Package org.springframework.data.redis.support offers various reusable components that rely on Redis as a backing store. Currently, the package contains various JDK-based interface implementations on top of Redis, such as atomic (標準 Javadoc) (英語) counters and JDK Collections (標準 Javadoc) (英語) .

The atomic counters make it easy to wrap Redis key incrementation while the collections allow easy management of Redis keys with minimal storage exposure or API leakage. In particular, the RedisSet and RedisZSet interfaces offer easy access to the set operations supported by Redis, such as intersection and union. RedisList implements the List, Queue, and Deque contracts (and their equivalent blocking siblings) on top of Redis, exposing the storage as a FIFO (First-In-First-Out), LIFO (Last-In-First-Out) or capped collection with minimal configuration. The following example shows the configuration for a bean that uses a RedisList:

The following example shows a Java configuration example for a Deque:

As shown in the preceding example, the consuming code is decoupled from the actual storage implementation. In fact, there is no indication that Redis is used underneath. This makes moving from development to production environments transparent and highly increases testability (the Redis implementation can be replaced with an in-memory one).

Getting insights from an application component about its operations, timing and relation to application code is crucial to understand latency. Spring Data Redis ships with a Micrometer integration through the Lettuce driver to collect observations during Redis interaction. Once the integration is set up, Micrometer will create meters and spans (for distributed tracing) for each Redis command.

To enable the integration, apply the following configuration to LettuceClientConfiguration:

Spring Data Redis は現在、唯一のリアクティブ Java コネクターとして Lettuce [GitHub] (英語) と統合されています。プロジェクト Reactor (英語) はリアクティブ組成ライブラリとして使用されます。

Redis および Spring を使用する場合の最初のタスクの 1 つは、IoC コンテナーを介してストアに接続することです。これを行うには、Java コネクター（またはバインディング）が必要です。選択したライブラリに関係なく、アクティブな connections から Redis を操作および取得するには、org.springframework.data.redis.connection パッケージとその ReactiveRedisConnection および ReactiveRedisConnectionFactory インターフェースを使用する必要があります。

ほとんどのユーザーは、ReactiveRedisTemplate とそれに対応するパッケージ org.springframework.data.redis.core を使用する可能性があります。その豊富な機能セットにより、テンプレートは実際、Redis モジュールの中心的なクラスです。テンプレートは、Redis インタラクションの高レベルの抽象化を提供します。ReactiveRedisConnection は、バイナリ値を受け入れて返す低レベルのメソッド（ByteBuffer）を提供しますが、テンプレートは直列化と接続管理を処理し、そのような詳細を処理する必要がありません。

さらに、テンプレートは、次の表に従って、特定の型に対して機能するための豊富で汎用化されたインターフェースを提供する操作ビュー（Redis コマンドリファレンス (英語) からのグループ化に続く）を提供します。

構成が完了すると、テンプレートはスレッドセーフになり、複数のインスタンスで再利用できます。

ReactiveRedisTemplate は、ほとんどの操作に Java ベースのシリアライザーを使用します。これは、テンプレートによって書き込まれた、または読み取られたオブジェクトが、RedisElementWriter または RedisElementReader を介して直列化または逆直列化されることを意味します。直列化コンテキストは構築時にテンプレートに渡され、Redis モジュールは org.springframework.data.redis.serializer パッケージで利用可能ないくつかの実装を提供します。詳細については、シリアライザーを参照してください。

次の例は、Mono を返すために使用されている ReactiveRedisTemplate を示しています。

Redis に格納されているキーと値が java.lang.String であることが非常に一般的であるため、Redis モジュールは ReactiveRedisTemplate の文字列ベースの拡張機能を提供します: ReactiveStringRedisTemplate。これは、集中的な String 操作に便利なワンストップソリューションです。テンプレートは、String キーにバインドされるだけでなく、文字列ベースの RedisSerializationContext を使用します。これは、格納されているキーと値が人間が読める形式であることを意味します（Redis とコードの両方で同じエンコーディングが使用されていると想定）。次の例は、使用中の ReactiveStringRedisTemplate を示しています。

Spring Data は、Redis 専用のメッセージング統合を提供します。これは、Spring フレームワークの JMS 統合と機能および命名が非常に似ています。実際、Spring での JMS サポートに精通しているユーザーは、自宅にいるように感じるはずです。

Redis メッセージングは、機能の 2 つの領域、つまりメッセージの生成または公開と消費またはサブスクリプションに大別できます。ショートカット pubsub（パブリッシュ / サブスクライブ）です。ReactiveRedisTemplate クラスは、メッセージの生成に使用されます。非同期受信の場合、Spring Data は、メッセージのストリームを消費するために使用される専用のメッセージリスナーコンテナーを提供します。ReactiveRedisTemplate をサブスクライブするだけの目的で、リスナーコンテナーを利用する代わりの方法を取り除いたものを提供します。

パッケージ org.springframework.data.redis.connection および org.springframework.data.redis.listener は、Redis メッセージングを使用するためのコア機能を提供します。

ReactiveRedisTemplate を介してアクセスするのに最適な ReactiveScriptExecutor を使用すると、リアクティブインフラストラクチャで Redis スクリプトを実行できます。

スクリプトコマンドの詳細については、スクリプトのセクションを参照してください。

クラスターのサポートは、クラスター化されていない通信と同じ構成要素に基づいています。RedisConnection の拡張である RedisClusterConnection は、Redis クラスターとの通信を処理し、エラーを Spring DAO 例外階層に変換します。RedisClusterConnection インスタンスは、次の例に示すように、RedisConnectionFactory を使用して作成されます。RedisConnectionFactory は、関連付けられた RedisClusterConfiguration を使用して設定する必要があります。

前述のように、Redis クラスターは、単一ノードの Redis や、Sentinel が監視するマスターレプリカ環境とは異なる動作をします。これは、自動シャーディングが、ノード全体に分散されている 16384 スロットの 1 つにキーをマップするためです。複数のキーを含むコマンドは、クロススロットエラーを回避するために、すべてのキーがまったく同じスロットにマップされていることを表明する必要があります。単一のクラスターノードは、専用のキーセットのみを提供します。1 つの特定のサーバーに対して発行されたコマンドは、そのサーバーによって提供されるキーに対してのみ結果を返します。簡単な例として、KEYS コマンドについて考えてみます。クラスター環境のサーバーに発行されると、リクエストが送信されたノードによって提供されるキーのみが返され、クラスター内のすべてのキーが返されるとは限りません。クラスター環境ですべてのキーを取得するには、すべての既知のマスターノードからキーを読み取る必要があります。

対応するスロットサービングノードへの特定のキーのリダイレクトはドライバーライブラリによって処理されますが、ノード間で情報を収集したり、クラスター内のすべてのノードにコマンドを送信したりするなどの高レベルの機能は、RedisClusterConnection でカバーされます。前のキーの例を取得すると、これは、keys(pattern) メソッドがクラスター内のすべてのマスターノードを取得し、同時にすべてのマスターノードで KEYS コマンドを実行しながら、結果を取得して累積されたキーのセットを返すことを意味します。単一ノードのキーをリクエストするだけで、RedisClusterConnection はそれらのメソッド（たとえば、keys(node, pattern)）にオーバーロードを提供します。

RedisClusterNode は、RedisClusterConnection.clusterGetNodes から取得することも、ホストとポートまたはノード ID を使用して構築することもできます。

次の例は、クラスター全体で実行されている一連のコマンドを示しています。

すべてのキーが同じスロットにマップされると、ネイティブドライバーライブラリは、MGET などのクロススロットリクエストを自動的に処理します。ただし、これが当てはまらない場合、RedisClusterConnection はスロットサービングノードに対して複数の並列 GET コマンドを実行し、累積された結果を再び返します。これはシングルスロットアプローチよりもパフォーマンスが低いため、注意して使用する必要があります。疑わしい場合は、同じスロット番号にマップされる {my-prefix}.thing1 や {my-prefix}.thing2 などのプレフィックスをカーリー括弧に指定して、キーを同じスロットに固定することを検討してください。次の例は、クロススロットリクエストの処理を示しています。

RedisTemplate の汎用、構成、使用箇所については、RedisTemplate を介したオブジェクトの操作セクションを参照してください。

RedisTemplate は、RedisTemplate.opsForCluster() から取得できる ClusterOperations インターフェースを介してクラスター固有の操作へのアクセスを提供します。これにより、テンプレート用に構成された直列化および逆直列化機能を保持しながら、クラスター内の単一ノードでコマンドを明示的に実行できます。また、管理コマンド（CLUSTER MEET など）またはより高レベルの操作（再シャーディングなど）も提供します。

次の例は、RedisTemplate を使用して RedisClusterConnection にアクセスする方法を示しています。

Spring Data Redis を使用すると、次の例に示すように、ドメインエンティティを簡単に実装できます。

ここには非常に単純なドメインオブジェクトがあります。型に @RedisHash アノテーションがあり、org.springframework.data.annotation.Id アノテーションが付けられた id という名前のプロパティがあることに注意してください。これらの 2 つの項目は、ハッシュを永続化するために使用される実際のキーを作成する責任があります。

ストレージと取得を担当するコンポーネントを実際に作成するには、次の例に示すように、リポジトリインターフェースを定義する必要があります。

リポジトリは CrudRepository を継承しているため、基本的な CRUD およびファインダー操作を提供します。次の例に示すように、物を接着するために間に必要なのは、対応する Spring 構成です。

上記の設定を前提として、次の例に示すように、PersonRepository をコンポーネントに注入できます。

このセクションでは、Spring Data オブジェクトマッピング、オブジェクト作成、フィールドとプロパティへのアクセス、可変性と不変性の基礎について説明します。このセクションは、基になるデータストア（JPA など）のオブジェクトマッピングを使用しない Spring Data モジュールにのみ適用されることに注意してください。また、インデックス、列名やフィールド名のカスタマイズなど、ストア固有のオブジェクトマッピングについては、ストア固有のセクションを参照してください。

Spring Data オブジェクトマッピングの中心的なロールは、ドメインオブジェクトのインスタンスを作成し、ストアネイティブデータ構造をそれらにマッピングすることです。つまり、2 つの基本的な手順が必要です。

Redis リポジトリのサポートは、オブジェクトをハッシュに永続化します。これには、RedisConverter によって実行されるオブジェクトからハッシュへの変換が必要です。デフォルトの実装では、Redis ネイティブ byte[] との間でプロパティ値をマッピングするために Converter を使用します。

前のセクションの Person 型を考えると、デフォルトのマッピングは次のようになります。

次の表に、デフォルトのマッピングルールを示します。

対応する Converter を RedisCustomConversions に登録することにより、マッピング動作をカスタマイズできます。これらのコンバーターは、Map<String,byte[]> だけでなく、単一の byte[] との間の変換も処理できます。1 つ目は、（たとえば）複合型を（たとえば）デフォルトのマッピングハッシュ構造を使用するバイナリ JSON 表現に変換するのに適しています。2 番目のオプションは、結果のハッシュを完全に制御します。

次の例は、2 つのサンプルバイト配列コンバーターを示しています。

上記のバイト配列 Converter を使用すると、次のような出力が生成されます。

次の例は、Map コンバーターの 2 つの例を示しています。

上記のマップ Converter を使用すると、次のような出力が生成されます。

キースペースは、Redis ハッシュの実際のキーを作成するために使用されるプレフィックスを定義します。デフォルトでは、プレフィックスは getClass().getName() に設定されています。このデフォルトを変更するには、集約ルートレベルで @RedisHash を設定するか、プログラムによる構成を設定します。ただし、アノテーション付きのキースペースは他の構成よりも優先されます。

次の例は、@EnableRedisRepositories アノテーションを使用してキースペース構成を設定する方法を示しています。

次の例は、プログラムでキースペースを設定する方法を示しています。

二次インデックス (英語) は、ネイティブ Redis 構造に基づくルックアップ操作を有効にするために使用されます。値は保存のたびに対応するインデックスに書き込まれ、オブジェクトが削除されるか期限切れになると削除されます。

Objects stored in Redis may be valid only for a certain amount of time. This is especially useful for persisting short-lived objects in Redis without having to remove them manually when they reach their end of life. The expiration time in seconds can be set with @RedisHash(timeToLive=…​) as well as by using KeyspaceSettings (see Keyspaces).

More flexible expiration times can be set by using the @TimeToLive annotation on either a numeric property or a method. However, do not apply @TimeToLive on both a method and a property within the same class. The following example shows the @TimeToLive annotation on a property and on a method:

The repository implementation ensures subscription to Redis keyspace notifications (英語) via RedisMessageListenerContainer.

When the expiration is set to a positive value, the corresponding EXPIRE command is run. In addition to persisting the original, a phantom copy is persisted in Redis and set to expire five minutes after the original one. This is done to enable the Repository support to publish RedisKeyExpiredEvent, holding the expired value in Spring’s ApplicationEventPublisher whenever a key expires, even though the original values have already been removed. Expiry events are received on all connected applications that use Spring Data Redis repositories.

By default, the key expiry listener is disabled when initializing the application. The startup mode can be adjusted in @EnableRedisRepositories or RedisKeyValueAdapter to start the listener with the application or upon the first insert of an entity with a TTL. See EnableKeyspaceEvents (Javadoc) for possible values.

The RedisKeyExpiredEvent holds a copy of the expired domain object as well as the key.

Marking properties with @Reference allows storing a simple key reference instead of copying values into the hash itself. On loading from Redis, references are resolved automatically and mapped back into the object, as shown in the following example:

In some cases, you need not load and rewrite the entire entity just to set a new value within it. A session timestamp for the last active time might be such a scenario where you want to alter one property. PartialUpdate lets you define set and delete actions on existing objects while taking care of updating potential expiration times of both the entity itself and index structures. The following example shows a partial update:

Query methods allow automatic derivation of simple finder queries from the method name, as shown in the following example:

Using derived query methods might not always be sufficient to model the queries to run. RedisCallback offers more control over the actual matching of index structures or even custom indexes. To do so, provide a RedisCallback that returns a single or Iterable set of id values, as shown in the following example:

The following table provides an overview of the keywords supported for Redis and what a method containing that keyword essentially translates to:

クラスター化された Redis 環境で Redis リポジトリサポートを使用できます。ConnectionFactory 構成の詳細については、"Redis クラスター" セクションを参照してください。それでも、デフォルトのキー配布はエンティティとセカンダリインデックスをクラスタ全体とそのスロット全体に分散させるため、いくつかの追加の構成を行う必要があります。

次の表は、クラスター上のデータの詳細を示しています（前の例に基づく）。

リポジトリインターフェースのインスタンスは通常、コンテナーによって作成されます。Spring Data を使用する場合は、Spring が最も自然な選択です。Spring は、Bean インスタンスを作成するための高度な機能を提供します。Spring Data Redis には、CDI 環境でリポジトリの抽象化を使用できるカスタム CDI 拡張機能が付属しています。拡張機能は JAR の一部であるため、拡張機能をアクティブにするには、Spring Data Redis JAR をクラスパスにドロップします。

次に、次の例に示すように、RedisConnectionFactory および RedisOperations の CDI プロデューサーを実装してインフラストラクチャをセットアップできます。

必要な設定は、JavaEE 環境によって異なります。

Spring Data Redis CDI 拡張機能は、使用可能なすべてのリポジトリを CDI Bean として取得し、リポジトリ・型の Bean がコンテナーによってリクエストされるたびに、Spring Data リポジトリのプロキシを作成します。次の例に示すように、Spring Data リポジトリのインスタンスを取得するには、@Injected プロパティを宣言する必要があります。

Redis リポジトリには、RedisKeyValueAdapter および RedisKeyValueTemplate インスタンスが必要です。これらの Bean は、提供された Bean が見つからない場合、Spring Data CDI 拡張によって作成および管理されます。ただし、独自の Bean を提供して、RedisKeyValueAdapter および RedisKeyValueTemplate の特定のプロパティを構成することはできます。

ストア自体としての Redis は、非常に狭い低レベル API を提供し、セカンダリインデックスやクエリ操作などの高レベル関数をユーザーに任せます。

このセクションでは、潜在的なパフォーマンスへの影響をよりよく理解するために、リポジトリ抽象化によって発行されたコマンドのより詳細なビューを提供します。

すべての操作の開始点として、次のエンティティクラスを検討してください。