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

生徒

「先生、JavaのServletでWebSocketを使うときって、どうやって普通のHTTP通信から切り替えるんですか？」

先生

「それにはHttpUpgradeHandlerというインターフェースを使うことで、通常のHTTP接続を他のプロトコルにアップグレードできるんです。」

生徒

「なるほど、ServletでWebSocketを使うための入り口になるんですね？」

先生

「その通りです！では、HttpUpgradeHandlerの基本を一緒に見ていきましょう。」

1. HttpUpgradeHandlerとは

Javaのjavax.servlet.http.HttpUpgradeHandlerインターフェースは、Servlet 3.1で導入された仕組みで、HTTP接続を別のプロトコルに切り替えるためのインターフェースです。たとえば、HTTPからWebSocketにアップグレードするといった場面で使用されます。

このインターフェースを実装することで、HTTPのアップグレード要求に応じてカスタム処理を提供することが可能になります。サーバーがクライアントからのアップグレード要求を受け入れると、ServletはHttpUpgradeHandlerに制御を移します。

2. HTTPアップグレードとは

HTTPアップグレードとは、クライアントとサーバーが最初にHTTPで通信を開始し、その後で別のプロトコル（たとえばWebSocketやHTTP/2）に通信方法を変更する仕組みです。HTTPのリクエストヘッダーにUpgradeという項目があり、それを用いてプロトコルを変更します。

Servletにおいては、HttpServletRequestのupgradeメソッドを使って、接続をHttpUpgradeHandlerに渡すことができます。

3. HttpUpgradeHandlerのメソッド

HttpUpgradeHandlerは以下の2つのメソッドを定義しています：

init(WebConnection connection)：アップグレード完了後、初期化処理を行うメソッド。
destroy()：接続終了時に呼び出され、リソース解放などを行うメソッド。

この2つのメソッドを実装することで、HTTPアップグレード後の通信制御を細かく管理できます。

4. HttpUpgradeHandlerの基本的な実装例

以下は、HttpUpgradeHandlerを実装して、WebConnectionから入出力を行うシンプルな例です。


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("接続が終了しました。");
    }
}

5. upgradeメソッドの使用例

サーブレットのdoGetやdoPostメソッド内で、リクエストに対してアップグレード処理を実行するには、HttpServletRequestのupgradeメソッドを使います。


import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

public class UpgradeServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) {
        try {
            request.upgrade(EchoUpgradeHandler.class);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

このコードにより、HTTP接続がEchoUpgradeHandlerに渡され、アップグレードされた通信を処理できます。

6. WebSocketとの違いと連携

HttpUpgradeHandlerは、WebSocketのようなプロトコルにアップグレードするための低レベルの仕組みです。WebSocket API（javax.websocketパッケージ）を使えば、より簡単にWebSocketサーバーを実装できますが、その内部ではHttpUpgradeHandlerが使われています。

そのため、より柔軟に制御したい場合や、自前のプロトコル実装が必要な場合には、HttpUpgradeHandlerの知識が役立ちます。