JDK 內(nèi)置的 HttpRequest 有坑,請繞道!
最近,使用了 Java 11內(nèi)置的java.net.http.HttpRequest請求外部服務(wù),發(fā)現(xiàn)日志中出現(xiàn)了很多如下圖的錯誤:
這篇文章,我們就來分析如何排查和解決這種錯誤,以及分析下HttpRequest的工作原理。
排查過程:
遇到這種問題,首先google搜索下關(guān)鍵字:java.io.IOException: HTTP/1.1 header parser received no bytes
總結(jié)下 Google查詢的結(jié)果,可以得到兩個主要原因:
- 服務(wù)器返回空響應(yīng),導(dǎo)致解析 response異常
- 網(wǎng)絡(luò)問題
針對第一種情況,到下游服務(wù)查看日志發(fā)現(xiàn)請求根本沒有進(jìn)來,于是把原因定位到網(wǎng)絡(luò)問題。經(jīng)過多次的測試后發(fā)現(xiàn),錯誤是有規(guī)律性的出現(xiàn),多年工作經(jīng)驗的直覺告訴我,這種http請求,一定會復(fù)用連接,會不會復(fù)用了一個失效的鏈接,于是把問題再次縮小。
那么,JDK內(nèi)置的HttpRequest鏈接存活的時間是多久呢?
對,找官方資料,如下鏈接和圖片:
官方默認(rèn)的keepalive是1200s,是不是太大了,于是調(diào)整了 keepalive的時間,修改參數(shù)的方式:
# 方法1. 啟動指令中增加如下參數(shù)
-Djdk.httpclient.keepalive.timeout=10
# 方法2. 代碼中配置如下參數(shù)
System.setProperty("jdk.httpclient.keepalive.timeout", "10s");
很奇怪,為什么JDK沒有提供變量來設(shè)置這個參數(shù),而是作為JVM 系統(tǒng)屬性設(shè)置???不管怎樣,經(jīng)過一番驗證之后,問題解決。
所以,如果有使用 JDK內(nèi)置HttpRequest的小伙伴,一定要注意這個坑。
既然講到了HttpRequest,不如順道把它的工作原理也分析下。
一、 JDK 內(nèi)置 HttpRequest 的實現(xiàn)原理
1. 基礎(chǔ)架構(gòu)
JDK 內(nèi)置的 HTTP 客戶端基于異步非阻塞 I/O(NIO)設(shè)計,采用了事件驅(qū)動的架構(gòu)。這種設(shè)計使其能夠高效地處理大量并發(fā)連接,同時保持較低的資源消耗。HttpClient 是核心類,負(fù)責(zé)創(chuàng)建和配置 HTTP 請求,而 HttpRequest 則用于定義具體的請求細(xì)節(jié)。
2. 異步與同步請求
HttpClient 支持同步和異步兩種請求方式:
- 同步請求:調(diào)用 send 方法,線程會被阻塞直到服務(wù)器響應(yīng)返回。這種方式適用于簡單的請求場景,但在高并發(fā)環(huán)境下可能導(dǎo)致線程阻塞問題。
- 異步請求:調(diào)用 sendAsync 方法,返回一個 CompletableFuture 對象,允許在請求進(jìn)行時執(zhí)行其他操作,提升應(yīng)用的響應(yīng)性和吞吐量。
3. 支持的協(xié)議
內(nèi)置 HTTP 客戶端支持 HTTP/1.1 和 HTTP/2 協(xié)議。HTTP/2 的引入帶來了多路復(fù)用、頭部壓縮和服務(wù)器推送等特性,顯著提升了傳輸效率??蛻舳藭鶕?jù)服務(wù)器支持的協(xié)議自動選擇最優(yōu)協(xié)議,確保最佳的傳輸性能。
4. 連接管理
HttpClient 內(nèi)部維護(hù)著連接池,自動管理 HTTP 連接的復(fù)用和關(guān)閉。通過連接池機制,可以避免頻繁建立和關(guān)閉連接帶來的性能損耗。連接池根據(jù)請求的目標(biāo)主機和協(xié)議進(jìn)行分類管理,確保高效的資源利用。
5. 安全與認(rèn)證
內(nèi)置客戶端提供豐富的安全特性,包括 SSL/TLS 支持、證書驗證和多種認(rèn)證機制(如 Basic、Digest、Bearer 認(rèn)證等)。開發(fā)者可以通過配置 SSLContext 和相關(guān)認(rèn)證信息,確保請求的安全性。
6. 中間件與過濾器
HttpClient 允許開發(fā)者添加自定義的過濾器和攔截器,對請求和響應(yīng)進(jìn)行預(yù)處理和后處理。這為實現(xiàn)日志記錄、請求重試、錯誤處理等功能提供了靈活的擴(kuò)展點。
二、優(yōu)缺點
1. 優(yōu)點
- 簡化的 API:相比于傳統(tǒng)的 HttpURLConnection,HttpClient 提供了更現(xiàn)代化和簡潔的 API,降低了使用難度和代碼復(fù)雜度。
- 異步支持:內(nèi)置的異步請求機制允許更高效地處理并發(fā)請求,提升了應(yīng)用的性能和響應(yīng)性。
- 協(xié)議支持:自動支持 HTTP/2,使得應(yīng)用能夠利用更高效的傳輸協(xié)議,無需額外配置。
- 內(nèi)置安全特性:豐富的安全配置選項讓開發(fā)者能夠輕松地實現(xiàn)安全的網(wǎng)絡(luò)通信,包括 SSL/TLS 和多種認(rèn)證方式。
- 連接池管理:自動的連接池管理減少了資源管理的負(fù)擔(dān),提升了連接的復(fù)用性和整體性能。
- 跨平臺一致性:作為 JDK 的一部分,HttpClient 在不同操作系統(tǒng)和環(huán)境下表現(xiàn)一致,減少了跨平臺開發(fā)的難度。
2. 缺點
- 功能限制:雖然 HttpClient 覆蓋了大多數(shù)常見的 HTTP 功能,但在某些高級用例下,可能缺乏第三方庫(如 Apache HttpClient 或 OkHttp)提供的特定功能。
- 版本依賴:HttpClient 是從 Java 11 開始引入的,對于使用更早版本 JDK 的項目,需要依賴外部庫來實現(xiàn)相似功能。
- 社區(qū)和生態(tài):相比于成熟的第三方 HTTP 客戶端,JDK 內(nèi)置的 HttpClient 在社區(qū)支持和生態(tài)上仍有待發(fā)展,可能缺乏某些特定場景下的最佳實踐和解決方案。
- 性能優(yōu)化:盡管 HttpClient 已經(jīng)具備良好的性能,但在極端高并發(fā)或特定優(yōu)化需求下,可能無法完全滿足專業(yè)級別的性能調(diào)優(yōu)需求。
三、核心參數(shù)
在使用 HttpRequest 時,開發(fā)者需要配置多個參數(shù)以定義請求的行為和特性。以下是一些核心參數(shù)及其說明:
1. 請求 URI
每個 HTTP 請求都需要一個目標(biāo) URI,指定資源的位置。例如:
URI uri = URI.create("https://api.example.com/data");
HttpRequest request = HttpRequest.newBuilder()
.uri(uri)
.build();
2. HTTP 方法
HttpRequest 支持常見的 HTTP 方法,如 GET、POST、PUT、DELETE 等??梢酝ㄟ^ method 方法或?qū)iT的快捷方法設(shè)置:
// 使用快捷方法設(shè)置 GET 請求
HttpRequest getRequest = HttpRequest.newBuilder()
.uri(uri)
.GET()
.build();
// 使用 method 方法設(shè)置 POST 請求
HttpRequest postRequest = HttpRequest.newBuilder()
.uri(uri)
.method("POST", HttpRequest.BodyPublishers.ofString("request body"))
.build();
3. 請求頭
可以通過 headers 方法添加一個或多個請求頭,或使用 header 方法逐個添加:
HttpRequest request = HttpRequest.newBuilder()
.uri(uri)
.header("Content-Type", "application/json")
.header("Authorization", "Bearer token")
.GET()
.build();
4. 請求體
對于需要發(fā)送數(shù)據(jù)的請求(如 POST、PUT),需要配置請求體。HttpRequest.BodyPublisher 提供多種數(shù)據(jù)發(fā)布方式:
HttpRequest postRequest = HttpRequest.newBuilder()
.uri(uri)
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString("{\"key\":\"value\"}"))
.build();
支持的 BodyPublisher 包括:
- ofString(String): 發(fā)送字符串?dāng)?shù)據(jù)
- ofFile(Path): 發(fā)送文件內(nèi)容
- ofByteArray(byte[]): 發(fā)送字節(jié)數(shù)組
- noBody(): 無請求體(適用于 GET 請求)
5. 超時設(shè)置
可以為請求設(shè)置超時時間,防止請求長時間掛起:
HttpRequest request = HttpRequest.newBuilder()
.uri(uri)
.timeout(Duration.ofSeconds(10))
.GET()
.build();
6. 重定向策略
通過 HttpClient 的構(gòu)建器可以設(shè)置重定向的策略,如跟隨重定向、禁止重定向等:
HttpClient client = HttpClient.newBuilder()
.followRedirects(HttpClient.Redirect.NORMAL)
.build();
7. 優(yōu)先級
可以為請求設(shè)置優(yōu)先級,影響請求的調(diào)度順序:
HttpRequest request = HttpRequest.newBuilder()
.uri(uri)
.priority(10)
.GET()
.build();
優(yōu)先級值越高,表示請求越重要。
8. 版本協(xié)議
可以指定使用的 HTTP 版本,如 HTTP/1.1 或 HTTP/2:
HttpRequest request = HttpRequest.newBuilder()
.uri(uri)
.version(HttpClient.Version.HTTP_2)
.GET()
.build();
9. 代理設(shè)置
HttpClient 支持通過代理服務(wù)器發(fā)送請求,可以在 HttpClient 構(gòu)建器中配置:
HttpClient client = HttpClient.newBuilder()
.proxy(ProxySelector.of(new InetSocketAddress("proxy.example.com", 8080)))
.build();
10. 身份認(rèn)證
通過 Authenticator 配置認(rèn)證信息,以便客戶端在需要時自動提供認(rèn)證憑證:
Authenticator authenticator = new Authenticator() {
@Override
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("user", "password".toCharArray());
}
};
HttpClient client = HttpClient.newBuilder()
.authenticator(authenticator)
.build();
四、示例分析
為了更好地理解 HttpRequest 的使用,這里提供一個簡單的示例:發(fā)送一個 POST 請求,并異步處理響應(yīng)。
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
publicclass HttpClientExample {
public static void main(String[] args) {
// 創(chuàng)建 HttpClient 實例,配置超時和重定向策略
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.followRedirects(HttpClient.Redirect.NORMAL)
.build();
// 構(gòu)建 POST 請求,設(shè)置 URI、請求頭和請求體
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.example.com/data"))
.header("Content-Type", "application/json")
.timeout(Duration.ofSeconds(5))
.POST(HttpRequest.BodyPublishers.ofString("{\"name\":\"John Doe\",\"age\":30}"))
.build();
// 發(fā)送異步請求,并處理響應(yīng)
client.sendAsync(request, HttpResponse.BodyHandlers.ofString())
.thenApply(HttpResponse::body)
.thenAccept(responseBody -> {
System.out.println("Response received:");
System.out.println(responseBody);
})
.exceptionally(e -> {
System.err.println("Request failed: " + e.getMessage());
returnnull;
});
// 防止主線程提前退出
try {
Thread.sleep(6000);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
代碼解析:
- HttpClient 創(chuàng)建:通過 HttpClient.newBuilder() 創(chuàng)建一個 HttpClient 實例,配置了連接超時和自動跟隨標(biāo)準(zhǔn)重定向。
- HttpRequest 構(gòu)建:定義了一個 POST 請求,目標(biāo) URI 為 https://api.example.com/data,設(shè)置了 Content-Type 請求頭,并通過 BodyPublishers.ofString 發(fā)送 JSON 格式的請求體。
- 發(fā)送異步請求:調(diào)用 sendAsync 方法發(fā)送請求,指定響應(yīng)體處理器為 ofString,即將響應(yīng)體轉(zhuǎn)換為字符串。
- 處理響應(yīng):使用 thenApply 和 thenAccept 鏈?zhǔn)秸{(diào)用處理響應(yīng)體,打印到控制臺。如果請求失敗,通過 exceptionally 捕獲并打印錯誤信息。
- 主線程等待:由于請求是異步發(fā)送的,主線程需要等待一段時間以確保響應(yīng)能夠處理。實際應(yīng)用中,可以使用更優(yōu)雅的方式管理線程同步。
五、總結(jié)
本文,我們從使用 JDK內(nèi)置的HttpRequest遇到的坑以及如何解決它,到工作原理的分析,HttpRequest為 Java 開發(fā)者提供了一個強大且易用的 HTTP 客戶端工具。但是,相比于一些成熟的第三方庫(比如 Apache HttpClient)還是稍顯不足。
因此,在使用一個工具或者框架時,最好能先了解其實現(xiàn)原理、優(yōu)缺點等,可以做到提前避免出現(xiàn)上面類似的問題,或者出現(xiàn)問題時能快速定位和解決問題。