当前位置：首页 > news >正文

Java 的 HttpClient 中使用 POST 请求传递参数

news 来源：原创 2025/6/9 2:17:24

在 Java 的 HttpClient 中，如果使用 POST 请求传递参数，有两种常见方式：

通过请求体传递（通常是 JSON 或 XML 格式，适用于 RPC）。
通过表单参数传递（类似于 HTML 表单提交，使用键值对）。

由于你提到的是 RPC POST 请求，我假设你想知道如何在 POST 请求中传递参数，尤其是结合 RPC 的场景。下面我将分别讲解这两种方式，并提供示例代码。

方法 1：通过请求体传递参数（JSON 格式，推荐用于 RPC）

这是 RPC 中最常见的方式，参数以 JSON 格式放在请求体中发送。

示例代码

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

public class RpcPostWithJsonParams {
    public static void main(String[] args) {
        // 目标 RPC 服务的 URL
        String url = "http://example.com/api/rpc";

        // 定义要传递的参数（JSON 格式）
        String jsonParams = "{\"method\":\"sayHello\",\"params\":{\"name\":\"张三\",\"age\":25},\"id\":1}";

        try {
            // 创建 HttpClient 实例
            CloseableHttpClient httpClient = HttpClients.createDefault();

            // 创建 POST 请求
            HttpPost httpPost = new HttpPost(url);

            // 设置请求头
            httpPost.setHeader("Content-Type", "application/json");
            httpPost.setHeader("Accept", "application/json");

            // 设置请求体（JSON 参数）
            StringEntity entity = new StringEntity(jsonParams, "UTF-8");
            httpPost.setEntity(entity);

            // 执行请求并获取响应
            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                System.out.println("状态码: " + statusCode);

                String responseBody = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("响应内容: " + responseBody);
            }

            // 关闭 HttpClient
            httpClient.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

说明

参数构造：jsonParams 是 JSON 字符串，包含 RPC 的方法名（method）、参数（params）和 ID（id）。你可以根据需要调整 params 中的内容，比如添加更多键值对。
请求体：使用 StringEntity 将 JSON 字符串设置为请求体。
适用场景：这种方式适合复杂的参数结构，尤其是在 RPC 中需要传递嵌套对象时。

方法 2：通过表单参数传递（键值对形式）

如果你的 RPC 服务支持表单参数（类似于 application/x-www-form-urlencoded），可以用键值对的方式传递参数。

示例代码

import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

public class RpcPostWithFormParams {
    public static void main(String[] args) {
        // 目标 RPC 服务的 URL
        String url = "http://example.com/api/rpc";

        try {
            // 创建 HttpClient 实例
            CloseableHttpClient httpClient = HttpClients.createDefault();

            // 创建 POST 请求
            HttpPost httpPost = new HttpPost(url);

            // 定义表单参数
            List<NameValuePair> params = new ArrayList<>();
            params.add(new BasicNameValuePair("method", "sayHello"));
            params.add(new BasicNameValuePair("name", "张三"));
            params.add(new BasicNameValuePair("age", "25"));
            params.add(new BasicNameValuePair("id", "1"));

            // 设置请求体（表单参数）
            UrlEncodedFormEntity entity = new UrlEncodedFormEntity(params, "UTF-8");
            httpPost.setEntity(entity);

            // 设置请求头（可选）
            httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded");

            // 执行请求并获取响应
            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                System.out.println("状态码: " + statusCode);

                String responseBody = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("响应内容: " + responseBody);
            }

            // 关闭 HttpClient
            httpClient.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

说明

参数构造：使用 List<NameValuePair> 定义键值对形式的参数。
请求体：通过 UrlEncodedFormEntity 将参数编码为表单格式。
适用场景：适合简单的键值对参数，不支持复杂的嵌套结构。

两种方法的对比

特性	JSON 请求体	表单参数
数据格式	JSON（如 `{"key":"value"}`）	键值对（如 `key=value`）
复杂性	支持嵌套对象、数组等	仅支持简单键值对
Content-Type	`application/json`	`application/x-www-form-urlencoded`
RPC 适用性	更常用，灵活性高	较少用，适合简单场景

注意事项

服务端要求：确认你的 RPC 服务接受哪种参数格式（JSON 或表单），并相应调整代码。

参数动态化：在实际应用中，参数可能是动态生成的，可以从方法参数或对象中构建 JSON/表单数据。

例如，使用 JSONObject（如 Jackson 或 Gson）生成 JSON：

import com.fasterxml.jackson.databind.ObjectMapper;
ObjectMapper mapper = new ObjectMapper();
String jsonParams = mapper.writeValueAsString(new MyRpcRequest("sayHello", Map.of("name", "张三"), 1));