Spring Session 入門 — Redis で HTTP セッションを共有する
講義の区切り
基本編の目安は 60〜90 分です。終了条件は、アプリ A でセッションに保存した表示名を、同じ Cookie を使ってアプリ B から取得できることです。 アプリ B でセッションを無効化したあと、元の Cookie をアプリ A に送っても表示名を取得できないことも確認します。
概要
HTTP セッションを使うと、複数のリクエストにまたがって状態を保持できます。この演習では、セッションに表示名を 1 つだけ保存します。 同じ Spring Boot アプリを異なるポートで 2 つ起動し、Spring Session を使って両方を同じ Redis につなぎます。 応答にアプリの識別名を含めるので、どちらがリクエストを処理したかを確認できます。
事前準備
- JDK 21
- Controller を使った API の作成経験と、HTTP Cookie の基礎
- Linux コンテナーが動く Docker 環境
- 空きポート 8080(アプリ A)、8081(アプリ B)、56379(Redis)
Spring Initializr で Maven / Java / Jar / YAML を選び、新しいプロジェクトを作成します。
Spring Boot は 4.0 系、Java は 21 にします。Group は dev.mikoto2000.springboot、Artifact は session、Package name は dev.mikoto2000.springboot.session です。
依存関係に Spring Web を選び、生成された pom.xml の dependencies に次を追加します。
触って学ぶ Spring Session
演習用の Redis を起動する
Redis のポートはローカルからだけ接続できるように公開します。次のコマンドは Bash と PowerShell のどちらでも実行できます。
PONG が返ることを確認します。src/main/resources/application.yaml を次の内容にします。
spring.session.timeout はセッションが操作されないまま有効でいられる時間です。
spring.session.data.redis.namespace を指定しておくと、Redis 上で演習のセッションキーを探しやすくなります。
Spring Boot がスターターを見て Spring Session を自動設定します。
セッションを読み書きする API を作る
src/main/java/dev/mikoto2000/springboot/session/SessionController.java を作成します。
保存では getSession() を使い、セッションがなければ作成します。
参照と無効化では getSession(false) を使うので、セッションがないリクエストで新規作成は起きません。
同じアプリを 2 つ起動する
プロジェクトのルート(pom.xml と同じ場所)で jar を作ります。PowerShell では .\mvnw.cmd package を使います。
1 つ目のターミナルでアプリ A を起動します。
2 つ目のターミナルも同じディレクトリで開き、アプリ B を起動します。 起動引数でポートと識別名を上書きします。Redis の接続先と名前空間は両方で共通です。
Cookie を使ってアプリ B から参照する
3 つ目のターミナルから、アプリ A に表示名を保存します。-c はサーバーが返した Cookie をファイルに保存するオプションです。
PowerShell では、以下の curl を curl.exe に読み替えてください。
ステータスは 204 です。ヘッダーの Set-Cookie に SESSION があることを確認します。
同じ Cookie を使い、アプリ A とアプリ B に順に GET を送ります。-b はファイルから読み取った Cookie を送るオプションです。
両方とも同じホスト名 127.0.0.1 を使います。Cookie の送信先はポートで区別されないので、同じ Cookie を 8080 と 8081 に送れます。
Redis でも、演習の名前空間にセッションが保存されていることを確認します。
session-lab:sessions: から始まるキーが見つかります。キーと Cookie にはセッションを識別する値が含まれるため、共有用のログに貼り付けないでください。
アプリ B で無効化する
Cookie を付けてアプリ B に DELETE を送り、その後でアプリ A に同じ Cookie を送ります。 ここでは DELETE の応答で Cookie ファイルを上書きせず、無効化前の Cookie を再送して確認します。
DELETE は 204 を返します。アプリ A の GET は 200 を返し、本文は {"instance":"A","name":null} になります。
先ほどの redis-cli --scan をもう一度実行すると、初回からこの手順だけを実施した環境ではセッションのキーが見つからなくなります。
後片付け
アプリ A と B を Ctrl+C で停止します。Redis のコンテナーを停止し、演習で保存した Cookie ファイルを削除します。
PowerShell では rm session.cookies の代わりに Remove-Item -LiteralPath session.cookies を使えます。
座学で学ぶ HTTP セッション
Cookie と Redis が持つ情報
Cookie が運ぶのはセッションを特定するための値です。Redis は表示名をセッション属性として保存します。
Spring Session は HTTP リクエストをフィルターで処理します。Controller は HttpSession を使い、どのインスタンスからでも共有の保存先にアクセスできます。
有効期限と無効化
この演習では、最後のアクセスから設定した時間が経つとセッションは期限切れになります。invalidate() を呼ぶと、その場でセッションが無効になります。
セッションの内容は一時的な状態です。ログイン情報と組み合わせる場合は、セッション ID を認証に関わる情報として扱います。
発展として、アプリ A の再起動を試します。無効化とは別に、表示名をもう一度保存してから A だけを再起動し、期限内に同じ Cookie で再取得します。 Redis を動かしたままなら、再起動前の表示名が返ることを確認できます。
理解を確かめる
- アプリ B が応答したと分かるフィールドと、その値を挙げる。
- Cookie なしの GET で表示名が返らない理由を説明する。
- アプリ B で無効化したあと、アプリ A でも表示名が得られなくなる理由を説明する。