解決OkHttp接收gzip壓縮數據返回亂碼問題
問題
Retrofit 是現在最流行的網絡開發(fā)框架之一,功能十分強大,但是最近確遇到一個十分坑的問題,現在記錄下來,希望看到的人能注意下。
眾所周知,在 HTTP 傳輸時是支持 gzip 壓縮的,客戶端發(fā)起請求時在請求頭里增加 Accept-Encoding: gzip,服務端響應時在返回的頭信息里增加 Content-Encoding: gzip,這表示傳輸的數據是采用 gzip 壓縮的。默認情況下,傳輸內容是不壓縮的,采用 gzip 壓縮后可以大幅減少傳輸內容大小,這樣可以提高傳輸速度,減少流量的使用。
請求頭信息
本來 OkHttp 是默認支持 gzip 解壓縮的,不需要額外配置的。但是我在攔截器里統一添加了很多請求頭信息,大概代碼如下:
public class RequestInterceptor implements Interceptor {
public RequestInterceptor() {
}
@Override
public Response intercept(Chain chain) throws IOException {
Request.Builder builder = chain.request()
.newBuilder()
.addHeader("Accept", "application/json")
.addHeader("Accept-Encoding", "gzip");
Request request = builder.build();
return chain.proceed(request);
}
}
以前服務端沒有開啟 gzip 壓縮,一直都沒有問題,某天突然運維加了 gzip 壓縮,說是為了要省流量帶寬,結果就悲劇了,我們 Android APP 里所有的接口都報錯了,明明前一秒都是OK的,后一秒就都不能訪問了,但是 iOS 里卻能正常訪問,這是最令人崩潰的事情。
立即進行代碼調試,發(fā)現 Android 里的 http 請求返回的都是亂碼字符串了,其實這些都是 gzip 壓縮的數據,不是說 OkHttp 是自動支持 gzip 解壓縮的嗎?為什么我們的返回數據沒有進行 gzip 解壓?還有一個奇怪的現象是,當我把這段代碼 addHeader("Accept-Encoding", "gzip") 去掉之后,一切又恢復正常了。
BridgeInterceptor攔截器
這是一個很費解的問題,當我手動加上這個頭信息時,OkHttp 不會自動解壓 gzip 流,當我去掉時 OkHttp 又會自動解壓 gzip 流了,秉著刨根究底的精神我翻看了源碼,終于找到了原因。原來 OkHttp 在最終構建請求信息以及處理返回信息時,內部使用了一個叫做 BridgeInterceptor 的攔截器,該類的代碼如下:
public final class BridgeInterceptor implements Interceptor {
private final CookieJar cookieJar;
public BridgeInterceptor(CookieJar cookieJar) {
this.cookieJar = cookieJar;
}
@Override public Response intercept(Chain chain) throws IOException {
Request userRequest = chain.request();
Request.Builder requestBuilder = userRequest.newBuilder();
RequestBody body = userRequest.body();
if (body != null) {
MediaType contentType = body.contentType();
//自動增添加請求頭 Content-Type
if (contentType != null) {
requestBuilder.header("Content-Type", contentType.toString());
}
long contentLength = body.contentLength();
//如果傳輸長度不為-1,則表示完整傳輸
if (contentLength != -1) {
//設置頭信息 Content-Length
requestBuilder.header("Content-Length", Long.toString(contentLength));
requestBuilder.removeHeader("Transfer-Encoding");
} else {
//如果傳輸長度為-1,則表示分塊傳輸,自動設置頭信息
requestBuilder.header("Transfer-Encoding", "chunked");
requestBuilder.removeHeader("Content-Length");
}
}
if (userRequest.header("Host") == null) {
requestBuilder.header("Host", hostHeader(userRequest.url(), false));
}
//如果沒有設置頭信息 Connection,則自動設置為 Keep-Alive
if (userRequest.header("Connection") == null) {
requestBuilder.header("Connection", "Keep-Alive");
}
// If we add an "Accept-Encoding: gzip" header field we're responsible for also decompressing
// the transfer stream.
boolean transparentGzip = false;
if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
//如果我們沒有在請求頭信息里增加Accept-Encoding,在這里會自動設置頭信息 Accept-Encoding = gzip
transparentGzip = true;
requestBuilder.header("Accept-Encoding", "gzip");
}
List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
if (!cookies.isEmpty()) {
requestBuilder.header("Cookie", cookieHeader(cookies));
}
if (userRequest.header("User-Agent") == null) {
requestBuilder.header("User-Agent", Version.userAgent());
}
Response networkResponse = chain.proceed(requestBuilder.build());
HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());
Response.Builder responseBuilder = networkResponse.newBuilder()
.request(userRequest);
//如果返回的頭信息里Content-Encoding = gzip,并且我們沒有手動在請求頭信息里設置 Accept-Encoding = gzip,則會進行 gzip 解壓數據流
if (transparentGzip
&& "gzip".equalsIgnoreCase(networkResponse.header("Content-Encoding"))
&& HttpHeaders.hasBody(networkResponse)) {
GzipSource responseBody = new GzipSource(networkResponse.body().source());
Headers strippedHeaders = networkResponse.headers().newBuilder()
.removeAll("Content-Encoding")
.removeAll("Content-Length")
.build();
responseBuilder.headers(strippedHeaders);
String contentType = networkResponse.header("Content-Type");
responseBuilder.body(new RealResponseBody(contentType, -1L, Okio.buffer(responseBody)));
}
return responseBuilder.build();
}
}
上面代碼關鍵地方我做了注釋,OkHttp會額外的增加很多請求頭信息,如果我們在代碼里沒有手動設置Accept-Encoding = gzip,那么OkHttp會自動處理gzip的解壓縮;反之,你需要手動對返回的數據流進行gzip解壓縮。
以上就是我的代碼里 gzip 處理失敗的根本原因了,更多關于OkHttp接收gzip壓縮數據返回亂碼的資料請關注腳本之家其它相關文章!
相關文章
Java使用Knife4j優(yōu)化Swagger接口文檔的操作步驟
在現代微服務開發(fā)中,接口文檔的質量直接影響了前后端協作效率,Swagger 作為一個主流的接口文檔工具,雖然功能強大,但其默認界面和部分功能在實際使用中略顯不足,而 Knife4j 的出現為我們提供了一種增強的選擇,本篇文章將詳細介紹如何在項目中集成和使用 Knife4j2024-12-12
Springboot實現人臉識別與WebSocket長連接的實現代碼
這篇文章主要介紹了Springboot實現人臉識別與WebSocket長連接的實現,本文通過示例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友參考下吧2023-11-11

