ネットワーク

Java – HTTP POSTリクエストを送信する方法

JavaでHTTP POSTリクエストを送信するには、主に HttpURLConnection または HttpClient を使用します。

HttpURLConnection はJava SEに標準で含まれており、軽量ですがコードがやや冗長です。

一方、 HttpClient はJava 11以降で利用可能で、非同期処理や簡潔な記述が可能です。

POSTリクエストでは、リクエストボディにデータを送信するため、適切なContent-Typeヘッダー(例: “application/json”)を設定し、データをリクエストの出力ストリームに書き込みます。

目次から探す

JavaでHTTP POSTリクエストを送信する方法

JavaでHTTP POSTリクエストを送信するには、HttpURLConnectionクラスを使用するのが一般的です。

このクラスを使うことで、簡単にHTTPリクエストを作成し、サーバーにデータを送信することができます。

以下に、基本的な実装方法を示します。

import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
public class App {
    public static void main(String[] args) {
        try {
            // 送信先のURLを指定
            URL url = new URL("https://example.com/api/post");
            HttpURLConnection connection = (HttpURLConnection) url.openConnection();
            
            // POSTメソッドを指定
            connection.setRequestMethod("POST");
            
            // リクエストヘッダーの設定
            connection.setRequestProperty("Content-Type", "application/json; utf-8");
            connection.setRequestProperty("Accept", "application/json");
            connection.setDoOutput(true); // 出力を有効にする
            
            // 送信するデータを作成
            String jsonInputString = "{\"name\": \"太郎\", \"age\": 30}";
            
            // データを送信
            try (OutputStream os = connection.getOutputStream()) {
                byte[] input = jsonInputString.getBytes("utf-8");
                os.write(input, 0, input.length); // データを出力ストリームに書き込む
            }
            
            // レスポンスコードを取得
            int responseCode = connection.getResponseCode();
            System.out.println("レスポンスコード: " + responseCode);
            
            // 接続を切断
            connection.disconnect();
        } catch (Exception e) {
            e.printStackTrace(); // エラーが発生した場合はスタックトレースを表示
        }
    }
}

レスポンスコード: 200

このコードでは、指定したURLに対してJSON形式のデータをPOSTリクエストとして送信しています。

リクエストヘッダーには、コンテンツタイプと受け入れ形式を指定しています。

データ送信後、レスポンスコードを取得し、成功した場合は200が表示されます。

POSTリクエストで送信するデータの形式

HTTP POSTリクエストでは、さまざまな形式でデータを送信することができます。

一般的なデータ形式には、以下のようなものがあります。

データ形式	説明
JSON	JavaScript Object Notation。軽量で人間にも読みやすい形式。
XML	Extensible Markup Language。構造化されたデータを表現するためのマークアップ言語。
Form Data	フォームから送信されるデータ。`application/x-www-form-urlencoded`形式。
Plain Text	プレーンテキスト形式。特別なフォーマットなしでデータを送信。

JSON形式

JSONは、データをキーと値のペアで表現するため、APIとの通信で非常に一般的に使用されます。

以下は、JSON形式の例です。

{
    "name": "太郎",
    "age": 30
}

XML形式

XMLは、データの構造を明示的に示すためにタグを使用します。

以下は、XML形式の例です。

<person>
    <name>太郎</name>
    <age>30</age>
</person>

Form Data形式

フォームデータは、HTMLフォームから送信されるデータで、通常はapplication/x-www-form-urlencoded形式でエンコードされます。

以下は、フォームデータの例です。

name=太郎&age=30

プレーンテキスト形式

プレーンテキスト形式は、特別なフォーマットを持たない単純なテキストデータです。

以下は、プレーンテキストの例です。

太郎, 30

これらのデータ形式は、APIの仕様や要求に応じて使い分けることが重要です。

特に、JSON形式は多くのWeb APIで標準的に使用されているため、理解しておくと良いでしょう。

HTTPヘッダーの設定

HTTPヘッダーは、クライアントとサーバー間で送信されるメタデータであり、リクエストやレスポンスの内容を制御するために重要です。

POSTリクエストを送信する際には、適切なヘッダーを設定することで、サーバーに対して正しい情報を提供することができます。

以下に、一般的に使用されるHTTPヘッダーの例を示します。

ヘッダー名	説明
Content-Type	送信するデータの形式を指定。例：`application/json`
Accept	クライアントが受け入れるレスポンスの形式を指定。例：`application/json`
Authorization	認証情報を提供するためのヘッダー。APIキーやトークンを含む。
User-Agent	クライアントの情報を示すヘッダー。ブラウザやアプリケーションの情報を含む。
Cache-Control	キャッシュの動作を制御するためのヘッダー。例：`no-cache`や`max-age=3600`

Content-Type

Content-Typeヘッダーは、リクエストボディのデータ形式を指定します。

例えば、JSONデータを送信する場合は、以下のように設定します。

connection.setRequestProperty("Content-Type", "application/json; utf-8");

Accept

Acceptヘッダーは、クライアントが受け入れるレスポンスの形式を指定します。

例えば、JSON形式のレスポンスを期待する場合は、次のように設定します。

connection.setRequestProperty("Accept", "application/json");

Authorization

APIにアクセスする際に認証が必要な場合、Authorizationヘッダーを使用して認証情報を送信します。

例えば、Bearerトークンを使用する場合は、以下のように設定します。

connection.setRequestProperty("Authorization", "Bearer YOUR_ACCESS_TOKEN");

User-Agent

User-Agentヘッダーは、クライアントの情報をサーバーに伝えるために使用されます。

特定のブラウザやアプリケーションの情報を含めることができます。

connection.setRequestProperty("User-Agent", "Java/1.8.0_251");

Cache-Control

Cache-Controlヘッダーは、キャッシュの動作を制御します。

例えば、キャッシュを無効にする場合は、以下のように設定します。

connection.setRequestProperty("Cache-Control", "no-cache");

これらのヘッダーを適切に設定することで、サーバーとの通信が円滑になり、期待通りのレスポンスを得ることができます。

特に、APIを利用する際には、ドキュメントに従って必要なヘッダーを確認することが重要です。

エラーハンドリングとデバッグ

HTTP POSTリクエストを送信する際には、エラーが発生する可能性があります。

これらのエラーを適切に処理し、デバッグすることは、アプリケーションの信頼性を高めるために重要です。

以下に、エラーハンドリングとデバッグの方法を説明します。

エラーハンドリングの基本

Javaでは、例外処理を使用してエラーを管理します。

try-catchブロックを使用して、リクエストの送信中に発生する可能性のある例外をキャッチし、適切な処理を行います。

以下は、基本的なエラーハンドリングの例です。

try {
    // HTTPリクエストの送信処理
} catch (IOException e) {
    System.out.println("IOエラーが発生しました: " + e.getMessage());
} catch (Exception e) {
    System.out.println("予期しないエラーが発生しました: " + e.getMessage());
}

HTTPレスポンスコードの確認

リクエストが成功したかどうかを確認するためには、HTTPレスポンスコードをチェックすることが重要です。

レスポンスコードが200であれば成功、400や500系のコードはエラーを示します。

以下のようにレスポンスコードを確認できます。

int responseCode = connection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
    System.out.println("リクエストは成功しました。");
} else {
    System.out.println("エラーが発生しました。レスポンスコード: " + responseCode);
}

エラーメッセージの取得

サーバーからのレスポンスにエラーメッセージが含まれている場合、それを取得して表示することも重要です。

以下のように、エラーメッセージを取得することができます。

InputStream errorStream = connection.getErrorStream();
if (errorStream != null) {
    BufferedReader reader = new BufferedReader(new InputStreamReader(errorStream));
    String line;
    StringBuilder errorResponse = new StringBuilder();
    while ((line = reader.readLine()) != null) {
        errorResponse.append(line);
    }
    System.out.println("エラーレスポンス: " + errorResponse.toString());
}

デバッグのためのログ出力

デバッグを行う際には、適切なログ出力が役立ちます。

リクエストの内容やレスポンスの内容をログに記録することで、問題の特定が容易になります。

以下は、リクエストとレスポンスのログ出力の例です。

System.out.println("リクエストURL: " + url);
System.out.println("リクエストメソッド: " + connection.getRequestMethod());
System.out.println("リクエストヘッダー: " + connection.getRequestProperties());
System.out.println("レスポンスコード: " + responseCode);

エラーハンドリングとデバッグは、HTTP POSTリクエストを送信する際に非常に重要です。

適切な例外処理、レスポンスコードの確認、エラーメッセージの取得、そしてログ出力を行うことで、問題を迅速に特定し、解決することができます。

これにより、アプリケーションの信頼性を向上させることができます。

実践例：APIとの連携

HTTP POSTリクエストを使用してAPIと連携することは、Javaプログラミングにおいて非常に一般的なタスクです。

ここでは、実際のAPIを使用してデータを送信する例を示します。

この例では、JSONPlaceholderという無料のAPIを使用して、ユーザー情報を作成するリクエストを送信します。

使用するAPI

APIエンドポイント: https://jsonplaceholder.typicode.com/users
HTTPメソッド: POST
送信するデータ: ユーザー名とメールアドレス

以下のコードは、指定したAPIに対してユーザー情報をPOSTリクエストとして送信するものです。

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
public class App {
    public static void main(String[] args) {
        try {
            // APIエンドポイントのURLを指定
            URL url = new URL("https://jsonplaceholder.typicode.com/users");
            HttpURLConnection connection = (HttpURLConnection) url.openConnection();
            
            // POSTメソッドを指定
            connection.setRequestMethod("POST");
            
            // リクエストヘッダーの設定
            connection.setRequestProperty("Content-Type", "application/json; utf-8");
            connection.setRequestProperty("Accept", "application/json");
            connection.setDoOutput(true); // 出力を有効にする
            
            // 送信するデータを作成
            String jsonInputString = "{\"name\": \"山田太郎\", \"email\": \"taro@example.com\"}";
            
            // データを送信
            try (OutputStream os = connection.getOutputStream()) {
                byte[] input = jsonInputString.getBytes("utf-8");
                os.write(input, 0, input.length); // データを出力ストリームに書き込む
            }
            
            // レスポンスコードを取得
            int responseCode = connection.getResponseCode();
            System.out.println("レスポンスコード: " + responseCode);
            
            // レスポンスを取得
            BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
            String line;
            StringBuilder response = new StringBuilder();
            while ((line = reader.readLine()) != null) {
                response.append(line);
            }
            System.out.println("レスポンス内容: " + response.toString());
            
            // 接続を切断
            connection.disconnect();
        } catch (Exception e) {
            e.printStackTrace(); // エラーが発生した場合はスタックトレースを表示
        }
    }
}

レスポンスコード: 201
レスポンス内容: {"name":"山田太郎","email":"taro@example.com","id":11}

このコードでは、JSONPlaceholder APIに対してユーザー情報をPOSTリクエストとして送信しています。

リクエストヘッダーには、Content-TypeとAcceptを設定し、JSON形式のデータを送信しています。

レスポンスコードが201であれば、リソースが正常に作成されたことを示します。

また、レスポンス内容には、作成されたユーザーの情報が含まれています。

このように、APIとの連携を通じて、データの送受信を行うことができます。

まとめ

この記事では、Javaを使用してHTTP POSTリクエストを送信する方法について詳しく解説しました。

具体的には、POSTリクエストで送信するデータの形式やHTTPヘッダーの設定、エラーハンドリングとデバッグの手法、さらにはAPIとの連携の実践例を通じて、実際のアプリケーションでの活用方法を紹介しました。

これらの知識を活かして、さまざまなAPIと連携し、データの送受信を行うプログラムを作成してみてください。