JavaのHttpSessionListenerのsessionCreatedメソッドとは？初心者でもわかるセッション生成検知の仕組み

HttpSessionListenerのsessionCreatedメソッド

先生と生徒の会話形式で理解しよう

生徒

「JavaのWebアプリケーションで、ユーザーのセッションが作られたタイミングを知るにはどうすればいいですか？」

先生

「それにはHttpSessionListenerというインターフェースを使います。その中のsessionCreatedメソッドで、セッションが生成されたときの処理を書くことができますよ。」

生徒

「ログを取ったり初期化したりする処理も書けますか？」

先生

「もちろんです。では、sessionCreatedメソッドの使い方を詳しく見ていきましょう。」

1. HttpSessionListenerとは

Javaのjavax.servlet.http.HttpSessionListenerインターフェースは、Webアプリケーションにおいてセッションの生成や破棄のイベントを検知するための仕組みです。ユーザーがWebサイトにアクセスし、サーバー側で新しいセッションが作成されるときに通知を受け取ることができます。

このインターフェースを使うことで、セッションライフサイクルに連動した処理を簡単に実装できます。

2. sessionCreatedメソッドとは

sessionCreatedメソッドは、HttpSessionListenerインターフェースに定義されているメソッドのひとつで、サーバーが新しいセッションを生成した瞬間に呼び出されます。

ユーザーがWebサイトに初めてアクセスしたときや、前のセッションが無効になり新しいセッションが作られたときに、このメソッドが自動で実行されます。

将来を見据えて、＋αのスキルを身につけたい方へ

JavaやLinuxを学んでいても、「このままで市場価値は上がるのか」「キャリアの選択肢を広げたい」と感じる方は少なくありません。

AIを学ぶならアイデミープレミアム

3. sessionCreatedメソッドの用途

sessionCreatedメソッドは以下のような用途で活用されます：

セッション開始のタイミングでログを出力する
ユーザーごとの初期データをセッションに保存する
アクティブなセッション数をカウントする
不正アクセス検知用の監視処理を追加する

4. sessionCreatedメソッドの実装例

以下にsessionCreatedメソッドを実装したHttpSessionListenerのサンプルコードを示します。セッションが生成されるたびにIDをログ出力しています。


import jakarta.servlet.http.HttpSessionEvent;
import jakarta.servlet.http.HttpSessionListener;

public class MySessionLogger implements HttpSessionListener {
    @Override
    public void sessionCreated(HttpSessionEvent event) {
        String sessionId = event.getSession().getId();
        System.out.println("セッションが生成されました: " + sessionId);
    }

    @Override
    public void sessionDestroyed(HttpSessionEvent event) {
        // ここではセッション破棄時の処理を書く（今回は省略）
    }
}

5. web.xmlまたはアノテーションによる登録

HttpSessionListenerをWebアプリケーションに反映させるには、web.xmlにリスナーとして登録するか、@WebListenerアノテーションを使います。

web.xmlでの記述例：


<listener>
    <listener-class>com.example.MySessionLogger</listener-class>
</listener>

@WebListenerアノテーションを使う方法：


import jakarta.servlet.annotation.WebListener;

@WebListener
public class MySessionLogger implements HttpSessionListener {
    @Override
    public void sessionCreated(HttpSessionEvent event) {
        System.out.println("セッション開始: " + event.getSession().getId());
    }

    @Override
    public void sessionDestroyed(HttpSessionEvent event) {
        // セッション終了処理（省略）
    }
}

6. 初期値をセッションに設定する例

セッション生成時に初期値を設定したい場合も、sessionCreatedで処理できます。例えば、アクセス回数を0に設定する例は以下の通りです。


@Override
public void sessionCreated(HttpSessionEvent event) {
    event.getSession().setAttribute("accessCount", 0);
    System.out.println("セッションID: " + event.getSession().getId() + " に初期値を設定しました。");
}