【Web開発講座#5】サーブレットでセッション管理！ログインユーザー名を画面に表示しよう

Webシステム開発講座へようこそ！
今回は、サーブレットを利用して、画面遷移時のセッション管理の基本を学びながら、ユーザー情報を表示する機能を実装していきます。

この記事は次のような方におすすめです：

JSPやサーブレットをこれから学ぼうとしている
SEとして新たなスキルを身につけたい方
セッションの仕組みがいまいち理解できていない方

前回の画面作成の記事をまだご覧になっていない方は、こちらからご確認ください。

2024年12月19日【Web開発講座#3】CSSを使って画面をきれいに整えよう｜初心者向け実践課題つき！

目次非表示

前回の課題の回答
セッションとは何か
セッションの実装（課題2の回答）
課題
さいごに

前回の課題の回答

それでは前回の課題の回答からはじめましょう。

課題1

「ログアウト」ボタンを押すと、ログイン画面に遷移するようにしてください。

STEP.1

サーブレットの修正

既存のサーブレットに新しいサーブレット（LogoutServlet.java）を追加しましょう。Eclipseを使用している場合、Eclipseの[新規→サーブレット]メニューから作成するとスムーズです。

LogoutServlet.java の doGet メソッドを以下のように修正します。

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    HttpSession session = request.getSession();
    session.invalidate();
    response.sendRedirect("/AnkiSystem/login.jsp");
}

ポイント解説

遷移には response.sendRedirect を使用しています。これはブラウザに「ログインページへ移動してください」と指示する方法です。
一方、request.getRequestDispatcher(...).forward(...) を使う方法もありますが、今回はログイン後の状態を完全にリセットするため、リダイレクト方式を選びました。
forward メソッドでリクエストとレスポンスをそのまま次のページに渡します。

※この時点ではまだ詳しく説明していませんが、“セッション”を使ってログイン中のユーザー情報を保持しています。詳しくは次の章で解説します！

STEP.2

JSPの修正

次に、menu.jsp のログアウトボタンにサーブレットへ遷移するように設定します。

<h1>メニュー画面</h1>
<!-- セッションから「loggedInUser」の属性を取得し表示 -->
<p><%= (String) session.getAttribute("loggedInUser") %></p>
<div class="menu-buttons">
   <button class="menu-button">問題作成</button>
   <button class="menu-button">成績確認</button>
   <button class="menu-button">トレーニング</button>
   <button class="menu-button">各種設定</button>
</div>

<!-- ログアウト専用フォーム -->
<form action="/AnkiSystem/LogoutServlet" method="GET">
   <button class="menu-button logout">ログアウト</button>
</form>

ポイント解説

ログアウトボタンが LogoutServlet.java にリクエストを送るよう、action="/AnkiSystem/LogoutServlet" を設定しています。

課題2

ログイン成功時、ログインしたユーザー名をメニュー画面に表示するようにしてください。
ヒント: サーブレットでリクエストスコープ（request.setAttribute）を使用してデータを渡し、JSPでそのデータを表示する仕組みを考えてみましょう。

この課題の解答については、次の章で「セッションとは何か」を詳しく解説しながら進めていきます。
実際にはリクエストスコープよりもセッションスコープの方が適しているのですが、このあたりの違いについても次章で解説していきます！

セッションとは何か

ユーザー情報の一時的な保存場所

セッションは、Webアプリケーションでユーザーごとに一時的なデータを保持する仕組みです。
たとえば、ログインしたユーザーの情報を一時的に保存し、次の画面でもその情報を利用する際に使います。

仕組み

Webは基本的に「ステートレス（状態を持たない）」な通信です。
セッションを使用することで、ユーザーの状態をサーバー側で一時的に管理可能になります。（例：ネットショッピングでカートに入れた商品情報などがセッションで管理されます）
セッションIDという一意の識別子を使って、サーバーとクライアントのやり取りを継続的に行います。
セッションIDは、通常クッキー（Cookie）を通じてブラウザとサーバー間でやり取りされます。

特徴

一時的: ユーザーがブラウザを閉じたり、セッションのタイムアウトが発生すると情報が失われます。
安全性: セッションはサーバー側で管理されるため、データがクライアントに漏れにくい。

セッションの実装（課題2の回答）

完成図

今回の課題の完成図は以下の通りです。
ログイン画面で入力したユーザー名を、メニュー画面で表示できるようにします。

サーバーサイド（Javaコード）の修正

最初に サーバー側（Servlet側） のコードを修正し、セッションにデータを正しく保存するようにします。
これにより、JSP側で確実にデータを取り出せるようになります。

loginServlet.javaの修正

/**
 * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
 */
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    String username = request.getParameter("username"); // クエリパラメータからユーザー名を取得
    HttpSession session = request.getSession(); // 現在のセッションを取得
    session.setAttribute("loggedInUser", username); // ユーザー名をセッションに保存
    
    RequestDispatcher dispatcher = request.getRequestDispatcher("/menu.jsp");
    dispatcher.forward(request, response);
}

修正のポイント

ユーザー名の取得
request.getParameter("username") で、フォームから送信されたユーザー名を取得します。
セッションに保存
request.getSession() により、現在のセッションを取得し、session.setAttribute("loggedInUser", username) でユーザー名をセッションに保存します。これにより、menu.jsp でユーザー名を表示することが可能になります。

データ渡しの確認方法

サーブレットからJSPへ正しくデータが渡っているかを確認するために、デバッグモードで動作確認を行います。

手順

STEP.1

Eclipse上にブレークポイントを設定する

対象サーブレット（今回は LogoutServlet.java）を開きます。
確認したい行番号をクリックして、ブレークポイント（ピンのマーク）を設定します。

STEP.2

デバッグモードで実行

対象のプロジェクトを右クリック → デバッグ → サーバーでデバッグを選択します

STEP.3

実際に動かしてデータを確認

実際に「test」などのユーザー名を入力してログインボタンを押します。
ブレークポイントで処理が止まったら、以下のように操作します。
- Step Over (F6)：次の行へ進む
- Step Into (F5)：メソッドの内部に入る
- Continue (F8)：次のブレークポイントまたは終了まで進める
変数にカーソルを合わせると中身が確認できます！

※変数の中身は「その行を通過した後」に値が入るので注意しましょう！

JSPファイルの修正

次に、メニュー画面（menu.jsp）でログインユーザー名を表示できるように修正します。

menu.jspの修正（抜粋）

<h1>メニュー画面</h1>
<p>ようこそ、<%= (String) session.getAttribute("loggedInUser") %>さん！</p>
<form action="/AnkiSystem/LogoutServlet" method="GET">

修正のポイント

セッションから "loggedInUser" というキーで格納されたユーザー名を取得し、表示しています。
セッションに値が入っていないと表示できないため、事前にセッションが正しくセットされていることを確認しましょう。

セッションのクリア処理

ログアウトする際に、セッションを無効化（クリア）する方法を紹介します。

LogoutServlet.javaの修正

/**
 * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
 */
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    HttpSession session = request.getSession();
    session.invalidate();
    response.sendRedirect("/AnkiSystem/login.jsp");
}

修正ポイント

セッション情報の取得
request.getSession() を使用して、現在のセッションを取得します。
セッション情報をクリア
session.invalidate() を実行してセッション情報を破棄します。

追加の注意点

セキュリティ強化
セッションのクリアは、特にユーザーの個人情報や認証情報がセッションに保存されている場合に重要です。セッションのクリアを怠ると、セキュリティリスクが増大する可能性があります。
ユーザー体験の向上
明示的にログアウトする機能を提供することで、ユーザーが自分のセッションを安全に終了できるようになります。