Android OKHttp3攔截器的使用方法
本文介紹了Android OKHttp3攔截器的使用方法，分享給大家，具體如下：
添加Interceptor
在上一篇中我們已經(jīng)知道了okhttp的基本使用，其中在介紹OkHttpClient初始化的時(shí)候，介紹了兩種方式，第二種方式就可以對(duì)這個(gè)OkHttpClient對(duì)象設(shè)置攔截器，如下所示：
// 配置一些信息進(jìn)入OkHttpClient
mOkHttpClient = new OkHttpClient().newBuilder()
.connectTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.readTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.writeTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.addInterceptor(new LoggerInterceptor())
.build();
如上代碼，很簡(jiǎn)單，只要利用addInterceptor方法就可以添加攔截器，而自定義的攔截器只需要實(shí)現(xiàn) Interceptor 接口就行了，如下所示：
public class LoggerInterceptor implements Interceptor {
...
}
應(yīng)用場(chǎng)景
日志打印
可以使用攔截器方便的打印網(wǎng)絡(luò)請(qǐng)求時(shí)，需要查看的日志。如下所示：
public class LoggerInterceptor implements Interceptor {
@Override
public Response intercept(@NonNull Chain chain) throws IOException {
// 攔截請(qǐng)求，獲取到該次請(qǐng)求的request
Request request = chain.request();
// 執(zhí)行本次網(wǎng)絡(luò)請(qǐng)求操作，返回response信息
Response response = chain.proceed(request);
if (Configuration.DEBUG) {
for (String key : request.headers().toMultimap().keySet()) {
LogUtil.e("zp_test", "header: {" + key + " : " + request.headers().toMultimap().get(key) + "}");
}
LogUtil.e("zp_test", "url: " + request.url().uri().toString());
ResponseBody responseBody = response.body();
if (HttpHeaders.hasBody(response) && responseBody != null) {
BufferedReader bufferedReader = new BufferedReader(new
InputStreamReader(responseBody.byteStream(), "utf-8"));
String result;
while ((result = bufferedReader.readLine()) != null) {
LogUtil.e("zp_test", "response: " + result);
}
// 測(cè)試代碼
responseBody.string();
}
}
// 注意，這樣寫，等于重新創(chuàng)建Request，獲取新的Response，避免在執(zhí)行以上代碼時(shí)，
// 調(diào)用了responseBody.string()而不能在返回體中再次調(diào)用。
return response.newBuilder().build();
}
}
做了一個(gè)打印驗(yàn)證：通過(guò)分別打印攔截器與返回體的時(shí)間和線程名字，可以知道這兩者處于同一線程中，增加攔截器，請(qǐng)求執(zhí)行的時(shí)間也會(huì)增加，所以猜測(cè)，其實(shí)就是線性的在執(zhí)行不同攔截器中的代碼，根據(jù)需求返回一個(gè)相同的或者新的response。
緩存
想要實(shí)現(xiàn)緩存，先在創(chuàng)建okhttpclint的時(shí)候多加一行代碼 .cache() ，通過(guò)它來(lái)設(shè)置緩存目錄，當(dāng)然需要服務(wù)器支持緩存功能。
mOkHttpClient = new OkHttpClient().newBuilder()
.cache(new Cache(FileUtils.getCacheDirectory(AppApplication
.getApplication(), ""), 1024 * 1024))
.connectTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.readTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.writeTimeout(REQUEST_TIME, TimeUnit.SECONDS)
.addNetworkInterceptor(new LoggerInterceptor())
.build();
如果服務(wù)器端支持緩存的話，則請(qǐng)求所返回的Response會(huì)帶有這樣的頭信息header:cache-control, max-age=xxx,這樣設(shè)置。這時(shí)可以直接使用緩存功能。其中，max-age設(shè)置的緩存時(shí)間，過(guò)了這個(gè)時(shí)間，就算有緩存也不會(huì)進(jìn)行使用。
像我公司服務(wù)器返回的頭信息中與緩存相關(guān)的字段如下：
header: {cache-control : [no-store, private]}
header: {pragma : [no-cache]}
這就說(shuō)明，服務(wù)器默認(rèn)是不支持緩存的，okhttp就不會(huì)對(duì)此次請(qǐng)求進(jìn)行緩存。
接下來(lái)再看攔截器中如何設(shè)置緩存
public class LoggerInterceptor implements Interceptor {
@Override
public Response intercept(@NonNull Chain chain) throws IOException {
// 攔截請(qǐng)求，獲取到該次請(qǐng)求的request
Request request = chain.request();
// 執(zhí)行本次網(wǎng)絡(luò)請(qǐng)求操作，返回response信息
Response response = chain.proceed(request);
if (Configuration.DEBUG) {
for (String key : request.headers().toMultimap().keySet()) {
LogUtil.e("zp_test", "header: {" + key + " : " + request.headers().toMultimap().get(key) + "}");
}
LogUtil.e("zp_test", "url: " + request.url().uri().toString());
ResponseBody responseBody = response.body();
}
return response.newBuilder()
// 增加一個(gè)緩存頭信息，緩存時(shí)間為60s
.header("cache-control", "public, max-age=60")
// 移除pragma頭信息
.removeHeader("pragma")
.build();
}
}
這樣設(shè)置，就等于是在60s內(nèi)強(qiáng)制設(shè)置使用緩存。
注意點(diǎn)：
切記，最開始，我一直在犯一個(gè)錯(cuò)誤，okhttp3不能緩存post接口
攔截器可以理解為，給請(qǐng)求的request和response重新一次封裝的機(jī)會(huì)，使得你可以在特定條件下，給一些特定的接口或者滿足特定條件的接口一些特殊的操作。
比如有一種場(chǎng)景，有網(wǎng)絡(luò)時(shí)，進(jìn)行請(qǐng)求，無(wú)網(wǎng)絡(luò)時(shí)，拿緩存數(shù)據(jù)。
if (NetUtils.isNetAvailable(AppApplication.getApplication())) {
response.newBuilder()
.header("Cache-Control", "public, max-age=" + 0)
.removeHeader("Pragma")
.build();
} else {
int maxStale = 60 * 60 * 24; // 無(wú)網(wǎng)絡(luò)時(shí)，設(shè)置超時(shí)為1天
response.newBuilder()
.header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
.removeHeader("Pragma")
.build();
}
return response;
max-stale：在max-age指定的失效時(shí)間外，額外增加一段指定的時(shí)間可以使用失效的response。
網(wǎng)上有很多是上面這種做法，但是，我在攔截器中試了一下，當(dāng)沒(méi)有網(wǎng)絡(luò)時(shí)，壓根就不會(huì)走入攔截器。（我使用的是網(wǎng)絡(luò)攔截器，如果有是別的什么原因，歡迎指出錯(cuò)誤）
最終解決方案是在初始化request（如果初始化不熟悉可以參考我的上一篇文章OKHttp3的基本使用）的時(shí)候進(jìn)行的判斷操作，當(dāng)有網(wǎng)絡(luò)時(shí)初始化正常的request，當(dāng)沒(méi)有網(wǎng)絡(luò)時(shí)初始化強(qiáng)制使用緩存的request：
Request request;
if (NetUtils.isNetAvailable(AppApplication.getApplication())) {
request = addHeaderInfo().url(requestUrl).build();
} else {
request = addHeaderInfo().url(requestUrl).cacheControl(CacheControl.FORCE_CACHE).build();
}
攔截器還是使用上面的那種形式，只是將有效時(shí)間變成了0
response.newBuilder()
.header("Cache-Control", "public, max-age=" + 0)
.removeHeader("Pragma")
.build();
這樣就可以在有網(wǎng)絡(luò)的情況下使用最新的數(shù)據(jù)，在無(wú)網(wǎng)絡(luò)的情況下使用緩存數(shù)據(jù)。
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
Android中PathMeasure仿支付寶支付動(dòng)畫
這篇文章主要為大家詳細(xì)介紹了Android中PathMeasure仿支付寶支付動(dòng)畫，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-08-08
這篇文章主要為大家詳細(xì)介紹了Android使用popUpWindow帶遮罩層的彈出框，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-10-10
獲取Activity棧,判斷當(dāng)前Activity位置的方法
下面小編就為大家分享一篇獲取Activity棧,判斷當(dāng)前Activity位置的方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-03-03
協(xié)程是互相協(xié)作的程序，協(xié)程是結(jié)構(gòu)化的。如果把Java的異常處理機(jī)制，照搬到Kotlin協(xié)程中，一定會(huì)遇到很多的坑。Kotlin協(xié)程中的異常主要分兩大類，協(xié)程取消異常（CancellationException） 其他異常2022-08-08
Android Activity與Fragment之間的跳轉(zhuǎn)實(shí)例詳解
這篇文章主要介紹了Android Activity與Fragment之間的跳轉(zhuǎn)實(shí)例詳解的相關(guān)資料,需要的朋友可以參考下2017-02-02
在kotlin當(dāng)中,Lambda表達(dá)式是最高等級(jí)的,Lambda表達(dá)式可以理解為一種匿名函數(shù),是一種高效的類似于函數(shù)式編程的表達(dá)式,本文介紹Kotlin?lambda表達(dá)式入門指南,感興趣的朋友一起看看吧2024-03-03
深入了解Android Okio的超時(shí)機(jī)制
Okio是一個(gè)IO庫(kù)，底層基于Java原生的輸入輸出流實(shí)現(xiàn)。但原生的輸入輸出流并沒(méi)有提供超時(shí)的檢測(cè)機(jī)制。而Okio實(shí)現(xiàn)了這個(gè)功能，本文就來(lái)為大家詳細(xì)講講2023-02-02
Android中檢查、監(jiān)聽(tīng)電量和充電狀態(tài)的方法
這篇文章主要介紹了Android中檢查、監(jiān)聽(tīng)電量和充電狀態(tài)的方法,如判斷當(dāng)前充電狀態(tài)、監(jiān)聽(tīng)充電狀態(tài)的改變、判斷當(dāng)前剩余電量等,需要的朋友可以參考下2014-06-06
Android實(shí)現(xiàn)類似360,QQ管家那樣的懸浮窗
用到的就是WindowManager以及WindowManager.LayoutParams，對(duì)這個(gè)LayoutParams做文章，當(dāng)設(shè)置為屬性后，然后，創(chuàng)建一個(gè)View，將這個(gè)View添加到WindowManager中就行2013-06-06
如何設(shè)置Android studio 3.0顯示光標(biāo)返回上一次瀏覽位置的箭頭圖標(biāo)
這篇文章主要介紹了如何設(shè)置Android studio 3.0顯示光標(biāo)返回上一次瀏覽位置的箭頭圖標(biāo) 很多朋友反映剛升級(jí)了Android studio 3.0，發(fā)現(xiàn)光標(biāo)返回上一次瀏覽位置的箭頭圖標(biāo)沒(méi)有了，下文給大家介紹的非常詳細(xì),需要的朋友可以參考下2017-11-11