JAVA --- HttpClient

HttpClient 详细讲解

1.1 介绍

HttpClient 是 Apache Jakarta Common 下的子项目，提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议最新的版本和建议。

HttpClient 作用：

• 发送 HTTP 请求
• 接收响应数据

为什么要在 Java 程序中发送 HTTP 请求？
在现代应用开发中，很多功能（如扫描支付、查看地图、获取验证码、查看天气等）都是通过访问外部服务来实现的。这些服务通常通过 HTTP 协议提供，因此需要在应用程序中发送 HTTP 请求并接收响应数据。HttpClient 就是用来实现这一功能的工具。

HttpClient 应用场景：

• 扫描支付
• 查看地图
• 获取验证码
• 查看天气

HttpClient 的 Maven 坐标：

<dependency>
  <groupId>org.apache.httpcomponents</groupId>
  <artifactId>httpclient</artifactId>
  <version>4.5.13</version>
</dependency>

HttpClient 的核心 API：

• HttpClient：Http 客户端对象类型，使用该类型对象可发起 Http 请求。
• HttpClients：可认为是构建器，可创建 HttpClient 对象。
• CloseableHttpClient：实现类，实现了 HttpClient 接口。
• HttpGet：Get 方式请求类型。
• HttpPost：Post 方式请求类型。

HttpClient 发送请求步骤：

1. 创建 HttpClient 对象
2. 创建 Http 请求对象
3. 调用 HttpClient 的 execute 方法发送请求

1.2 入门案例

在了解了 HttpClient 的基本概念后，我们通过入门案例来学习如何使用 HttpClient 发送 GET 和 POST 请求。

1.2.1 GET 方式请求

实现步骤：

1. 创建 HttpClient 对象
2. 创建请求对象
3. 发送请求，接收响应结果
4. 解析结果
5. 关闭资源

代码示例：

package com.sky.test;

import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class HttpClientTest {

    /**
     * 测试通过 httpclient 发送 GET 方式的请求
     */
    @Test
    public void testGET() throws Exception {
        // 创建 httpclient 对象
        CloseableHttpClient httpClient = HttpClients.createDefault();

        // 创建请求对象
        HttpGet httpGet = new HttpGet("http://localhost:8080/user/shop/status");

        // 发送请求，接收响应结果
        CloseableHttpResponse response = httpClient.execute(httpGet);

        // 获取服务端返回的状态码
        int statusCode = response.getStatusLine().getStatusCode();
        System.out.println("服务端返回的状态码为：" + statusCode);

        HttpEntity entity = response.getEntity();
        String body = EntityUtils.toString(entity);
        System.out.println("服务端返回的数据为：" + body);

        // 关闭资源
        response.close();
        httpClient.close();
    }
}

测试结果：
在访问 http://localhost:8080/user/shop/status 请求时，需要提前启动项目。

1.2.2 POST 方式请求

实现步骤：

1. 创建 HttpClient 对象
2. 创建请求对象
3. 发送请求，接收响应结果
4. 解析响应结果
5. 关闭资源

代码示例：

package com.sky.test;

import org.apache.http.HttpEntity;
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 org.json.JSONObject;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class HttpClientTest {

    /**
     * 测试通过 httpclient 发送 POST 方式的请求
     */
    @Test
    public void testPOST() throws Exception {
        // 创建 httpclient 对象
        CloseableHttpClient httpClient = HttpClients.createDefault();

        // 创建请求对象
        HttpPost httpPost = new HttpPost("http://localhost:8080/admin/employee/login");

        JSONObject jsonObject = new JSONObject();
        jsonObject.put("username", "admin");
        jsonObject.put("password", "123456");

        StringEntity entity = new StringEntity(jsonObject.toString());
        // 指定请求编码方式
        entity.setContentEncoding("utf-8");
        // 数据格式
        entity.setContentType("application/json");
        httpPost.setEntity(entity);

        // 发送请求
        CloseableHttpResponse response = httpClient.execute(httpPost);

        // 解析返回结果
        int statusCode = response.getStatusLine().getStatusCode();
        System.out.println("响应码为：" + statusCode);

        HttpEntity entity1 = response.getEntity();
        String body = EntityUtils.toString(entity1);
        System.out.println("响应数据为：" + body);

        // 关闭资源
        response.close();
        httpClient.close();
    }
}

测试结果：
在访问 http://localhost:8080/admin/employee/login 请求时，需要提前启动项目。

拓展

1.3 HttpClient 高级用法

1.3.1 设置请求超时时间
在实际应用中，为了避免请求长时间阻塞，可以设置请求的超时时间。

代码示例：

import org.apache.http.client.config.RequestConfig;

RequestConfig requestConfig = RequestConfig.custom()
    .setConnectTimeout(5000) // 连接超时时间
    .setSocketTimeout(5000)  // 读取超时时间
    .build();

CloseableHttpClient httpClient = HttpClients.custom()
    .setDefaultRequestConfig(requestConfig)
    .build();

1.3.2 处理 Cookie
在某些场景下，需要处理 Cookie 以保持会话状态。

代码示例：

import org.apache.http.client.CookieStore;
import org.apache.http.impl.client.BasicCookieStore;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;

CookieStore cookieStore = new BasicCookieStore();
CloseableHttpClient httpClient = HttpClients.custom()
    .setDefaultCookieStore(cookieStore)
    .build();

1.3.3 处理代理
在需要通过代理访问网络时，可以设置代理服务器。

代码示例：

import org.apache.http.HttpHost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;

HttpHost proxy = new HttpHost("proxy.example.com", 8080);
CloseableHttpClient httpClient = HttpClients.custom()
    .setProxy(proxy)
    .build();

通过这些高级用法，可以更好地满足复杂的网络请求需求。

总结

HttpClient 是一个功能强大且灵活的 HTTP 客户端工具包，适用于各种需要与 HTTP 服务进行交互的场景。通过本文的讲解和示例代码，希望学生们能够掌握 HttpClient 的基本用法和一些高级技巧，从而在实际开发中更加得心应手。