Apache?HttpClient使用實(shí)例詳解

更新時(shí)間：2025年03月26日 09:28:25 作者：kmt-碼上解決

ApacheHttpClient是一個(gè)強(qiáng)大的Java?HTTP客戶端庫,用于發(fā)送HTTP請求并處理響應(yīng),HttpClients提供了多種方法來創(chuàng)建和配置HTTP客戶端實(shí)例,本文給大家介紹Apache?HttpClient使用示例詳解,感興趣的朋友一起看看吧

一、Apache HttpClient 基礎(chǔ)版

HttpClients 是 Apache HttpClient 庫中的一個(gè)工具類，用于創(chuàng)建和管理 HTTP 客戶端實(shí)例。Apache HttpClient 是一個(gè)強(qiáng)大的 Java HTTP 客戶端庫，用于發(fā)送 HTTP 請求并處理 HTTP 響應(yīng)。HttpClients 提供了多種方法來創(chuàng)建和配置 HTTP 客戶端實(shí)例。

以下是關(guān)于 HttpClients 的詳細(xì)講解：

1. Apache HttpClient 簡介

Apache HttpClient 是一個(gè)開源的 Java HTTP 客戶端庫，支持 HTTP/1.1 和 HTTP/2 協(xié)議。它提供了豐富的功能，例如：

發(fā)送 GET、POST、PUT、DELETE 等 HTTP 請求。
處理 HTTP 請求和響應(yīng)的頭部、狀態(tài)碼、實(shí)體等。
支持連接池、重試機(jī)制、代理、SSL/TLS 等高級功能。

2. HttpClients 類的作用

HttpClients 是一個(gè)工廠類，用于創(chuàng)建 CloseableHttpClient 實(shí)例。CloseableHttpClient 是 HTTP 客戶端的主要接口，用于執(zhí)行 HTTP 請求。

HttpClients 提供了多種靜態(tài)方法來創(chuàng)建和配置 HTTP 客戶端實(shí)例，例如：

創(chuàng)建默認(rèn)的 HTTP 客戶端。
創(chuàng)建自定義配置的 HTTP 客戶端。
創(chuàng)建支持連接池的 HTTP 客戶端。

3. HttpClients 的常用方法

(1) HttpClients.createDefault()

功能：創(chuàng)建一個(gè)默認(rèn)的 HTTP 客戶端實(shí)例。
特點(diǎn)：
- 使用默認(rèn)的配置（例如連接池、重試機(jī)制等）。
- 適合大多數(shù)簡單的 HTTP 請求場景。
示例：

CloseableHttpClient httpClient = HttpClients.createDefault();

(2) HttpClients.createSystem()

功能：創(chuàng)建一個(gè)基于系統(tǒng)屬性的 HTTP 客戶端實(shí)例。
特點(diǎn)：
- 使用系統(tǒng)屬性（例如代理設(shè)置、超時(shí)時(shí)間等）來配置客戶端。
- 適合需要與系統(tǒng)配置集成的場景。
示例：

CloseableHttpClient httpClient = HttpClients.createSystem();

(3) HttpClients.custom()

功能：返回一個(gè) HttpClientBuilder 對象，用于自定義配置 HTTP 客戶端。
特點(diǎn)：
- 可以設(shè)置連接池、超時(shí)時(shí)間、代理、SSL/TLS 等高級配置。
- 適合需要精細(xì)控制的場景。
示例：

 CloseableHttpClient httpClient = HttpClients.custom()
     .setMaxConnTotal(100) // 最大連接數(shù)
     .setMaxConnPerRoute(10) // 每個(gè)路由的最大連接數(shù)
     .build();

4. HttpClients 的使用示例

以下是一個(gè)完整的示例，展示如何使用 HttpClients 發(fā)送 HTTP GET 請求并處理響應(yīng)：

 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;
 ?
 public class HttpClientExample {
     public static void main(String[] args) {
         // 1. 創(chuàng)建 HTTP 客戶端
         try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
             // 2. 創(chuàng)建 HTTP GET 請求
             HttpGet request = new HttpGet("https://jsonplaceholder.typicode.com/posts/1");
 ?
             // 3. 發(fā)送請求并獲取響應(yīng)
             try (CloseableHttpResponse response = httpClient.execute(request)) {
                 // 4. 檢查響應(yīng)狀態(tài)碼
                 int statusCode = response.getStatusLine().getStatusCode();
                 System.out.println("Status Code: " + statusCode);
 ?
                 // 5. 獲取響應(yīng)內(nèi)容
                 String responseBody = EntityUtils.toString(response.getEntity());
                 System.out.println("Response Body: " + responseBody);
             }
         } catch (Exception e) {
             e.printStackTrace();
         }
     }
 }

5. HttpClients 的高級配置

通過 HttpClients.custom() 方法，可以自定義 HTTP 客戶端的配置。以下是一些常見的配置選項(xiàng)：

(1) 連接池配置

 CloseableHttpClient httpClient = HttpClients.custom()
     .setMaxConnTotal(100) // 最大連接數(shù)
     .setMaxConnPerRoute(10) // 每個(gè)路由的最大連接數(shù)
     .build();

(2) 超時(shí)配置

 RequestConfig requestConfig = RequestConfig.custom()
     .setConnectTimeout(5000) // 連接超時(shí)時(shí)間
     .setSocketTimeout(5000) // 讀取超時(shí)時(shí)間
     .build();
 ?
 CloseableHttpClient httpClient = HttpClients.custom()
     .setDefaultRequestConfig(requestConfig)
     .build();

(3) 代理配置

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

(4) SSL/TLS 配置

 SSLContext sslContext = SSLContexts.custom()
     .loadTrustMaterial((chain, authType) -> true) // 信任所有證書
     .build();
 ?
 CloseableHttpClient httpClient = HttpClients.custom()
     .setSSLContext(sslContext)
     .build();

6. 注意事項(xiàng)

資源釋放： CloseableHttpClient 和 CloseableHttpResponse 都實(shí)現(xiàn)了 Closeable 接口，使用后需要關(guān)閉以釋放資源。

線程安全： CloseableHttpClient 是線程安全的，可以在多線程環(huán)境中共享。

性能優(yōu)化：使用連接池和合理的超時(shí)配置可以顯著提升性能。

7. 總結(jié)

HttpClients 是 Apache HttpClient 庫中的一個(gè)工具類，用于創(chuàng)建和管理 HTTP 客戶端實(shí)例。
它提供了多種方法來創(chuàng)建默認(rèn)或自定義配置的 HTTP 客戶端。
通過 HttpClients.custom() 方法，可以實(shí)現(xiàn)連接池、超時(shí)、代理、SSL/TLS 等高級配置。
使用 Apache HttpClient 可以輕松發(fā)送 HTTP 請求并處理響應(yīng)，是 Java 中處理 HTTP 請求的強(qiáng)大工具。

二、Apache HttpClient 高級版

1. HttpClients 類概述

HttpClients 是 Apache HttpClient 庫中的一個(gè)工廠類，用于創(chuàng)建和配置 CloseableHttpClient 實(shí)例。它是構(gòu)建 HTTP 客戶端的入口點(diǎn)，支持高度自定義的 HTTP 請求處理，包括連接池管理、SSL/TLS 配置、重試機(jī)制等。

2. 核心方法與配置

2.1 創(chuàng)建默認(rèn)客戶端

CloseableHttpClient httpClient = HttpClients.createDefault();

特點(diǎn)：

使用默認(rèn)的配置（連接池、請求重試等）。
適合簡單場景，但擴(kuò)展性有限。

2.2 自定義配置客戶端

通過 HttpClients.custom() 返回 HttpClientBuilder，允許精細(xì)化配置：

 CloseableHttpClient httpClient = HttpClients.custom()
     .setConnectionManager(connectionManager)  // 連接池管理
     .setDefaultRequestConfig(requestConfig)   // 請求超時(shí)配置
     .setRetryHandler(retryHandler)            // 請求重試策略
     .setProxy(proxy)                          // 代理設(shè)置
     .setSSLContext(sslContext)                // SSL/TLS 配置
     .build();

3. 高級配置詳解

3.1 連接池管理

連接池是提升性能的關(guān)鍵組件，避免頻繁創(chuàng)建和銷毀連接。

 PoolingHttpClientConnectionManager connectionManager = 
     new PoolingHttpClientConnectionManager();
 connectionManager.setMaxTotal(200);          // 最大總連接數(shù)
 connectionManager.setDefaultMaxPerRoute(20); // 每個(gè)路由（目標(biāo)主機(jī)）的最大連接數(shù)
 ?
 CloseableHttpClient httpClient = HttpClients.custom()
     .setConnectionManager(connectionManager)
     .build();

3.2 超時(shí)配置

 RequestConfig requestConfig = RequestConfig.custom()
     .setConnectTimeout(5000)    // 連接建立超時(shí)時(shí)間（毫秒）
     .setSocketTimeout(10000)     // 數(shù)據(jù)傳輸超時(shí)時(shí)間（毫秒）
     .setConnectionRequestTimeout(2000) // 從連接池獲取連接的超時(shí)時(shí)間
     .build();
 ?
 CloseableHttpClient httpClient = HttpClients.custom()
     .setDefaultRequestConfig(requestConfig)
     .build();

3.3 重試機(jī)制

自動重試失敗的請求（例如網(wǎng)絡(luò)波動導(dǎo)致失敗）：

 HttpRequestRetryHandler retryHandler = (exception, executionCount, context) -> {
     if (executionCount >= 3) return false; // 最大重試次數(shù)
     if (exception instanceof NoHttpResponseException) return true; // 無響應(yīng)時(shí)重試
     return false;
 };
 ?
 CloseableHttpClient httpClient = HttpClients.custom()
     .setRetryHandler(retryHandler)
     .build();

3.4 代理配置

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

3.5 SSL/TLS 配置

信任所有證書（僅限測試環(huán)境）：

 SSLContext sslContext = SSLContexts.custom()
     .loadTrustMaterial((chain, authType) -> true) // 信任所有證書
     .build();
 ?
 CloseableHttpClient httpClient = HttpClients.custom()
     .setSSLContext(sslContext)
     .setSSLHostnameVerifier(NoopHostnameVerifier.INSTANCE) // 跳過主機(jī)名驗(yàn)證
     .build();

3.6 認(rèn)證機(jī)制

使用 Basic 認(rèn)證：

 CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
 credentialsProvider.setCredentials(
     new AuthScope("host.example.com", 80),
     new UsernamePasswordCredentials("user", "pass")
 );
 ?
 CloseableHttpClient httpClient = HttpClients.custom()
     .setDefaultCredentialsProvider(credentialsProvider)
     .build();

4. 請求與響應(yīng)處理

4.1 發(fā)送 GET 請求

 HttpGet httpGet = new HttpGet("https://api.example.com/data");
 try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
     int statusCode = response.getStatusLine().getStatusCode();
     HttpEntity entity = response.getEntity();
     String content = EntityUtils.toString(entity);
     EntityUtils.consume(entity); // 確保資源釋放
 }

4.2 發(fā)送 POST 請求（JSON 數(shù)據(jù)）

 HttpPost httpPost = new HttpPost("https://api.example.com/create");
 StringEntity jsonEntity = new StringEntity("{\"key\":\"value\"}", ContentType.APPLICATION_JSON);
 httpPost.setEntity(jsonEntity);
 ?
 try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
     // 處理響應(yīng)...
 }

4.3 文件上傳（Multipart）

 HttpPost httpPost = new HttpPost("https://api.example.com/upload");
 FileBody fileBody = new FileBody(new File("path/to/file"));
 MultipartEntityBuilder builder = MultipartEntityBuilder.create()
     .addPart("file", fileBody)
     .addTextBody("comment", "File upload");
 httpPost.setEntity(builder.build());

5. 高級功能

5.1 異步請求

使用 HttpAsyncClients 實(shí)現(xiàn)異步非阻塞請求：

 CloseableHttpAsyncClient asyncClient = HttpAsyncClients.custom().build();
 asyncClient.start();
 ?
 SimpleHttpRequest request = SimpleHttpRequest.get("https://api.example.com/data");
 Future<SimpleHttpResponse> future = asyncClient.execute(request, new FutureCallback<>() {
     @Override
     public void completed(SimpleHttpResponse response) {
         System.out.println("Response: " + response.getBodyText());
     }
 ?
     @Override
     public void failed(Exception ex) {
         ex.printStackTrace();
     }
 ?
     @Override
     public void cancelled() {
         System.out.println("Request cancelled");
     }
 });

5.2 請求攔截器

添加自定義邏輯（如日志記錄、修改請求頭）：

 CloseableHttpClient httpClient = HttpClients.custom()
     .addInterceptorFirst((HttpRequestInterceptor) (request, context) -> {
         request.addHeader("X-Custom-Header", "value");
         System.out.println("Request URI: " + request.getRequestLine().getUri());
     })
     .build();

5.3 Cookie 管理

自動管理 Cookie：

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

6. 最佳實(shí)踐與常見問題

6.1 資源釋放

確保關(guān)閉 CloseableHttpClient 和 CloseableHttpResponse：

 try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
     try (CloseableHttpResponse response = httpClient.execute(request)) {
         // 處理響應(yīng)...
     }
 }

6.2 性能調(diào)優(yōu)