JavaのPushBuilderクラスaddHeaderメソッドを徹底解説！初心者でもわかるHTTP/2プッシュ時の複数ヘッダー追加方法

PushBuilderのaddHeaderメソッド

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

生徒

「先生、PushBuilderを使ってHTTPヘッダーを設定するときって、同じ名前のヘッダーを複数付けたいことありますよね？」

先生

「その通り。そんなときにはaddHeaderメソッドを使えば、同じヘッダー名に複数の値を追加できますよ。」

生徒

「へぇ〜、setHeaderとの違いってそこにあるんですね！」

先生

「そのとおり。setHeaderは上書き、addHeaderは追加。今から詳しく見ていきましょう！」

1. PushBuilderとは？

javax.servlet.http.PushBuilderは、Java Servlet 4.0以降で利用できるインターフェースで、HTTP/2のサーバープッシュ機能を操作するために使います。クライアントからのリクエストを待たず、必要なリソースを先にプッシュすることで、Webページの読み込みを高速化する効果があります。

2. addHeaderメソッドとは？

addHeader(String name, String value)メソッドは、HTTPヘッダーの同じ名前に複数の値を設定したいときに使います。これは、ヘッダーが複数の値を許容している場合（例：AcceptやCache-Control）に便利です。

3. addHeaderとsetHeaderの違い

setHeaderは指定した名前のヘッダーがすでに存在する場合に「上書き」します。一方addHeaderは既存のヘッダーに「追加」されます。たとえばAcceptヘッダーに複数のMIMEタイプを設定したいときは、addHeaderを使います。

4. addHeaderの基本的な使い方

以下はPushBuilderで、同じAcceptヘッダーに複数の値を追加して、CSSとHTMLの両方を許可する例です。


import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.PushBuilder;

@WebServlet("/push-add-header")
public class PushAddHeaderServlet extends HttpServlet {
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        PushBuilder pushBuilder = request.newPushBuilder();

        if (pushBuilder != null) {
            pushBuilder.path("styles/theme.css")
                       .addHeader("Accept", "text/css")
                       .addHeader("Accept", "text/html")
                       .addHeader("Cache-Control", "no-cache")
                       .push();
        }

        response.setContentType("text/html");
        response.getWriter().println("<html><body>CSSを複数ヘッダー付きでプッシュしました</body></html>");
    }
}

5. addHeaderで設定できる代表的なヘッダー

HTTPリクエストにおいて、同じヘッダー名で複数の値を指定できるケースは多くあります。以下は代表例です。

Accept：複数のメディアタイプを許容（例：text/html, application/json）
Cache-Control：複数のキャッシュ設定を同時に指定
Vary：キャッシュバリエーションの指定
Access-Control-Allow-Headers：CORSヘッダーで許可するカスタムヘッダーの一覧

6. HTMLと合わせた実践的な使い方

PushBuilderでリソースをプッシュしても、HTMLで適切にリンクを設定していないと、ブラウザがそのリソースを使ってくれません。下記のようにHTMLでもリソースを記述しておくことが重要です。


<head>
    <link rel="stylesheet" href="styles/theme.css">
</head>

7. addHeaderを使ったセキュリティ対応

セキュリティの観点から、Authorizationヘッダーを複数追加して、異なる認証方法を一時的に共存させることもできます。ただし、情報漏洩には十分注意し、HTTPS環境でのみ使用するようにしましょう。

8. addHeaderと他のPushBuilderメソッドの併用

addHeaderは、pathやmethod、queryString、sessionIdなどと自由に組み合わせて使うことができます。以下は総合的な使用例です。


pushBuilder.path("api/data")
           .method("GET")
           .queryString("lang=ja")
           .sessionId(request.getSession().getId())
           .addHeader("Accept", "application/json")
           .addHeader("Accept", "application/xml")
           .addHeader("Authorization", "Bearer abcdef123456")
           .push();

9. addHeaderの使いどころまとめ

複数の値を持つHTTPヘッダーを使いたいとき、addHeaderは必須のメソッドです。たとえば、ブラウザが複数のコンテンツタイプに対応している場合、それぞれに対応するレスポンスを用意するために使います。また、パフォーマンス改善やセキュリティ対策にも使えるため、しっかり理解して使いこなしましょう。

サーブレットやJSPの基礎を体系的に理解したい人には、定番の入門書がこちらです。

スッキリわかるサーブレット＆JSP入門をAmazonで見る

※ Amazon広告リンク

元・職業訓練講師が直接指導【サーブレット & JSP実践セミナー】

職業訓練講師が解剖！Java Web開発の真髄「Servlet/JSP」とMVCアーキテクチャの本質。

累計120万PV超の技術メディア運営チームが贈る、商用開発基準の特別カリキュラム

職業訓練講師が解剖！Java Web開発の真髄「Servlet/JSP」とMVCアーキテクチャの本質。

Spring Boot等のモダンなフレームワークの背後で動く、Web開発の原点ServletとJSP。本講座では、HTTPリクエストからレスポンスまでのライフサイクルを徹底解剖。MVCモデルの真の役割分担を明確にし、ブラックボックス化されたWebの仕組みを「自力で制御する力」を60分で養います。