JavaのPushBuilderクラスqueryStringメソッドを完全ガイド！初心者にもわかるHTTP/2でのクエリ文字列の指定方法

PushBuilderのqueryStringメソッド

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

生徒

「先生、JavaのServletでPushBuilderを使ってリソースをプッシュする方法はわかったんですけど、URLにクエリパラメータをつけたいときってどうするんですか？」

先生

「それなら、queryStringメソッドを使えば、?key=valueのようなクエリ文字列を指定することができますよ。」

生徒

「それってフォーム送信みたいな動きもできるってことですか？」

先生

「フォームのようにサーバー側へ情報を渡すことができます。ただし、GETメソッドと組み合わせて使うのが一般的ですよ。それでは詳しく解説していきましょう！」

1. PushBuilderとは？

javax.servlet.http.PushBuilderは、Java Servlet 4.0から利用できるインターフェースで、HTTP/2のサーバープッシュ機能を扱うためのものです。静的リソース（CSS、JavaScript、画像など）をクライアントがリクエストする前に、サーバーから先に送信して、Webページの表示速度を高速化できます。

2. queryStringメソッドとは？

PushBuilderのqueryString(String query)メソッドは、リソースに付けるクエリ文字列（?name=valueの形式）を指定するために使います。これにより、サーバー側でクエリパラメータを受け取って処理するようなリソースでも、プッシュ時にパラメータを渡すことが可能になります。

3. queryStringメソッドの使い方

以下は、Java ServletでPushBuilderを使って、クエリ文字列付きで画像ファイルをプッシュするサンプルです。


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

        PushBuilder pushBuilder = request.newPushBuilder();

        if (pushBuilder != null) {
            pushBuilder.path("image")
                       .queryString("id=123&type=thumbnail")
                       .push();
        }

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

4. クエリ文字列を指定するとどうなる？

クエリ文字列を指定すると、例えばimage?id=123&type=thumbnailという形でサーバーにリクエストされます。サーバー側ではHttpServletRequest#getParameter()などを使って、idやtypeの値を受け取ることができます。

5. queryStringと他のPushBuilderメソッドの組み合わせ

queryStringは、pathやmethod、setHeaderなどの他のメソッドと組み合わせて使うのが基本です。以下のようにメソッドチェーンで記述するのが一般的です。


pushBuilder.path("data")
           .queryString("user=guest")
           .method("GET")
           .setHeader("Accept", "application/json")
           .push();

6. queryStringを使うときの注意点

queryStringを使う場合は、値のエンコードに注意しましょう。たとえば日本語などのマルチバイト文字を含む場合は、URLエンコードしてから設定するのが安全です。また、GETメソッドと組み合わせるようにし、POSTのようなボディ付きのリクエストは使わないようにしましょう。

7. クエリパラメータのあるHTMLリクエストとの違い

通常のHTMLフォームなどで送るクエリパラメータは、ユーザー操作によって送信されますが、PushBuilderではサーバー側から自動で送信されます。そのため、ユーザーの操作を待たずに事前に処理を進めたいリソースに向いています。

8. PushBuilderとqueryStringを活用する場面

たとえば、ユーザーのプロフィール画像を動的に読み込む場合や、言語設定に応じたスクリプトを出し分けたい場合などに、クエリ付きのパスを使ってリソースを切り替えることができます。PushBuilderでこうしたリクエストを先に処理しておくことで、画面表示がスムーズになります。

9. PushBuilderのqueryStringメソッドで高速化を実現

queryStringを使うことで、サーバー側のリソース取得処理をより細かく制御できます。HTTP/2のサーバープッシュと組み合わせることで、通信回数の削減とレスポンス高速化を同時に実現できるのが魅力です。クライアントが必要とする情報を事前に送信することで、Webページ全体のパフォーマンスが大幅に改善される可能性があります。

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