系列文章
OKHttp原始碼解析(2)----攔截器RetryAndFollowUpInterceptor
OKHttp原始碼解析(3)----攔截器BridgeInterceptor
OKHttp原始碼解析(4)----攔截器CacheInterceptor
OKHttp原始碼解析(5)----攔截器ConnectInterceptor
OKHttp原始碼解析(6)----攔截器CallServerInterceptor
1.簡介
Bridges from application code to network code. First it builds a network request from a user request. Then it proceeds to call the network. Finally it builds a user response from the network response.
橋接攔截器(內容攔截器),負責把使用者構造的請求轉換為傳送到伺服器的請求、把伺服器返回的響應轉換為使用者友好的響應。
2.原始碼解析
@Override public Response intercept(Chain chain) throws IOException {
// 將使用者友好的 request 構造為傳送給伺服器的 request
Request userRequest = chain.request();
Request.Builder requestBuilder = userRequest.newBuilder();
RequestBody body = userRequest.body();
// 若有請求體,則構造
if (body != null) {
MediaType contentType = body.contentType();
if (contentType != null) {
requestBuilder.header("Content-Type", contentType.toString());
}
long contentLength = body.contentLength();
if (contentLength != -1) {
requestBuilder.header("Content-Length", Long.toString(contentLength));
requestBuilder.removeHeader("Transfer-Encoding");
} else {
requestBuilder.header("Transfer-Encoding", "chunked");
requestBuilder.removeHeader("Content-Length");
}
}
if (userRequest.header("Host") == null) {
requestBuilder.header("Host", hostHeader(userRequest.url(), false));
}
if (userRequest.header("Connection") == null) {
requestBuilder.header("Connection", "Keep-Alive");
}
// If we add an "Accept-Encoding: gzip" header field we are responsible for also decompressing
// the transfer stream.
boolean transparentGzip = false;
if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
transparentGzip = true;
requestBuilder.header("Accept-Encoding", "gzip");
}
// 設定 cookie
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());
}
// 構造完後,將 request 交給下一個攔截器去處理。最後又得到服務端響應 networkResponse
Response networkResponse = chain.proceed(requestBuilder.build());
// 儲存 networkResponse 的 cookie
HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());
// 將 networkResponse 構造為對使用者友好的 response
Response.Builder responseBuilder = networkResponse.newBuilder()
.request(userRequest);
// 如果 networkResponse 使用 gzip 並且有響應體的話,給使用者友好的 response 設定響應體
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);
responseBuilder.body(new RealResponseBody(strippedHeaders, Okio.buffer(responseBody)));
}
return responseBuilder.build();
}
複製程式碼
從原始碼中可以看出,攔截器BridgeInterceptor主要做了兩件事:請求頭和響應的處理:
- 請求頭的處理: 拿到使用者的請求requestBuilder,對請求中的請求頭資訊進行補全,如Content-Type、Content-Length、Transfer-Encoding、Host、Connection、Accept-Encoding、Cookie和User-Agent
- 響應: 得到響應後,將請求的request放到響應中,如果響應使用gzip編碼並且有響應體的話,給使用者友好的 response設定響應體
附加:
http請求頭:
Header | 解釋 | 示例 |
---|---|---|
Accept | 指定客戶端能夠接收的內容型別 | Accept: text/plain, text/html,application/json |
Accept-Charset | 瀏覽器可以接受的字元編碼集。 | Accept-Charset: iso-8859-5 |
Accept-Encoding | 指定瀏覽器可以支援的web伺服器返回內容壓縮編碼型別。 | Accept-Encoding: compress, gzip |
Accept-Language | 瀏覽器可接受的語言 | Accept-Language: en,zh |
Accept-Ranges | 可以請求網頁實體的一個或者多個子範圍欄位 | Accept-Ranges: bytes |
Authorization | HTTP授權的授權證書 | Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
Cache-Control | 指定請求和響應遵循的快取機制 | Cache-Control: no-cache |
Connection | 表示是否需要持久連線。(HTTP 1.1預設進行持久連線) | Connection: close |
Cookie | HTTP請求傳送時,會把儲存在該請求域名下的所有cookie值一起傳送給web伺服器。 | Cookie: $Version=1; Skin=new; |
Content-Length | 請求的內容長度 | Content-Length: 348 |
Content-Type | 請求的與實體對應的MIME資訊 | Content-Type: application/x-www-form-urlencoded |
Date | 請求傳送的日期和時間 | Date: Tue, 15 Nov 2010 08:12:31 GMT |
Expect | 請求的特定的伺服器行為 | Expect: 100-continue |
From | 發出請求的使用者的Email | From: user@email.com |
Host | 指定請求的伺服器的域名和埠號 | Host: www.zcmhi.com |
If-Match | 只有請求內容與實體相匹配才有效 | If-Match: “737060cd8c284d8af7ad3082f209582d” |
If-Modified-Since | 如果請求的部分在指定時間之後被修改則請求成功,未被修改則返回304程式碼 | If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMT |
If-None-Match | 如果內容未改變返回304程式碼,引數為伺服器先前傳送的Etag,與伺服器回應的Etag比較判斷是否改變 | If-None-Match: “737060cd8c284d8af7ad3082f209582d” |
If-Range | 如果實體未改變,伺服器傳送客戶端丟失的部分,否則傳送整個實體。引數也為Etag | If-Range: “737060cd8c284d8af7ad3082f209582d” |
If-Unmodified-Since | 只在實體在指定時間之後未被修改才請求成功 | If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT |
Max-Forwards | 限制資訊通過代理和閘道器傳送的時間 | Max-Forwards: 10 |
Pragma | 用來包含實現特定的指令 | Pragma: no-cache |
Proxy-Authorization | 連線到代理的授權證書 | Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
Range | 只請求實體的一部分,指定範圍 | Range: bytes=500-999 |
Referer | 先前網頁的地址,當前請求網頁緊隨其後,即來路 | Referer: www.zcmhi.com/archives... |
TE | 客戶端願意接受的傳輸編碼,並通知伺服器接受接受尾加頭資訊 | TE: trailers,deflate;q=0.5 |
Upgrade | 向伺服器指定某種傳輸協議以便伺服器進行轉換(如果支援) | Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11 |
User-Agent | User-Agent的內容包含發出請求的使用者資訊 | User-Agent: Mozilla/5.0 (Linux; X11) |
Via | 通知中間閘道器或代理伺服器地址,通訊協議 | Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1) |
Warning | 關於訊息實體的警告資訊 | Warn: 199 Miscellaneous warning |
Http響應頭
響應頭 | 說明 | 示例 | 狀態 |
---|---|---|---|
Access-Control-Allow-Origin | 指定哪些網站可以跨域源資源共享 | Access-Control-Allow-Origin: * | 臨時 |
Accept-Patch | 指定伺服器所支援的文件補丁格式 | Accept-Patch: text/example;charset=utf-8 | 固定 |
Accept-Ranges | 伺服器所支援的內容範圍 | Accept-Ranges: bytes | 固定 |
Age | 響應物件在代理快取中存在的時間,以秒為單位 | Age: 12 | 固定 |
Allow | 對於特定資源的有效動作; | Allow: GET, HEAD | 固定 |
Cache-Control | 通知從伺服器到客戶端內的所有快取機制,表示它們是否可以快取這個物件及快取有效時間。其單位為秒 | Cache-Control: max-age=3600 | 固定 |
Connection | 針對該連線所預期的選項 | Connection: close | 固定 |
Content-Disposition | 對已知MIME型別資源的描述,瀏覽器可以根據這個響應頭決定是對返回資源的動作,如:將其下載或是開啟。 | Content-Disposition: attachment; filename="fname.ext" | 固定 |
Content-Encoding | 響應資源所使用的編碼型別。 Content-Encoding: gzip | 固定 | |
Content-Language | 響就內容所使用的語言 Content-Language: zh-cn | 固定 | |
Content-Length | 響應訊息體的長度,用8進位制位元組表示 Content-Length: 348 | 固定 | |
Content-Location | 所返回的資料的一個候選位置 Content-Location: /index.htm | 固定 | |
Content-MD5 | 響應內容的二進位制 MD5 雜湊值,以 Base64 方式編碼 | Content-MD5: IDK0iSsgSW50ZWd0DiJUi== 已淘汰 | |
Content-Range | 如果是響應部分訊息,表示屬於完整訊息的哪個部分 | Content-Range: bytes 21010-47021/47022 固定 | |
Content-Type | 當前內容的MIME型別 | Content-Type: text/html; charset=utf-8 | 固定 |
Date | 此條訊息被髮送時的日期和時間(以RFC 7231中定義的"HTTP日期"格式來表示) | Date: Tue, 15 Nov 1994 08:12:31 GMT | 固定 |
ETag | 對於某個資源的某個特定版本的一個識別符號,通常是一個 訊息雜湊 | ETag: "737060cd8c284d8af7ad3082f209582d" | 固定 |
Expires | 指定一個日期/時間,超過該時間則認為此回應已經過期 | Expires: Thu, 01 Dec 1994 16:00:00 GMT | 固定: 標準 |
Last-Modified | 所請求的物件的最後修改日期(按照 RFC 7231 中定義的“超文字傳輸協議日期”格式來表示) | Last-Modified: Dec, 26 Dec 2015 17:30:00 GMT | 固定 |
Link | 用來表示與另一個資源之間的型別關係,此型別關係是在RFC 5988中定義 | Link: ; rel="alternate" | 固定 |
Location | 用於在進行重定向,或在建立了某個新資源時使用。 | Location: www.itbilu.com/nodejs | 固定 |
P3P | P3P策略相關設定 | P3P: CP="This is not a P3P policy! | 固定 |
Pragma | 與具體的實現相關,這些響應頭可能在請求/回應鏈中的不同時候產生不同的效果 | Pragma: no-cache | 固定 |
Proxy-Authenticate | 要求在訪問代理時提供身份認證資訊。 | Proxy-Authenticate: Basic | 固定 |
Public-Key-Pins | 用於防止中間攻擊,宣告網站認證中傳輸層安全協議的證書雜湊值 | Public-Key-Pins: max-age=2592000; pin-sha256="……"; | 固定 |
Refresh | 用於重定向,或者當一個新的資源被建立時。預設會在5秒後重新整理重定向。 | Refresh: 5; url=http://itbilu.com | |
Retry-After | 如果某個實體臨時不可用,那麼此協議頭用於告知客戶端稍後重試。其值可以是一個特定的時間段(以秒為單位)或一個超文字傳輸協議日期。 | 示例1:Retry-After: 120 示例2: Retry-After: Dec, 26 Dec 2015 17:30:00 GMT | 固定 |
Server | 伺服器的名稱 | Server: nginx/1.6.3 | 固定 |
Set-Cookie | 設定HTTP cookie | Set-Cookie: UserID=itbilu; Max-Age=3600; Version=1 | 固定: 標準 |
Status | 通用閘道器介面的響應頭欄位,用來說明當前HTTP連線的響應狀態。 | Status: 200 OK | |
Trailer | Trailer使用者說明傳輸中分塊編碼的編碼資訊 | Trailer: Max-Forwards | 固定 |
Transfer-Encoding | 用表示實體傳輸給使用者的編碼形式。包括:chunked、compress、 deflate、gzip、identity。 | Transfer-Encoding: chunked | 固定 |
Upgrade | 要求客戶端升級到另一個高版本協議。 | Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11 | 固定 |
Vary | 告知下游的代理伺服器,應當如何對以後的請求協議頭進行匹配,以決定是否可使用已快取的響應內容而不是重新從原伺服器請求新的內容。 | Vary: * | 固定 |
Via | 告知代理伺服器的客戶端,當前響應是通過什麼途徑傳送的。 | Via: 1.0 fred, 1.1 itbilu.com (nginx/1.6.3) | 固定 |
Warning | 一般性警告,告知在實體內容體中可能存在錯誤。 | Warning: 199 Miscellaneous warning | 固定 |
WWW-Authenticate | 表示在請求獲取這個實體時應當使用的認證模式。 | WWW-Authenticate: Basic | 固定 |