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

生徒

「先生、JavaのHttpUpgradeHandlerってアップグレード処理に使うって聞きましたけど、destroyメソッドは何のためにあるんですか？」

先生

「destroyメソッドは、アップグレードされた接続が終了したときに呼ばれて、使い終わったリソースを解放するために使いますよ。」

生徒

「なるほど、ちゃんと後片付けをする場所ってことですね！」

先生

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

1. destroyメソッドとは

Javaのjavax.servlet.http.HttpUpgradeHandlerインターフェースに含まれるdestroyメソッドは、HTTP接続がアップグレードされて利用されたあと、接続が終了したタイミングで呼び出されるメソッドです。

このメソッドの主な役割は、開いたリソース（ストリームやスレッドなど）を確実に閉じて、メモリリークや不具合を防ぐことです。

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

destroyメソッドは引数も戻り値もない、非常にシンプルなメソッドです。


void destroy();

このメソッド内で必要なクリーンアップ処理をすべて行います。

3. destroyメソッドの基本実装

次は、アップグレード接続で使用していたスレッドを停止し、ログを出力するだけの基本的な実装例です。


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

public class SimpleUpgradeHandler implements HttpUpgradeHandler {
    private volatile boolean running = true;

    @Override
    public void init(WebConnection connection) {
        new Thread(() -> {
            try (InputStream in = connection.getInputStream();
                 OutputStream out = connection.getOutputStream()) {
                int data;
                while (running && (data = in.read()) != -1) {
                    out.write(data);
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }).start();
    }

    @Override
    public void destroy() {
        running = false;
        System.out.println("接続終了。リソースを解放しました。");
    }
}

4. destroyメソッドの主な用途

destroyメソッドは主に以下のような目的で使われます：

スレッドの停止や割り込み
入出力ストリームのクローズ
ファイルハンドルの解放
データベースやネットワークリソースの切断
ログ出力による監査

このメソッドを実装しておかないと、アップグレード通信が終わってもメモリが解放されず、システム全体のパフォーマンスに悪影響を与える恐れがあります。

5. Servletとの連携でdestroyが呼ばれるタイミング

HttpServletRequestでupgradeメソッドを使ってHttpUpgradeHandlerを指定すると、接続が切れた際にServletコンテナによってdestroyが自動的に呼び出されます。


@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) {
    try {
        request.upgrade(SimpleUpgradeHandler.class); // 接続終了時にdestroyが呼ばれる
    } catch (IOException e) {
        e.printStackTrace();
    }
}

6. destroyでのエラーハンドリングの注意点

destroyメソッド内で例外が発生すると、予期しない挙動になる可能性があります。そのため、try-catchで囲むことを忘れず、安全な終了処理を徹底しましょう。

また、サーバーによってはdestroyが呼ばれないケース（異常終了や強制終了）もあるため、バックグラウンド処理のタイムアウトやフェイルセーフ設計も重要です。

7. destroyはServletのdestroyとは別物

Servletにもdestroyというメソッドがありますが、これはServletそのものが破棄されるときの処理です。今回のHttpUpgradeHandlerのdestroyは、アップグレードされた接続の終了時専用なので混同しないようにしましょう。

まとめ

HttpUpgradeHandlerとdestroyメソッドの重要ポイント整理

本記事では、Javaのサーブレット環境において利用されるHttpUpgradeHandlerインターフェースの中でも、特に重要なdestroyメソッドについて詳しく解説してきました。 HttpUpgradeHandlerは、通常のHTTP通信を別のプロトコルへ切り替えるための仕組みであり、WebSocketのような長時間接続や双方向通信を扱う場面で活躍します。その中でdestroyメソッドは、アップグレードされた通信が終了したタイミングで必ず呼び出される、いわば「後片付け専用」の処理ポイントです。

通信中に使用していた入力ストリームや出力ストリーム、バックグラウンドスレッド、ネットワーク接続などは、明示的に解放しなければメモリリークやリソース枯渇の原因になります。 destroyメソッドを正しく実装することで、アプリケーション全体の安定性やパフォーマンスを長期的に維持することができます。特に高負荷なサーバーや、常時接続が前提となるシステムでは、この終了処理の設計が品質を大きく左右します。

destroyメソッドが果たす役割

destroyメソッドは引数も戻り値も持たない非常にシンプルな構造ですが、その責任範囲は決して小さくありません。このメソッド内では、接続中に起動したスレッドの停止フラグを切り替えたり、開いたままのリソースを確実に閉じたりする処理を行います。実装を怠ると、通信は終わっているにもかかわらず内部処理だけが生き続ける状態になり、知らないうちにメモリ使用量が増え続けることもあります。

また、destroyはServletコンテナによって自動的に呼び出されるため、開発者が明示的に呼ぶ必要はありません。その一方で、例外が発生した場合や強制終了時には呼ばれないケースも想定し、設計段階から安全側に倒した実装を心がけることが大切です。この考え方は、実務における堅牢なサーバーサイド開発の基本とも言えます。

まとめとしてのサンプル実装の振り返り

記事内で紹介したサンプルでは、SimpleUpgradeHandlerクラスを用いて、通信中はスレッドを回し続け、destroyメソッドでフラグを切り替えて安全に終了させる構成を取りました。このように、処理の開始はinitメソッド、終了はdestroyメソッドという役割分担を明確にすることで、コードの可読性と保守性が大きく向上します。


@Override
public void destroy() {
    running = false;
    System.out.println("接続終了。リソースを解放しました。");
}

上記のようなシンプルな実装であっても、destroyメソッドを用意しているかどうかで、実運用時の安定性は大きく変わります。特に初心者のうちは、通信が終わったあとに何が起きているのかを意識しにくいため、destroyの存在をしっかり理解しておくことが重要です。

Servletのdestroyとの違いを意識する

まとめとして強調しておきたいのが、HttpUpgradeHandlerのdestroyとServletのdestroyは役割がまったく異なる点です。 Servletのdestroyはアプリケーション全体やServlet自体の終了処理であるのに対し、HttpUpgradeHandlerのdestroyは「一つのアップグレード接続」が終わったときの処理です。この違いを正しく理解していないと、終了処理を書く場所を間違えてしまい、意図しない不具合につながることがあります。

先生と生徒の振り返り会話

生徒

「今回のまとめで、destroyメソッドが単なるおまけじゃなくて、かなり重要な役割を持っているって分かりました。通信が終わったあとに何もしないのは、後片付けをしないまま部屋を出るような感じなんですね。」

先生

「いい例えですね。特にアップグレード通信は長くつながることが多いので、終了処理を忘れると影響が大きくなります。 destroyメソッドは地味ですが、安定したシステムを支える大事なポイントですよ。」

生徒

「Servletのdestroyと混同しそうでしたけど、接続単位の終了処理だと理解できました。これからはinitとdestroyをセットで考えるようにします。」

先生

「それができれば十分です。今回学んだことを意識してコードを書けば、実務でも通用する設計になりますよ。小さな積み重ねが、信頼できるアプリケーションにつながります。」