Java : HttpRequest.Builder (HTTP通信) - API使用例

HttpRequest.Builder (Java SE 21 & JDK 21) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様書のおともにどうぞ。

概要

「HTTPリクエスト」のビルダー。

クラス構成

HttpRequest.Builder クラスは、HttpRequest を作成するためのビルダークラスです。

final var uri = URI.create("https://example.com/");

final var builder = HttpRequest.newBuilder(uri);
final var request = builder
        .POST(HttpRequest.BodyPublishers.ofString("XYZ"))
        .header("Content-Type", "text/plain")
        .header("Content-Language", "en")
        .timeout(Duration.ofSeconds(30))
        .version(HttpClient.Version.HTTP_1_1)
        .build();

System.out.println(request); // https://example.com/ POST
System.out.println(request.method()); // POST

// {Content-Language=[en], Content-Type=[text/plain]}
System.out.println(request.headers().map());

System.out.println(request.timeout()); // Optional[PT30S]
System.out.println(request.version()); // Optional[HTTP_1_1]

メソッド

HttpRequest build ()

HttpRequestを作成して返します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri)
        .POST(HttpRequest.BodyPublishers.ofString("XYZ"))
        .build();

System.out.println(request); // https://example.com/ POST

HttpRequest.Builder copy ()

現在の状態に基づいて、このBuilderの正確な複製コピーを返します。

final var uri = URI.create("https://example.com/");

final var src = HttpRequest.newBuilder(uri).DELETE();
final var copied = src.copy();

System.out.println(src.build()); // https://example.com/ DELETE
System.out.println(copied.build()); // https://example.com/ DELETE

copied.GET();

System.out.println(src.build()); // https://example.com/ DELETE
System.out.println(copied.build()); // https://example.com/ GET

src.uri(URI.create("http://127.0.0.1:8000/"));

System.out.println(src.build()); // http://127.0.0.1:8000/ DELETE
System.out.println(copied.build()); // https://example.com/ GET

HttpRequest.Builder DELETE ()

このビルダーのリクエスト・メソッドをDELETEに設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri).DELETE().build();

System.out.println(request); // https://example.com/ DELETE
System.out.println(request.method()); // DELETE

HttpRequest.Builder expectContinue (boolean enable)

サーバーが本文を送信する前にリクエストを確認するようリクエストします。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri).expectContinue(true).build();

System.out.println(request); // https://example.com/ GET
System.out.println(request.expectContinue()); // true

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri).build();
System.out.println(request.expectContinue()); // false

HttpRequest.Builder GET ()

このビルダーのリクエスト・メソッドをGETに設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri).GET().build();

System.out.println(request); // https://example.com/ GET
System.out.println(request.method()); // GET

default HttpRequest.Builder HEAD ()

このビルダーのリクエスト・メソッドをHEADに設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri).HEAD().build();

System.out.println(request); // https://example.com/ HEAD
System.out.println(request.method()); // HEAD

HttpRequest.Builder header (String name, String value)

指定された名前値ペアを、このリクエストのヘッダー・セットに追加します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri)
        .header("aaa", "X")
        .header("bbb", "Y1")
        .header("bbb", "Y2")
        .header("ccc", "Z")
        .build();

// https://example.com/ GET
System.out.println(request);

// {aaa=[X], bbb=[Y1, Y2], ccc=[Z]}
System.out.println(request.headers().map());

HttpRequest.Builder headers (String... headers)

指定された名前と値のペアを、このリクエストのヘッダーのセットに追加します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri)
        .headers("aaa", "X", "bbb", "Y1", "bbb", "Y2", "ccc", "Z")
        .build();

// https://example.com/ GET
System.out.println(request);

// {aaa=[X], bbb=[Y1, Y2], ccc=[Z]}
System.out.println(request.headers().map());

HttpRequest.Builder method (String method, HttpRequest.BodyPublisher bodyPublisher)

このビルダーのリクエスト・メソッドおよびリクエスト本文を指定された値に設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri)
        .method("HEAD", HttpRequest.BodyPublishers.noBody())
        .build();

System.out.println(request); // https://example.com/ HEAD
System.out.println(request.method()); // HEAD

HttpRequest.Builder POST (HttpRequest.BodyPublisher bodyPublisher)

このBuilderのリクエスト・メソッドをPOSTに設定し、リクエスト本文パブリッシャを指定された値に設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri)
        .POST(HttpRequest.BodyPublishers.ofString("XYZ"))
        .build();

System.out.println(request); // https://example.com/ POST
System.out.println(request.method()); // POST

HttpRequest.Builder PUT (HttpRequest.BodyPublisher bodyPublisher)

このBuilderのリクエスト・メソッドをPUTに設定し、リクエスト本文パブリッシャを指定された値に設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri)
        .PUT(HttpRequest.BodyPublishers.ofString("XYZ"))
        .build();

System.out.println(request); // https://example.com/ PUT
System.out.println(request.method()); // PUT

HttpRequest.Builder setHeader (String name, String value)

指定された名前値ペアを、このリクエストのヘッダーのセットに設定します。

final var uri = URI.create("https://example.com/");

final var builder = HttpRequest.newBuilder(uri);

final var request1 = builder
        .header("aaa", "X1")
        .header("aaa", "X2")
        .header("bbb", "Y")
        .build();

// {aaa=[X1, X2], bbb=[Y]}
System.out.println(request1.headers().map());

final var request2 = builder
        .setHeader("aaa", "X3")
        .build();

// {aaa=[X3], bbb=[Y]}
System.out.println(request2.headers().map());

HttpRequest.Builder timeout (Duration duration)

このリクエストのタイムアウトを設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri)
        .timeout(Duration.ofSeconds(30))
        .build();

System.out.println(request); // https://example.com/ GET
System.out.println(request.timeout()); // Optional[PT30S]

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri).build();
System.out.println(request.timeout()); // Optional.empty

HttpRequest.Builder uri (URI uri)

このHttpRequestのリクエストURIを設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder().uri(uri).build();
System.out.println(request); // https://example.com/ GET

HttpRequest.Builder version (HttpClient.Version version)

このリクエストの優先HttpClient.Versionを設定します。

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri)
        .version(HttpClient.Version.HTTP_1_1)
        .build();

System.out.println(request); // https://example.com/ GET
System.out.println(request.version()); // Optional[HTTP_1_1]

final var uri = URI.create("https://example.com/");

final var request = HttpRequest.newBuilder(uri).build();
System.out.println(request.version()); // Optional.empty

API 使用例

Java : HttpRequest.Builder (HTTP通信) - API使用例

概要

メソッド

HttpRequest build ()

HttpRequest.Builder copy ()

HttpRequest.Builder DELETE ()

HttpRequest.Builder expectContinue (boolean enable)

HttpRequest.Builder GET ()

default HttpRequest.Builder HEAD ()

HttpRequest.Builder header (String name, String value)

HttpRequest.Builder headers (String... headers)

HttpRequest.Builder method (String method, HttpRequest.BodyPublisher bodyPublisher)

HttpRequest.Builder POST (HttpRequest.BodyPublisher bodyPublisher)

HttpRequest.Builder PUT (HttpRequest.BodyPublisher bodyPublisher)

HttpRequest.Builder setHeader (String name, String value)

HttpRequest.Builder timeout (Duration duration)

HttpRequest.Builder uri (URI uri)

HttpRequest.Builder version (HttpClient.Version version)

関連記事