轉(zhuǎn)載請(qǐng)注明出處 http://www.reibang.com/p/fc4d4348dc58 (作者：韓棟)
本文為譯文抖拴，由于譯者水平有限吞歼，歡迎拍磚，讀者也可以閱讀原文
【OkHttp3-基本用法咪啡，OkHttp3-使用進(jìn)階（Recipes）莺琳，OkHttp3-請(qǐng)求器（Calls），OkHttp3-連接（Connections）掺出，OkHttp3-攔截器（Interceptor）】
攔截器
攔截器是OkHttp中提供一種強(qiáng)大機(jī)制徽千，它可以實(shí)現(xiàn)網(wǎng)絡(luò)監(jiān)聽、請(qǐng)求以及響應(yīng)重寫汤锨、請(qǐng)求失敗重試等功能双抽。下面舉一個(gè)簡(jiǎn)單打印日志的栗子，此攔截器可以打印出網(wǎng)絡(luò)請(qǐng)求以及響應(yīng)的信息闲礼。
class LoggingInterceptor implements Interceptor {
@Override public Response intercept(Interceptor.Chain chain) throws IOException {
Request request = chain.request();
long t1 = System.nanoTime();
logger.info(String.format("Sending request %s on %s%n%s",
request.url(), chain.connection(), request.headers()));
Response response = chain.proceed(request);
long t2 = System.nanoTime();
logger.info(String.format("Received response for %s in %.1fms%n%s",
response.request().url(), (t2 - t1) / 1e6d, response.headers()));
return response;
}
}
在沒有本地緩存的情況下牍汹，每個(gè)攔截器都必須至少調(diào)用chain.proceed(request)一次，這個(gè)簡(jiǎn)單的方法實(shí)現(xiàn)了Http請(qǐng)求的發(fā)起以及從服務(wù)端獲取響應(yīng)柬泽。
攔截器可以進(jìn)行鏈?zhǔn)教幚砩鞣啤＜偃缒阃瑫r(shí)有一個(gè)壓縮數(shù)據(jù)和校驗(yàn)數(shù)據(jù)的攔截器，你可以決定將請(qǐng)求或者響應(yīng)數(shù)據(jù)先進(jìn)行壓縮還是先校驗(yàn)大小锨并。OkHttp利用List集合去跟蹤并且保存這些攔截器露该，并且會(huì)依次遍歷調(diào)用。
Application interceptors
攔截器可以以application或者network兩種方式注冊(cè)第煮，分別調(diào)用addInterceptor()以及addNetworkInterceptor方法進(jìn)行注冊(cè)解幼。我們使用上文中日志攔截器的使用來(lái)體現(xiàn)出兩種注冊(cè)方式的不同點(diǎn)。
首先通過(guò)調(diào)用addInterceptor()在OkHttpClient.Builder鏈?zhǔn)酱a中注冊(cè)一個(gè)application攔截器：
OkHttpClient client = new OkHttpClient.Builder()
.addInterceptor(new LoggingInterceptor())
.build();
Request request = new Request.Builder()
.url("http://www.publicobject.com/helloworld.txt")
.header("User-Agent", "OkHttp Example")
.build();
Response response = client.newCall(request).execute();
response.body().close();
請(qǐng)求的URLhttp://www.publicobject.com/helloworld.txt被重定向成https://publicobject.com/helloworld.txt,OkHttp支持自動(dòng)重定向包警。注意撵摆，我們的application攔截器只會(huì)被調(diào)用一次，并且調(diào)用chain.proceed()之后獲得到的是重定向之后的最終的響應(yīng)信息揽趾，并不會(huì)獲得中間過(guò)程的響應(yīng)信息：
INFO: Sending request http://www.publicobject.com/helloworld.txt on null
User-Agent: OkHttp Example
INFO: Received response for https://publicobject.com/helloworld.txt in 1179.7ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/plain
Content-Length: 1759
Connection: keep-alive
我們可以看到請(qǐng)求的URL被重定向了台汇，因?yàn)?code>response.request().url()和request.url()是不一樣的。日志打印出來(lái)的信息顯示兩個(gè)不同的URL篱瞎」赌牛客戶端第一次請(qǐng)求執(zhí)行的url為http://www.publicobject.com/helloworld.txt，而響應(yīng)數(shù)據(jù)的url為https://publicobject.com/helloworld.txt俐筋。
Network interceptors
注冊(cè)一個(gè)Network攔截器和注冊(cè)Application攔截器方法是非常相似的牵素。注冊(cè)Application攔截器調(diào)用的是addInterceptor()，而注冊(cè)Network攔截器調(diào)用的是addNetworkInterceptor()澄者。
OkHttpClient client = new OkHttpClient.Builder()
.addNetworkInterceptor(new LoggingInterceptor())
.build();
Request request = new Request.Builder()
.url("http://www.publicobject.com/helloworld.txt")
.header("User-Agent", "OkHttp Example")
.build();
Response response = client.newCall(request).execute();
response.body().close();
我們運(yùn)行這段代碼笆呆，發(fā)現(xiàn)這個(gè)攔截被執(zhí)行了兩次请琳。一次是初始化也就是客戶端第一次向URL為http://www.publicobject.com/helloworld.txt發(fā)出請(qǐng)求，另外一次則是URL被重定向之后客戶端再次向https://publicobject.com/helloworld.txt發(fā)出請(qǐng)求赠幕。
INFO: Sending request http://www.publicobject.com/helloworld.txt on Connection{www.publicobject.com:80, proxy=DIRECT hostAddress=54.187.32.157 cipherSuite=none protocol=http/1.1}
User-Agent: OkHttp Example
Host: www.publicobject.com
Connection: Keep-Alive
Accept-Encoding: gzip
INFO: Received response for http://www.publicobject.com/helloworld.txt in 115.6ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/html
Content-Length: 193
Connection: keep-alive
Location: https://publicobject.com/helloworld.txt
INFO: Sending request https://publicobject.com/helloworld.txt on Connection{publicobject.com:443, proxy=DIRECT hostAddress=54.187.32.157 cipherSuite=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA protocol=http/1.1}
User-Agent: OkHttp Example
Host: publicobject.com
Connection: Keep-Alive
Accept-Encoding: gzip
INFO: Received response for https://publicobject.com/helloworld.txt in 80.9ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/plain
Content-Length: 1759
Connection: keep-alive
NetWork請(qǐng)求包含了更多信息俄精，比如OkHttp為了減少數(shù)據(jù)的傳輸時(shí)間以及傳輸流量而自動(dòng)添加的請(qǐng)求頭Accept-Encoding: gzip希望服務(wù)器能返回經(jīng)過(guò)壓縮過(guò)的響應(yīng)數(shù)據(jù)。Network 攔截器調(diào)用Chain方法后會(huì)返回一個(gè)非空的Connection對(duì)象榕堰，它可以用來(lái)查詢客戶端所連接的服務(wù)器的IP地址以及TLS配置信息竖慧。
選擇使用Application或Network攔截器?
每一個(gè)攔截器都有它的優(yōu)點(diǎn)。
Application interceptors
- 無(wú)法操作中間的響應(yīng)結(jié)果逆屡，比如當(dāng)URL重定向發(fā)生以及請(qǐng)求重試等圾旨，只能操作客戶端主動(dòng)第一次請(qǐng)求以及最終的響應(yīng)結(jié)果。
- 在任何情況下只會(huì)調(diào)用一次魏蔗，即使這個(gè)響應(yīng)來(lái)自于緩存砍的。
- 可以監(jiān)聽觀察這個(gè)請(qǐng)求的最原始未經(jīng)改變的意圖（請(qǐng)求頭，請(qǐng)求體等）莺治，無(wú)法操作OkHttp為我們自動(dòng)添加的額外的請(qǐng)求頭廓鞠，比如
If-None-Match。 - 允許
short-circuit (短路)并且允許不去調(diào)用Chain.proceed()产雹。（編者注：這句話的意思是Chain.proceed()不需要一定要調(diào)用去服務(wù)器請(qǐng)求诫惭，但是必須還是需要返回Respond實(shí)例。那么實(shí)例從哪里來(lái)蔓挖？答案是緩存夕土。如果本地有緩存，可以從本地緩存中獲取響應(yīng)實(shí)例返回給客戶端瘟判。這就是short-circuit (短路)的意思怨绣。。囧） - 允許請(qǐng)求失敗重試以及多次調(diào)用
Chain.proceed()拷获。
Network Interceptors
- 允許操作中間響應(yīng)篮撑，比如當(dāng)請(qǐng)求操作發(fā)生重定向或者重試等。
- 不允許調(diào)用緩存來(lái)
short-circuit (短路)這個(gè)請(qǐng)求匆瓜。（編者注：意思就是說(shuō)不能從緩存池中獲取緩存對(duì)象返回給客戶端赢笨，必須通過(guò)請(qǐng)求服務(wù)的方式獲取響應(yīng)，也就是Chain.proceed()） - 可以監(jiān)聽數(shù)據(jù)的傳輸
- 允許
Connection對(duì)象裝載這個(gè)請(qǐng)求對(duì)象驮吱。（編者注：Connection是通過(guò)Chain.proceed()獲取的非空對(duì)象）
重寫請(qǐng)求
攔截器可以添加茧妒、移除或者替換請(qǐng)求頭。甚至在有請(qǐng)求主體時(shí)候左冬，可以改變請(qǐng)求主體桐筏。舉個(gè)栗子，你可以使用application interceptor添加經(jīng)過(guò)壓縮之后的請(qǐng)求主體拇砰，當(dāng)然梅忌，這需要你將要連接的服務(wù)端支持處理壓縮數(shù)據(jù)狰腌。
/** This interceptor compresses the HTTP request body. Many webservers can't handle this! */
final class GzipRequestInterceptor implements Interceptor {
@Override public Response intercept(Interceptor.Chain chain) throws IOException {
Request originalRequest = chain.request();
if (originalRequest.body() == null || originalRequest.header("Content-Encoding") != null) {
return chain.proceed(originalRequest);
}
Request compressedRequest = originalRequest.newBuilder()
.header("Content-Encoding", "gzip")
.method(originalRequest.method(), gzip(originalRequest.body()))
.build();
return chain.proceed(compressedRequest);
}
private RequestBody gzip(final RequestBody body) {
return new RequestBody() {
@Override public MediaType contentType() {
return body.contentType();
}
@Override public long contentLength() {
return -1; // We don't know the compressed length in advance!
}
@Override public void writeTo(BufferedSink sink) throws IOException {
BufferedSink gzipSink = Okio.buffer(new GzipSink(sink));
body.writeTo(gzipSink);
gzipSink.close();
}
};
}
}
重寫響應(yīng)
和重寫請(qǐng)求相似，攔截器可以重寫響應(yīng)頭并且可以改變它的響應(yīng)主體牧氮。相對(duì)于重寫請(qǐng)求而言琼腔，重寫響應(yīng)通常是比較危險(xiǎn)的一種做法，因?yàn)檫@種操作可能會(huì)改變服務(wù)端所要傳遞的響應(yīng)內(nèi)容的意圖蹋笼。
當(dāng)然展姐，如果你 比較奸詐 在不得已的情況下，比如不處理的話的客戶端程序接受到此響應(yīng)的話會(huì)Crash等剖毯，以及你還可以保證解決重寫響應(yīng)后可能出現(xiàn)的問題時(shí)，重新響應(yīng)頭是一種非常有效的方式去解決這些導(dǎo)致項(xiàng)目Crash的問題教馆。舉個(gè)栗子逊谋，你可以修改服務(wù)器返回的錯(cuò)誤的響應(yīng)頭Cache-Control信息，去更好地自定義配置響應(yīng)緩存保存時(shí)間土铺。
/** Dangerous interceptor that rewrites the server's cache-control header. */
private static final Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = new Interceptor() {
@Override public Response intercept(Interceptor.Chain chain) throws IOException {
Response originalResponse = chain.proceed(chain.request());
return originalResponse.newBuilder()
.header("Cache-Control", "max-age=60")
.build();
}
};
不過(guò)通常最好的做法是在服務(wù)端修復(fù)這個(gè)問題胶滋。
