Java API 开发中使用 Apache HttpClient 进行 HTTP 请求

随着互联网的不断发展，HTTP 协议已经成为了现代网络通信的基石之一。在 Java 编程中，通过使用 Apache HttpClient 库，可以非常方便地进行 HTTP 请求操作。本文将介绍如何在 Java API 开发中使用 Apache HttpClient 进行 HTTP 请求。

1. 准备工作

在开始之前，需要先下载 Apache HttpClient 库，并将其添加为项目的依赖。Apache HttpClient 是一款开源的 Java HTTP 客户端库，可以通过 Maven、Gradle 等工具进行引用。

下面是使用 Maven 引用 Apache HttpClient 的例子：

    
        org.apache.httpcomponents
        httpclient
        4.5.13
    

引入库之后，就可以开始进行 HTTP 请求操作了。

2. 发送 GET 请求

使用 HttpClient 发送 GET 请求非常简单。下面是一个示例，演示了如何通过 HttpClient 发送 GET 请求，并打印出响应内容：

CloseableHttpClient httpClient = HttpClients.createDefault();
HttpGet httpGet = new HttpGet("https://www.baidu.com");
try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
    HttpEntity entity = response.getEntity();
    if (entity != null) {
        String result = EntityUtils.toString(entity, "UTF-8");
        System.out.println(result);
    }
} catch (IOException e) {
    e.printStackTrace();
}

以上代码会发送一个 GET 请求到百度，然后将响应内容输出。在这段代码中，我们创建了一个 CloseableHttpClient 客户端实例，然后使用 HttpGet 对象创建了一个 GET 请求，并执行该请求。在响应中获取到了实体，然后将实体转换成字符串输出。

3. 发送 POST 请求

在使用 HttpClient 发送 POST 请求时，可以选择使用 UrlEncodedFormEntity 对象或 MultipartEntityBuilder 对象来包含请求参数。

下面是一个使用 UrlEncodedFormEntity 对象的示例：

CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost httpPost = new HttpPost("https://www.baidu.com");
List params = new ArrayList<>();
params.add(new BasicNameValuePair("username", "johndoe"));
params.add(new BasicNameValuePair("password", "password123"));
try {
    httpPost.setEntity(new UrlEncodedFormEntity(params, "UTF-8"));
} catch (UnsupportedEncodingException e) {
    e.printStackTrace();
}
try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
    HttpEntity entity = response.getEntity();
    if (entity != null) {
        String result = EntityUtils.toString(entity, "UTF-8");
        System.out.println(result);
    }
} catch (IOException e) {
    e.printStackTrace();
}

以上代码会向百度发送一个 POST 请求，并将参数包含在请求体中。在这个示例中，我们使用了 UrlEncodedFormEntity 对象来包含请求参数，并将其设置为 POST 请求的实体。在响应中获取到了实体，然后将实体转换成字符串输出。

4. 发送文件

需要发送文件时，应该使用 MultipartEntityBuilder 对象。下面是一个包含文件的示例：

CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost httpPost = new HttpPost("http://localhost:8080/upload");
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.addBinaryBody("file", new File("example.txt"));
httpPost.setEntity(builder.build());
try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
    HttpEntity entity = response.getEntity();
    if (entity != null) {
        String result = EntityUtils.toString(entity, "UTF-8");
        System.out.println(result);
    }
} catch (IOException e) {
    e.printStackTrace();
}

以上代码会向 localhost:8080 传输一个名为 example.txt 的文件。在这个示例中，我们使用了 MultipartEntityBuilder 对象，并将文件添加为二进制内容。在响应中获取到了实体，然后将实体转换成字符串输出。

5. 发送请求时加上头部信息

有时，我们需要在请求中添加头部信息。下面是一个添加头部信息的示例：

CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost httpPost = new HttpPost("https://www.baidu.com");
httpPost.setHeader("User-Agent", "Mozilla/5.0");
try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
    HttpEntity entity = response.getEntity();
    if (entity != null) {
        String result = EntityUtils.toString(entity, "UTF-8");
        System.out.println(result);
    }
} catch (IOException e) {
    e.printStackTrace();
}

以上代码会向百度发送一个 GET 请求并添加一个 User-Agent 头部信息。在这个示例中，我们使用了 HttpPost 对象来创建一个 GET 请求，并调用 setHeader 方法来添加头部信息。在响应中获取到了实体，然后将实体转换成字符串输出。

6. 发送请求时设置超时时间

在发送请求时，还可以设置请求超时时间和响应超时时间。这可以防止客户端在等待服务器响应时无限制地阻塞。下面是一个设置超时时间的示例：

CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost httpPost = new HttpPost("https://www.baidu.com");
RequestConfig requestConfig = RequestConfig.custom()
    .setConnectTimeout(5000) // 连接超时时间
    .setSocketTimeout(5000) // 响应超时时间
    .build();
httpPost.setConfig(requestConfig);
try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
    HttpEntity entity = response.getEntity();
    if (entity != null) {
        String result = EntityUtils.toString(entity, "UTF-8");
        System.out.println(result);    
    }
} catch (IOException e) {
    e.printStackTrace();
}

以上代码会向百度发送一个 POST 请求，并设置了连接超时时间和响应超时时间为 5 秒。在这个示例中，我们使用了 RequestConfig 对象，并通过 custom 方法设置了连接超时时间和响应超时时间。在响应中获取到了实体，然后将实体转换成字符串输出。

7. 总结

Apache HttpClient 库提供了很多方便的 API，可以让 Java 开发人员非常容易地执行 HTTP 请求。本文介绍了如何使用 Apache HttpClient 发送 GET 请求、POST 请求、包含文件的请求、添加头部信息的请求、设置超时时间的请求。希望本文可以对使用 Apache HttpClient 的 Java 开发人员提供一些帮助。