セッションの情報をRedisに保存する

セッション情報を Redis に保存する方法について説明します。

セッション情報をRedisに保存することで、アプリケーションのスケールが可能となります。 Redisへのセッション情報の保存や取得は、 Spring Session が行ってくれるので、アプリケーション開発者が意識する必要はありません。

警告

セッション情報をhttp session上に保存した場合は、基本的にはアプリケーションのヒープ上にセッション情報が保存されます。 このためアプリケーションをスケールした場合にセッション情報が引き継がれない等の問題が発生します。

セッションの保存先をRedisにする

Spring Session - Spring Boot Configuration を参考にライブラリの追加と設定の追加を行います。

ローカル開発環境について

Dockerの Redis公式イメージ を使用することで簡単にRedis環境を構築出来ます。 この場合は、ローカル開発環境とテストや本番環境でRedisの接続先の設定が変わるので、2.3.3. Profile Specific Filesで設定値を切り替える等の対応が必要となります。

例えば、本番と開発PCで設定を切り替える場合には以下のような構成になります。 接続先の設定については、 Configuring the Redis Connection を参照してください。

application.properties(本番用)

spring.redis.host=redis.server

application-dev.properties(開発用)

spring.redis.host=localhost

Tip

Spring Boot 3.x では、Auto Configure により保存先に対応する実装がクラスパス上から自動的に選択されます。 （ 選択順は Spring Session を参照してください） Redis環境を開発者全員に構築させるのが難しい場合、開発用のプロファイルでは Auto Configure の対象から除外することで無効化することも可能です。

# Redis用の spring-session-data-redis を使用している場合
spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration