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(); } } // 注意,這樣寫(xiě),等于重新創(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):
切記,最開(kāi)始,我一直在犯一個(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 中動(dòng)態(tài)加載.jar的實(shí)現(xiàn)步驟
本文介紹動(dòng)態(tài)加載 .jar的實(shí)現(xiàn)步驟,這將對(duì)你的android開(kāi)發(fā)很有幫助,剛興趣的朋友可以了解下哦2013-01-01Android組件DrawerLayout仿網(wǎng)易新聞v4.4側(cè)滑菜單
這篇文章主要為大家詳細(xì)介紹了Android組件DrawerLayout仿網(wǎng)易新聞v4.4側(cè)滑菜單,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-01-01Android 集成 google 登錄并獲取性別等隱私信息的實(shí)現(xiàn)代碼
這篇文章主要介紹了Android 集成 google 登錄并獲取 性別等隱私信息,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-06-06Android使用GridView實(shí)現(xiàn)日歷的簡(jiǎn)單功能
這篇文章主要為大家詳細(xì)介紹了Android使用GridView實(shí)現(xiàn)日歷的簡(jiǎn)單功能,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-12-12Android開(kāi)發(fā)實(shí)現(xiàn)廣告無(wú)限循環(huán)功能示例
這篇文章主要介紹了Android開(kāi)發(fā)實(shí)現(xiàn)廣告無(wú)限循環(huán)功能,結(jié)合完整實(shí)例形式分析了Android廣告圖片輪播功能的具體實(shí)現(xiàn)步驟與相關(guān)功能、布局等操作技巧,需要的朋友可以參考下2017-11-11Android ImageButton自定義按鈕的按下效果的代碼實(shí)現(xiàn)方法分享
這篇文章主要介紹了Android ImageButton自定義按鈕的按下效果的代碼實(shí)現(xiàn)方法,需要的朋友可以參考下2014-02-02Android使用API實(shí)現(xiàn)圖像扭曲效果示例
這篇文章主要介紹了Android使用API實(shí)現(xiàn)圖像扭曲效果,涉及Android坐標(biāo)運(yùn)算與圖形繪制相關(guān)操作技巧,需要的朋友可以參考下2017-08-08Android 使用Gallery實(shí)現(xiàn)3D相冊(cè)(附效果圖+Demo源碼)
今天主要是說(shuō)說(shuō)如何實(shí)現(xiàn)Gallery的3D顯示切換,Demo的代碼很多是基于網(wǎng)上一些現(xiàn)成效果,感謝這些分享成果的開(kāi)發(fā)者2013-07-07Android編程實(shí)現(xiàn)3D旋轉(zhuǎn)效果實(shí)例
這篇文章主要介紹了Android編程實(shí)現(xiàn)3D旋轉(zhuǎn)效果的方法,基于Android的Camera類實(shí)現(xiàn)坐標(biāo)變換達(dá)到圖片3D旋轉(zhuǎn)效果,需要的朋友可以參考下2016-01-01