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

PushBuilderのsetHeaderメソッド

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

生徒

「先生、JavaのPushBuilderでリソースをサーバープッシュするときに、HTTPヘッダーを追加したいんですけど、どうすればいいですか？」

先生

「それにはsetHeaderメソッドを使えばいいですよ。HTTPヘッダーの名前と値を指定して、プッシュするリクエストに追加できます。」

生徒

「たとえばAcceptとかAuthorizationみたいなヘッダーも追加できるんですか？」

先生

「もちろんです。必要に応じてヘッダーを設定できるので、クライアントに正しい情報を送るために非常に便利なんですよ。詳しく説明していきましょう！」

1. PushBuilderとは？

Javaのjavax.servlet.http.PushBuilderは、HTTP/2のサーバープッシュ機能を活用するためのインターフェースです。Webページの読み込み時に必要なCSSやJavaScript、画像などをあらかじめブラウザへ送ることで、表示速度を高速化できます。

2. setHeaderメソッドとは？

setHeader(String name, String value)メソッドは、PushBuilderでプッシュするHTTPリクエストにヘッダーを追加・上書きするためのメソッドです。特定のヘッダーに対して値を設定したい場合に使います。

3. setHeaderとaddHeaderの違い

setHeaderは指定された名前のヘッダーを「上書き」します。一方、addHeaderはすでに同じ名前のヘッダーがあっても「追加」します。同じヘッダーに複数の値を持たせたい場合はaddHeader、1つの値だけを持たせたい場合はsetHeaderを使うのが適しています。

4. setHeaderの基本的な使い方

以下は、PushBuilderでCSSファイルをプッシュする際に、AcceptとCache-Controlヘッダーを設定するサンプルです。


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-header")
public class PushHeaderServlet extends HttpServlet {
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        PushBuilder pushBuilder = request.newPushBuilder();

        if (pushBuilder != null) {
            pushBuilder.path("styles/main.css")
                       .setHeader("Accept", "text/css")
                       .setHeader("Cache-Control", "max-age=3600")
                       .push();
        }

        response.setContentType("text/html");
        response.getWriter().println("<html><body>CSSをプッシュしました</body></html>");
    }
}

5. よく使われるHTTPヘッダーの例

PushBuilderのsetHeaderでよく設定されるHTTPヘッダーには以下のようなものがあります。

Accept：クライアントが受け取れるメディアタイプ（例：text/html, application/jsonなど）
Authorization：認証情報（例：Bearerトークンなど）
Cache-Control：キャッシュの設定
Content-Language：リソースの言語（例：ja、enなど）
User-Agent：クライアントのブラウザ情報

6. setHeaderを使うメリット

PushBuilderのsetHeaderメソッドを使うことで、以下のようなメリットがあります。

プッシュするリソースに対して適切なメタ情報を追加できる
認証トークンなどを含めて、安全にアクセス制限されたリソースを送信可能
キャッシュ制御で、リソースの再取得を防ぎ効率化

7. HTMLでのリソース指定と組み合わせよう

PushBuilderでリソースをプッシュしても、HTMLの中で適切に指定していないとクライアント側がそれを利用できません。以下のように、HTML側でもリソースをしっかり書いておきましょう。


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

8. setHeaderとセキュリティ

たとえば、プッシュするリソースがログイン済みユーザー専用の場合、Authorizationヘッダーでトークンを追加することがあります。このとき、PushBuilderのsetHeaderでトークンを設定しておけば、クライアントが再認証なしでリソースを受け取れるようになります。ただし、情報漏洩には十分に注意しましょう。

9. 他のPushBuilderメソッドとの併用例

setHeaderはpathやmethod、queryString、sessionIdなどと組み合わせて使うことができます。以下はすべての要素を組み合わせた例です。


pushBuilder.path("api/data")
           .method("GET")
           .queryString("user=admin")
           .sessionId(request.getSession().getId())
           .setHeader("Authorization", "Bearer abcdef123456")
           .setHeader("Accept", "application/json")
           .push();

このようにすれば、安全で効率的なサーバープッシュを実現できます。

サーブレットや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分で養います。