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

生徒

「先生、JavaのHttpUpgradeHandlerのinitメソッドって、何のために使うんですか？」

先生

「initメソッドは、HTTP通信を別のプロトコルにアップグレードしたあとに、その接続を使ってデータの読み書きなどをする初期処理を書く場所なんですよ。」

生徒

「じゃあ、WebSocketみたいな処理のスタート地点になるんですね！」

先生

「その通り！では、このinitメソッドについて、詳しく見ていきましょう。」

1. HttpUpgradeHandlerとinitメソッドの関係

HttpUpgradeHandlerは、Servlet 3.1で追加されたインターフェースで、HTTP通信をWebSocketなど別のプロトコルにアップグレードする際の処理を担います。その中でもinitメソッドは、アップグレード後の接続が確立された時点で自動的に呼び出される重要なメソッドです。

つまり、HTTPアップグレードが完了した直後に、サーバーが行う初期処理を書くのがinitメソッドの役割なのです。

2. initメソッドのシグネチャ

HttpUpgradeHandlerのinitメソッドは次のように定義されています：


void init(WebConnection wc);

このWebConnectionはServletコンテナから渡されるオブジェクトで、アップグレード後の双方向通信に使います。クライアントとの入力ストリームや出力ストリームを取得して、データをやりとりできます。

3. initメソッドの実装例

以下はHttpUpgradeHandlerのinitメソッドを使って、接続されたクライアントとエコー通信を行うサンプルコードです。


import jakarta.servlet.http.HttpUpgradeHandler;
import jakarta.servlet.http.WebConnection;
import java.io.InputStream;
import java.io.OutputStream;

public class EchoUpgradeHandler implements HttpUpgradeHandler {
    @Override
    public void init(WebConnection connection) {
        try (InputStream in = connection.getInputStream();
             OutputStream out = connection.getOutputStream()) {
            int data;
            while ((data = in.read()) != -1) {
                out.write(data); // 入力をそのまま返すエコー処理
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Override
    public void destroy() {
        System.out.println("接続が終了しました。");
    }
}

4. initで取得できるWebConnectionの使い方

initメソッドでは、Servletから提供されるWebConnectionオブジェクトを使って以下のことができます：

getInputStream()：クライアントからのデータ受信
getOutputStream()：クライアントへのデータ送信

この双方向通信は、WebSocketのようなプロトコルでリアルタイム通信を実現するのに役立ちます。

5. Servlet側からinitを呼び出す流れ

initメソッドは手動で呼び出すものではなく、HttpServletRequestのupgradeメソッドを通して間接的に呼ばれます。Servletでの記述例は以下のようになります。


@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) {
    try {
        request.upgrade(EchoUpgradeHandler.class); // initが自動で呼ばれる
    } catch (IOException e) {
        e.printStackTrace();
    }
}