HttpClient的快速上手

John Song

已于 2024-08-09 13:25:25 修改

阅读量362

点赞数 3

分类专栏： java 文章标签： java http 后端

于 2024-08-09 11:39:46 首次发布

本文链接：https://blog.csdn.net/qq_43775642/article/details/141057663

版权

java 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

Apache HttpClient 是一个功能强大且灵活的HTTP客户端库，广泛用于Java应用程序中进行HTTP请求和响应处理。要快速熟练地使用它，理解其整体架构和常用组件非常重要。

一、HttpClient的整体架构

HttpClient的整体架构可以分为以下几个主要部分：

核心组件：
- HttpClient: 这是核心接口，负责发起HTTP请求和处理响应。通过HttpClientBuilder来构建实例。
- HttpRequest: 表示一个HTTP请求，可以是HttpGet、HttpPost等。
- HttpResponse: 表示HTTP响应，包含状态码、响应头、响应体等信息。
- HttpEntity: 用于封装HTTP请求和响应的实体内容，比如表单数据、文件上传、JSON数据等。
连接管理：
- HttpClientConnectionManager: 负责管理HTTP连接的生命周期，处理连接的复用和释放。
- PoolingHttpClientConnectionManager: 常用的连接管理器，支持连接池和多线程场景下的连接复用。
请求执行链：
- HttpRequestExecutor: 负责执行HTTP请求。
- HttpContext: 用于在请求执行过程中存储共享数据。
请求配置：
- RequestConfig: 配置请求的各种参数，如超时时间、重试策略、代理设置等。
- CookieStore: 管理HTTP请求中的Cookie信息。
拦截器：
- HttpRequestInterceptor: 在请求发送之前执行自定义逻辑。
- HttpResponseInterceptor: 在响应到达之后执行自定义逻辑。
重试和异常处理：
- HttpRequestRetryHandler: 控制失败请求的重试逻辑。
- ServiceUnavailableRetryStrategy: 处理503 Service Unavailable响应的重试逻辑。

二、快速熟练使用的方法

理解基本用法：
- 了解如何发起基本的GET和POST请求，并处理响应数据。先从简单的例子入手。
- 熟悉HttpClient的生命周期和如何通过HttpClientBuilder来构建客户端。
掌握核心组件：
- 重点学习HttpClient、HttpRequest、HttpResponse、HttpEntity等核心组件的使用。
- 理解如何配置RequestConfig，如设置超时、代理、重试策略等。
连接管理：
- 学习如何使用PoolingHttpClientConnectionManager来管理连接池，理解连接复用的原理。
- 了解如何根据应用场景优化连接管理器的配置。
请求拦截和日志记录：
- 掌握如何通过HttpRequestInterceptor和HttpResponseInterceptor来实现请求和响应的拦截，用于日志记录、认证等目的。
异常处理和重试机制：
- 了解HttpRequestRetryHandler的用法，学习如何定制重试策略。
- 处理常见异常场景，如连接超时、网络中断等。
使用高级特性：
- 了解如何处理多部分表单数据上传（MultipartEntityBuilder），如何进行流式处理大文件的上传和下载。
- 探索异步HTTP请求的处理（使用HttpAsyncClient）。
阅读官方文档和示例代码：
- 官方文档和示例代码是最好的学习资源。通过阅读官方文档，可以深入理解各个组件的用法和设计意图。
- 通过实践官方示例代码，逐步掌握复杂场景下的使用方法。

一、HttpClient的生命周期

Apache HttpClient的生命周期主要涉及以下几个阶段：

创建：
- HttpClient对象是通过HttpClientBuilder来创建的。这是HttpClient的起始点，定义了所有的配置，如连接管理器、请求重试策略、超时设置等。
- 创建完成后，HttpClient对象可以复用，用来发起多次HTTP请求。
配置：
- 在创建阶段，可以配置HttpClient的各种参数，如连接池大小、超时设置、重试策略、代理设置等。
- 配置完毕后，HttpClient的行为就固定下来了，不建议在之后修改配置。
请求执行：
- HttpClient在发起HTTP请求时会执行内部的请求处理链，包括执行拦截器、处理请求、处理响应等。
- 请求发出后，HttpClient会通过HttpClientConnectionManager来管理连接的使用、复用和释放。
连接管理：
- HttpClient通过连接管理器来管理HTTP连接的生命周期。连接管理器负责连接的复用、最大并发连接数控制、连接的回收与释放。
- 连接管理器通常会复用连接来提高性能，避免频繁创建和关闭连接带来的开销。
关闭：
- 当不再需要使用HttpClient时，需要显式地关闭它以释放资源，特别是连接池中的连接。
- HttpClient的close()方法可以关闭所有资源，确保应用程序不会出现资源泄漏。

二、如何通过HttpClientBuilder构建客户端

HttpClientBuilder是构建HttpClient实例的核心工具，通过它可以灵活配置HttpClient的各个方面。以下是构建HttpClient的详细步骤：

1. 创建HttpClientBuilder实例

首先，创建一个HttpClientBuilder实例。这是构建过程的起点。

HttpClientBuilder builder = HttpClients.custom();

2. 配置连接管理器

连接管理器负责管理HTTP连接的生命周期。通常使用PoolingHttpClientConnectionManager来管理连接池。

PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
connectionManager.setMaxTotal(100); // 设置最大连接数
connectionManager.setDefaultMaxPerRoute(10); // 设置每个路由的最大连接数
builder.setConnectionManager(connectionManager);

3. 配置请求参数

你可以配置各种请求参数，如连接超时、套接字超时、连接请求超时等。

RequestConfig requestConfig = RequestConfig.custom()
    .setConnectTimeout(5000) // 连接超时时间
    .setSocketTimeout(5000) // 套接字超时时间
    .setConnectionRequestTimeout(5000) // 连接请求超时时间
    .build();
builder.setDefaultRequestConfig(requestConfig);

4. 配置重试策略

可以通过设置重试处理器来配置请求失败时的重试策略。

HttpRequestRetryHandler retryHandler = new DefaultHttpRequestRetryHandler(3, true);
builder.setRetryHandler(retryHandler);

5. 配置拦截器

可以添加请求和响应的拦截器，在请求发出前或响应返回后执行自定义逻辑。

builder.addInterceptorFirst((HttpRequestInterceptor) (request, context) -> {
    System.out.println("Request Interceptor: " + request.getRequestLine());
});

builder.addInterceptorFirst((HttpResponseInterceptor) (response, context) -> {
    System.out.println("Response Interceptor: " + response.getStatusLine());
});

6. 构建HttpClient实例

在完成所有配置后，通过builder.build()方法来构建HttpClient实例。

CloseableHttpClient httpClient = builder.build();

7. 使用HttpClient执行请求

构建好HttpClient之后，可以用它来执行HTTP请求。

HttpGet httpGet = new HttpGet("http://example.com");
try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
    System.out.println(EntityUtils.toString(response.getEntity()));
}