如何使用Apache HttpClient发送带有基本认证的HTTP请求

Apache HttpClient 是一个多功能且强大的Java库，用于处理HTTP请求。

它支持多种认证机制，包括基本认证（Basic Authentication）。

基本认证是一种简单的认证方案，内置在HTTP协议中，使用用户名和密码来验证请求。

本教程将演示如何使用Apache HttpClient发送带有基本认证的HTTP请求。

Maven依赖

要使用Apache HttpClient，您需要在pom.xml文件中添加以下依赖项：

xml 复制代码

<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents.client5/httpclient5 -->
<dependency>
    <groupId>org.apache.httpcomponents.client5</groupId>
    <artifactId>httpclient5</artifactId>
    <version>5.3</version>
</dependency>

示例场景

我们将创建一个简单的Java类，该类向指定URL发送带有基本认证的GET请求，并打印响应。

用于测试的示例API

为了演示目的，我们将使用一个模拟的API端点，该端点要求基本认证。

但是，由于这是一个示例，您可以将URL、用户名和密码替换为任何支持基本认证的有效端点。

发送带有基本认证的HTTP请求的Java类

创建一个名为HttpClientBasicAuthExample的类，并使用以下代码：

java 复制代码

import org.apache.hc.client5.http.auth.Credentials;
import org.apache.hc.client5.http.auth.UsernamePasswordCredentials;
import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.classic.methods.CloseableHttpResponse;
import org.apache.hc.core5.http.io.entity.EntityUtils;

public class HttpClientBasicAuthExample {

    public static void main(String[] args) {
        String url = "https://httpbin.org/basic-auth/user/pass";
        String username = "user";
        String password = "pass";

        // 创建凭证提供者
        BasicCredentialsProvider credentialsProvider = new BasicCredentialsProvider();
        Credentials credentials = new UsernamePasswordCredentials(username, password.toCharArray());
        credentialsProvider.setCredentials(null, credentials);

        // 使用凭证提供者创建HttpClient
        try (CloseableHttpClient httpClient = HttpClients.custom()
                .setDefaultCredentialsProvider(credentialsProvider)
                .build()) {

            // 创建HttpGet请求
            HttpGet request = new HttpGet(url);

            // 执行请求
            try (CloseableHttpResponse response = httpClient.execute(request)) {

                // 获取HTTP响应状态
                System.out.println("Response Code: " + response.getCode());

                // 获取HTTP响应内容
                String content = EntityUtils.toString(response.getEntity());
                System.out.println("Response Content: \n" + content);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

解释

添加Maven依赖 ：org.apache.httpcomponents.client5:httpclient5 依赖提供了使用Apache HttpClient创建和执行HTTP请求所需的类。
创建凭证提供者 ：
- BasicCredentialsProvider credentialsProvider = new BasicCredentialsProvider(); 创建一个BasicCredentialsProvider实例，用于保存凭证。
- Credentials credentials = new UsernamePasswordCredentials(username, password.toCharArray()); 创建一个UsernamePasswordCredentials实例，包含指定的用户名和密码。
- credentialsProvider.setCredentials(null, credentials); 将凭证设置到凭证提供者中。
创建HttpClient ：
- CloseableHttpClient httpClient = HttpClients.custom().setDefaultCredentialsProvider(credentialsProvider).build(); 使用自定义配置和凭证提供者创建一个CloseableHttpClient实例。
创建HttpGet请求 ：
- HttpGet request = new HttpGet(url); 为指定URL创建一个HttpGet请求。
执行请求 ：
- try (CloseableHttpResponse response = httpClient.execute(request)) { ... } 执行GET请求并获取响应。
获取HTTP响应状态 ：
- System.out.println("Response Code: " + response.getCode()); 打印HTTP响应的状态码。
获取HTTP响应内容 ：
- String content = EntityUtils.toString(response.getEntity()); 将响应实体转换为字符串并打印内容。

运行示例

要运行示例，只需执行HttpClientBasicAuthExample类。您应该会在控制台看到状态码和响应内容。

示例输出

Response Code: 200
Response Content: 
{
  "authenticated": true,
  "user": "user"
}

额外配置

设置自定义头部 ：可以通过调用HttpGet对象上的setHeader方法来设置GET请求的自定义头部。
处理重定向 ：默认情况下，Apache HttpClient会自动处理重定向。您可以通过使用自定义的HttpClientBuilder来自定义这种行为。
设置超时 ：可以使用RequestConfig来设置连接和套接字超时。

结论

使用Apache HttpClient发送带有基本认证的HTTP请求非常方便。

遵循本教程后，您现在应该能够创建和执行带有基本认证的GET请求、处理响应，并定制HTTP请求和响应过程。

Apache HttpClient提供了一整套功能，使其成为处理Java应用程序中HTTP操作的优秀选择。