OkGo，一個(gè)專注于讓網(wǎng)絡(luò)請(qǐng)求更簡(jiǎn)單的框架，與RxJava完美結(jié)合，比Retrofit更簡(jiǎn)單易用。
?
OkGo - OkHttpUtils-2.0.0升級(jí)后改名 OkGo,全新完美支持RxJava
項(xiàng)目地址：https://github.com/jeasonlzy
該庫(kù)是封裝了okhttp的網(wǎng)絡(luò)框架，可以與RxJava完美結(jié)合，比Retrofit更簡(jiǎn)單易用。支持大文件上傳下載，上傳進(jìn)度回調(diào)，下載進(jìn)度回調(diào)，表單上傳（多文件和多參數(shù)一起上傳），鏈?zhǔn)秸{(diào)用，可以自定義返回對(duì)象，支持Https和自簽名證書，支持cookie自動(dòng)管理，支持四種緩存模式緩存網(wǎng)絡(luò)數(shù)據(jù)，支持301、302重定向，擴(kuò)展了統(tǒng)一的上傳管理和下載管理功能
其中Demo中用到的圖片選擇是我的另一個(gè)開源項(xiàng)目，完全仿微信的圖片選擇庫(kù)，自帶 矩形圖片裁剪 和 圓形圖片裁剪 功能，有需要的可以去下載使用，附上地址：https://github.com/jeasonlzy/ImagePicker
其中的九宮格控件也是我的開源項(xiàng)目,類似QQ空間，微信朋友圈，微博主頁(yè)等，展示圖片的九宮格控件，自動(dòng)根據(jù)圖片的數(shù)量確定圖片大小和控件大小，使用Adapter模式設(shè)置圖片，對(duì)外提供接口回調(diào)，使用接口加載圖片,支持任意的圖片加載框架,如 Glide,ImageLoader,Fresco,xUtils3,Picasso 等，支持點(diǎn)擊圖片全屏預(yù)覽大圖。附上地址：https://github.com/jeasonlzy/NineGridView
聯(lián)系方式
項(xiàng)目Github開源地址：https://github.com/jeasonlzy
聯(lián)系方式：QQ號(hào)（2022594190）
如果你想直接運(yùn)行apk看效果，點(diǎn)擊這里下載：okgo_v2.0.0.apk
以下是該項(xiàng)目相關(guān)文章的傳送門：
OkGo結(jié)合RxJava使用的擴(kuò)展項(xiàng)目：OkRx擴(kuò)展，讓OkGo完美結(jié)合RxJava，比Retrofit更簡(jiǎn)單易用
OkGo2.0版本以前的前身OkHttpUtils介紹：OkHttpUtils一個(gè)專注于讓網(wǎng)絡(luò)請(qǐng)求更簡(jiǎn)單的框架
演示
如何選擇網(wǎng)絡(luò)框架
說了這么多功能，我們來看看為什么要使用OkGo這個(gè)框架。
首先目前主流的幾個(gè)網(wǎng)絡(luò)框架
android-async-http
xUtils
volley
retrofit
okhttp
在此引用知乎上Stay Zhang的回答：
我們來先說一個(gè)常識(shí)性的錯(cuò)誤：volley, retrofit, android-async-http 幫你封裝了具體的請(qǐng)求，線程切換以及數(shù)據(jù)轉(zhuǎn)換。而OkHttp 是基于http協(xié)議封裝的一套請(qǐng)求客戶端，雖然它也可以開線程，但根本上它更偏向真正的請(qǐng)求，跟HttpClient, HttpUrlConnection的職責(zé)是一樣的。
所以不要混淆。
-----以下純個(gè)人主觀見解
首先，我想即使你單純使用OkHttp，還是會(huì)再包一層的，這樣就等價(jià)于Volley之流的框架，只是封裝的好與壞而已。
android-async-http內(nèi)部實(shí)現(xiàn)是基于HttpClient, 想必你肯定知道6.0之后HttpClient是不是系統(tǒng)自帶的了，不過它在最近的更新中將HttpClient的所有代碼copy了一份進(jìn)來，所以還能使用。
Volley是官方出的，volley在設(shè)計(jì)的時(shí)候是將具體的請(qǐng)求客戶端做了下封裝：HurlStack，也就是說可以支持HttpUrlConnection, HttpClient, OkHttp，相當(dāng)于模版模式吧，這樣解耦還是非常方便的，可以隨意切換，如果你之前使用過Volley，并習(xí)慣使用，那直接寫個(gè)OkHttp擴(kuò)展就行了。
Retrofit因?yàn)橐彩莝quare出的，所以大家可能對(duì)它更崇拜些。Retrofit的跟Volley是一個(gè)套路，但解耦的更徹底:比方說通過注解來配置請(qǐng)求參數(shù)，通過工廠來生成CallAdapter，Converter，你可以使用不同的請(qǐng)求適配器(CallAdapter), 比方說RxJava，Java8, Guava。你可以使用不同的反序列化工具(Converter)，比方說json, protobuff, xml, moshi等等。然而目前OkGo已經(jīng)完全可以替代Retrofit，同樣支持RxJava，但具有更強(qiáng)的靈活性和易用性。
OkGo的優(yōu)勢(shì)
優(yōu)勢(shì)一：性能高，專注于簡(jiǎn)單易用的網(wǎng)絡(luò)請(qǐng)求，使用主流的okhttp進(jìn)行封裝，對(duì)于okhttp大家都知道，在Android4.4的源碼中可以看到HttpURLConnection已經(jīng)替換成OkHttp實(shí)現(xiàn)了，并且支持HTTP2/SPDY黑科技，支持socket自動(dòng)選擇最好路線，并支持自動(dòng)重連，擁有自動(dòng)維護(hù)的socket連接池，減少握手次數(shù)，擁有隊(duì)列線程池，輕松寫并發(fā)。
優(yōu)勢(shì)二：特有的網(wǎng)絡(luò)緩存模式，是大多數(shù)網(wǎng)絡(luò)框架所不具備的，說一個(gè)應(yīng)用場(chǎng)景，老板說我們的app不僅需要在有網(wǎng)的情況下展示最新的網(wǎng)絡(luò)數(shù)據(jù)，還要在沒網(wǎng)的情況下使用緩存數(shù)據(jù)，這時(shí)候是不是項(xiàng)目中出現(xiàn)了大量的代碼判斷當(dāng)前網(wǎng)絡(luò)狀況，根據(jù)不同的狀態(tài)保存不同的數(shù)據(jù)，然后決定是否使用緩存。細(xì)想一下，這是個(gè)通用的寫法，于是OkGo提供了五種緩存模式，讓你不用關(guān)心緩存的實(shí)現(xiàn)，而專注于數(shù)據(jù)的處理。（具體緩存的使用方法請(qǐng)看最后第四章節(jié)）。
優(yōu)勢(shì)三：方便易用的擴(kuò)展接口，可以添加全局的公共參數(shù)，全局?jǐn)r截器，全局超時(shí)時(shí)間，更可以對(duì)單個(gè)請(qǐng)求定制攔截器，超時(shí)時(shí)間，請(qǐng)求參數(shù)修改等等，在使用上更是方便，原生支持的鏈?zhǔn)秸{(diào)用讓你的請(qǐng)求更加清晰。
優(yōu)勢(shì)四：強(qiáng)大的Cookie保持策略，我們知道在客戶端對(duì)cookie的獲取是個(gè)不太簡(jiǎn)單的事情，特別是還要處理cookie的過期時(shí)間，持久化策略等等，OkGo幫你徹底解決Cookie的難題，默認(rèn)擁有內(nèi)存存儲(chǔ)和持久化存儲(chǔ)兩種實(shí)現(xiàn)，cookie全程自動(dòng)管理，并且提供了額外的addCookie方式，允許介入到自動(dòng)管理的過程中，添加你想創(chuàng)建的任何cookie。
所以就說這么多啦，選最適合項(xiàng)目的，選大多數(shù)人選擇的，選簡(jiǎn)單易用的，選擇使用流行技術(shù)的，就這么個(gè)標(biāo)準(zhǔn)，而OkGo正是在這種情況下誕生啦！！
1.用法
為了方便大家使用，更加通俗的理解http的網(wǎng)絡(luò)協(xié)議，建議做網(wǎng)絡(luò)請(qǐng)求的時(shí)候，對(duì)每個(gè)請(qǐng)求抓包后查看請(qǐng)求信息和響應(yīng)信息。
如果是 Windows 操作系統(tǒng)，可以使用?Fiddler?對(duì)手機(jī)的請(qǐng)求進(jìn)行抓包查看。
如果是 Mac OS 操作系統(tǒng)，可以使用?Charles?對(duì)手機(jī)的請(qǐng)求進(jìn)行抓包查看。
具體的下載地址和抓包配置方法，我這就不提供了，請(qǐng)自行百度或谷歌。
對(duì)于Eclipse不能運(yùn)行項(xiàng)目的，提供了apk供直接運(yùn)行
或者點(diǎn)擊下載Demo?okgo_v2.0.0.apk
本項(xiàng)目Demo的網(wǎng)絡(luò)請(qǐng)求是我自己的服務(wù)器，有時(shí)候可能不穩(wěn)定，網(wǎng)速比較慢時(shí)請(qǐng)耐心等待。。
以下是最新版本的版本號(hào)，如果你想使用以前的版本，請(qǐng)點(diǎn)擊這里，歷史版本。
對(duì)于Android Studio的用戶，可以選擇添加:
compile'com.lzy.net:okgo:2.0.0'//可以單獨(dú)使用，不需要依賴下方的擴(kuò)展包c(diǎn)ompile'com.lzy.net:okrx:0.1.0'//RxJava擴(kuò)展支持，根據(jù)需要添加compile'com.lzy.net:okserver:1.1.0'//下載管理和上傳管理擴(kuò)展，根據(jù)需要添加或者? ? ? ? compile'com.lzy.net:okgo:+'//版本號(hào)使用 + 可以自動(dòng)引用最新版compile'com.lzy.net:okrx:+'//版本號(hào)使用 + 可以自動(dòng)引用最新版compile'com.lzy.net:okserver:+'//版本號(hào)使用 + 可以自動(dòng)引用最新版
對(duì)于Eclipse的用戶，可以選擇添加?/jar?目錄下的:
okgo-2.0.0.jar? ? okrx-0.1.0.jar? ? okserver-1.1.0.jar
如果是以jar包的形式引入okserver,需要在清單文件中額外注冊(cè)一個(gè)服務(wù)
如果只是用了okgo的jar,沒有使用okserver的jar,那么不需要注冊(cè)上面的服務(wù)
2.使用注意事項(xiàng)
okgo使用的okhttp的版本是最新的 3.4.1 版本，和以前的 2.x 的版本可能會(huì)存在沖突。
okrx是基于RxJava和RxAndroid的擴(kuò)展,如果不需要可以不必引入
okserver是對(duì)okgo的擴(kuò)展，統(tǒng)一了下載管理和上傳管理，對(duì)項(xiàng)目有需要做統(tǒng)一下載的可以考慮使用該擴(kuò)展，不需要的可以直接使用okgo即可。
對(duì)于緩存模式使用，需要與返回對(duì)象相關(guān)的所有javaBean必須實(shí)現(xiàn)Serializable接口，否者會(huì)報(bào)NotSerializableException。
使用緩存時(shí)，如果不指定cacheKey，默認(rèn)是用url帶參數(shù)的全路徑名為cacheKey。
使用該網(wǎng)絡(luò)框架時(shí)，必須要在 Application 中做初始化?OkGo.init(this);。
3.OkGo 目前支持
一般的 get,post,put,delete,head,options請(qǐng)求
基于Post的大文本數(shù)據(jù)上傳
多文件和多參數(shù)統(tǒng)一的表單上傳
支持一個(gè)key上傳一個(gè)文件，也可以一個(gè)Key上傳多個(gè)文件
大文件下載和下載進(jìn)度回調(diào)
大文件上傳和上傳進(jìn)度回調(diào)
支持cookie的內(nèi)存存儲(chǔ)和持久化存儲(chǔ)，支持傳遞自定義cookie
支持304緩存協(xié)議，擴(kuò)展四種本地緩存模式,并且支持緩存時(shí)間控制
支持301、302重定向
支持鏈?zhǔn)秸{(diào)用
支持可信證書和自簽名證書的https的訪問,支持雙向認(rèn)證
支持根據(jù)Tag取消請(qǐng)求
支持自定義泛型Callback，自動(dòng)根據(jù)泛型返回對(duì)象
4.OkRx 擴(kuò)展功能
詳細(xì)使用方法點(diǎn)擊這里:?OkRx擴(kuò)展，讓OkGo完美結(jié)合RxJava，比Retrofit更簡(jiǎn)單易用
完美結(jié)合RxJava
比Retrofit更簡(jiǎn)單方便
網(wǎng)絡(luò)請(qǐng)求和RxJava調(diào)用,一條鏈點(diǎn)到底
支持Json數(shù)據(jù)的自動(dòng)解析轉(zhuǎn)換
OkGo包含的所有請(qǐng)求功能,OkRx全部支持
5.OkServer 擴(kuò)展功能
5.1 統(tǒng)一的文件下載管理(DownloadManager)：
結(jié)合OkGo的request進(jìn)行網(wǎng)絡(luò)請(qǐng)求,支持與OkGo保持相同的全局公共參數(shù),同時(shí)支持請(qǐng)求傳遞參數(shù)
支持?jǐn)帱c(diǎn)下載，支持突然斷網(wǎng),強(qiáng)殺進(jìn)程后,斷點(diǎn)依然有效
支持 下載 暫停 等待 停止 出錯(cuò) 完成 六種下載狀態(tài)
所有下載任務(wù)按照taskKey區(qū)分,切記不同的任務(wù)必須使用不一樣的key,否者斷點(diǎn)會(huì)發(fā)生覆蓋
相同的下載url地址如果使用不一樣的taskKey,也會(huì)認(rèn)為是兩個(gè)下載任務(wù)
默認(rèn)同時(shí)下載數(shù)量為3個(gè)，默認(rèn)下載路徑/storage/emulated/0/download，下載路徑和下載數(shù)量都可以在代碼中配置
下載文件名可以自己定義,也可以不傳,框架自動(dòng)解析響應(yīng)頭或者url地址獲得文件名,如果都沒獲取到,使用default作為文件名
下載管理使用了服務(wù)提高線程優(yōu)先級(jí)，避免后臺(tái)下載時(shí)被系統(tǒng)回收
5.2 統(tǒng)一的文件上傳管理(UploadManager)
結(jié)合OkGo的request進(jìn)行網(wǎng)絡(luò)請(qǐng)求,支持與OkGo保持相同的全局公共參數(shù),同時(shí)支持請(qǐng)求傳遞參數(shù)
上傳只能使用Post,?Put,?Delete,?Options?這四種請(qǐng)求,不支持Get,?Head
該上傳管理為簡(jiǎn)單管理，不支持?jǐn)帱c(diǎn)續(xù)傳或分片上傳，只是簡(jiǎn)單的將所有上傳任務(wù)使用線程池進(jìn)行了統(tǒng)一管理
默認(rèn)同時(shí)上傳數(shù)量為1個(gè),該數(shù)列可以在代碼中配置修改
一、全局配置
一般在 Aplication，或者基類中，只需要調(diào)用一次即可，可以配置調(diào)試開關(guān)，全局的超時(shí)時(shí)間，公共的請(qǐng)求頭和請(qǐng)求參數(shù)等信息
@OverridepublicvoidonCreate(){super.onCreate();//---------這里給出的是示例代碼,告訴你可以這么傳,實(shí)際使用的時(shí)候,根據(jù)需要傳,不需要就不傳-------------//HttpHeaders headers =newHttpHeaders();? ? ? ? headers.put("commonHeaderKey1","commonHeaderValue1");//header不支持中文headers.put("commonHeaderKey2","commonHeaderValue2");? ? ? ? HttpParams params =newHttpParams();? ? ? ? params.put("commonParamsKey1","commonParamsValue1");//param支持中文,直接傳,不要自己編碼params.put("commonParamsKey2","這里支持中文參數(shù)");//-----------------------------------------------------------------------------------////必須調(diào)用初始化OkGo.init(this);//以下設(shè)置的所有參數(shù)是全局參數(shù),同樣的參數(shù)可以在請(qǐng)求的時(shí)候再設(shè)置一遍,那么對(duì)于該請(qǐng)求來講,請(qǐng)求中的參數(shù)會(huì)覆蓋全局參數(shù)//好處是全局參數(shù)統(tǒng)一,特定請(qǐng)求可以特別定制參數(shù)try{//以下都不是必須的，根據(jù)需要自行選擇,一般來說只需要 debug,緩存相關(guān),cookie相關(guān)的 就可以了OkGo.getInstance()//打開該調(diào)試開關(guān),控制臺(tái)會(huì)使用 紅色error 級(jí)別打印log,并不是錯(cuò)誤,是為了顯眼,不需要就不要加入該行.debug("OkGo")//如果使用默認(rèn)的 60秒,以下三行也不需要傳.setConnectTimeout(OkGo.DEFAULT_MILLISECONDS)//全局的連接超時(shí)時(shí)間.setReadTimeOut(OkGo.DEFAULT_MILLISECONDS)//全局的讀取超時(shí)時(shí)間.setWriteTimeOut(OkGo.DEFAULT_MILLISECONDS)//全局的寫入超時(shí)時(shí)間//可以全局統(tǒng)一設(shè)置緩存模式,默認(rèn)是不使用緩存,可以不傳,具體其他模式看 github 介紹 https://github.com/jeasonlzy/.setCacheMode(CacheMode.NO_CACHE)//可以全局統(tǒng)一設(shè)置緩存時(shí)間,默認(rèn)永不過期,具體使用方法看 github 介紹.setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE)//如果不想讓框架管理cookie,以下不需要//? ? ? ? ? ? ? ? .setCookieStore(new MemoryCookieStore())? ? ? ? ? ? ? ? //cookie使用內(nèi)存緩存（app退出后，cookie消失）.setCookieStore(newPersistentCookieStore())//cookie持久化存儲(chǔ)，如果cookie不過期，則一直有效//可以設(shè)置https的證書,以下幾種方案根據(jù)需要自己設(shè)置,不需要不用設(shè)置//? ? ? ? ? ? ? ? ? ? .setCertificates()? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? //方法一：信任所有證書//? ? ? ? ? ? ? ? ? ? .setCertificates(getAssets().open("srca.cer"))? ? ? //方法二：也可以自己設(shè)置https證書//? ? ? ? ? ? ? ? ? ? .setCertificates(getAssets().open("aaaa.bks"), "123456", getAssets().open("srca.cer"))//方法三：傳入bks證書,密碼,和cer證書,支持雙向加密//可以添加全局?jǐn)r截器,不會(huì)用的千萬不要傳,錯(cuò)誤寫法直接導(dǎo)致任何回調(diào)不執(zhí)行//? ? ? ? ? ? ? ? .addInterceptor(new Interceptor() {//? ? ? ? ? ? ? ? ? ? @Override//? ? ? ? ? ? ? ? ? ? public Response intercept(Chain chain) throws IOException {//? ? ? ? ? ? ? ? ? ? ? ? return chain.proceed(chain.request());//? ? ? ? ? ? ? ? ? ? }//? ? ? ? ? ? ? ? })//這兩行同上,不需要就不要傳.addCommonHeaders(headers)//設(shè)置全局公共頭.addCommonParams(params);//設(shè)置全局公共參數(shù)}catch(Exception e) {? ? ? ? ? ? e.printStackTrace();? ? ? ? }? ? }
二、普通請(qǐng)求
0.寫在開始的話,callback回調(diào)默認(rèn)只需要復(fù)寫onSuccess,并不代表所有的回調(diào)都只走這一個(gè),實(shí)際開發(fā)中,錯(cuò)誤回調(diào)并沒有成功回調(diào)使用頻繁,所以callback的失敗回調(diào)onError并沒有聲明為抽象的,如果有需要,請(qǐng)自行復(fù)寫,不要再問我為什么回調(diào)沒有執(zhí)行啊,既然onSuccess沒有執(zhí)行,那么一定是出錯(cuò)了回調(diào)了onError
callback一共有以下 10 個(gè)回調(diào),除onSuccess必須實(shí)現(xiàn)以外,其余均可以按需實(shí)現(xiàn),每個(gè)方法參數(shù)詳細(xì)說明,請(qǐng)看下面第6點(diǎn):
convertSuccess():解析網(wǎng)絡(luò)返回的數(shù)據(jù)回調(diào)
parseError():解析網(wǎng)絡(luò)失敗的數(shù)據(jù)回調(diào)
onBefore():網(wǎng)絡(luò)請(qǐng)求真正執(zhí)行前回調(diào)
onSuccess():網(wǎng)絡(luò)請(qǐng)求成功的回調(diào)
onCacheSuccess():緩存讀取成功的回調(diào)
onError():網(wǎng)絡(luò)請(qǐng)求失敗的回調(diào)
onCacheError():網(wǎng)絡(luò)緩存讀取失敗的回調(diào)
onAfter():網(wǎng)絡(luò)請(qǐng)求結(jié)束的回調(diào),無論成功失敗一定會(huì)執(zhí)行
upProgress():上傳進(jìn)度的回調(diào)
downloadProgress():下載進(jìn)度的回調(diào)
Callback回調(diào)具有如下順序,雖然順序?qū)懙暮軓?fù)雜,但是理解后,是很簡(jiǎn)單,并且合情合理的
1).無緩存模式 CacheMode.NO_CACHE
網(wǎng)絡(luò)請(qǐng)求成功 onBefore -> convertSuccess -> onSuccess -> onAfter
網(wǎng)絡(luò)請(qǐng)求失敗 onBefore -> parseError -> onError -> onAfter
2).默認(rèn)緩存模式,遵循304頭 CacheMode.DEFAULT
網(wǎng)絡(luò)請(qǐng)求成功,服務(wù)端返回非304 onBefore -> convertSuccess -> onSuccess -> onAfter
網(wǎng)絡(luò)請(qǐng)求成功服務(wù)端返回304 onBefore -> onCacheSuccess -> onAfter
網(wǎng)絡(luò)請(qǐng)求失敗 onBefore -> parseError -> onError -> onAfter
3).請(qǐng)求網(wǎng)絡(luò)失敗后讀取緩存 CacheMode.REQUEST_FAILED_READ_CACHE
網(wǎng)絡(luò)請(qǐng)求成功,不讀取緩存 onBefore -> convertSuccess -> onSuccess -> onAfter
網(wǎng)絡(luò)請(qǐng)求失敗,讀取緩存成功 onBefore -> parseError -> onError -> onCacheSuccess -> onAfter
網(wǎng)絡(luò)請(qǐng)求失敗,讀取緩存失敗 onBefore -> parseError -> onError -> onCacheError -> onAfter
4).如果緩存不存在才請(qǐng)求網(wǎng)絡(luò)，否則使用緩存 CacheMode.IF_NONE_CACHE_REQUEST
已經(jīng)有緩存,不請(qǐng)求網(wǎng)絡(luò) onBefore -> onCacheSuccess -> onAfter
沒有緩存請(qǐng)求網(wǎng)絡(luò)成功 onBefore -> onCacheError -> convertSuccess -> onSuccess -> onAfter
沒有緩存請(qǐng)求網(wǎng)絡(luò)失敗 onBefore -> onCacheError -> parseError -> onError -> onAfter
5).先使用緩存，不管是否存在，仍然請(qǐng)求網(wǎng)絡(luò) CacheMode.FIRST_CACHE_THEN_REQUEST
無緩存時(shí),網(wǎng)絡(luò)請(qǐng)求成功 onBefore -> onCacheError -> convertSuccess -> onSuccess -> onAfter
無緩存時(shí),網(wǎng)絡(luò)請(qǐng)求失敗 onBefore -> onCacheError -> parseError -> onError -> onAfter
有緩存時(shí),網(wǎng)絡(luò)請(qǐng)求成功 onBefore -> onCacheSuccess -> convertSuccess -> onSuccess -> onAfter
有緩存時(shí),網(wǎng)絡(luò)請(qǐng)求失敗 onBefore -> onCacheSuccess -> parseError -> onError -> onAfter
1.基本的網(wǎng)絡(luò)請(qǐng)求
OkGo.get(Urls.URL_METHOD)// 請(qǐng)求方式和請(qǐng)求url.tag(this)// 請(qǐng)求的 tag, 主要用于取消對(duì)應(yīng)的請(qǐng)求.cacheKey("cacheKey")// 設(shè)置當(dāng)前請(qǐng)求的緩存key,建議每個(gè)不同功能的請(qǐng)求設(shè)置一個(gè).cacheMode(CacheMode.DEFAULT)// 緩存模式，詳細(xì)請(qǐng)看緩存介紹.execute(newStringCallback() {@OverridepublicvoidonSuccess(String s, Call call, Response response){// s 即為所需要的結(jié)果}? ? });
2.請(qǐng)求 Bitmap 對(duì)象
OkGo.get(Urls.URL_IMAGE)//.tag(this)//.execute(newBitmapCallback() {@OverridepublicvoidonSuccess(Bitmap bitmap, Call call, Response response){// bitmap 即為返回的圖片數(shù)據(jù)}? ? });
3.請(qǐng)求 文件下載
OkGo.get(Urls.URL_DOWNLOAD)//.tag(this)//.execute(newFileCallback("file.jpg") {//文件下載時(shí)，需要指定下載的文件目錄和文件名@OverridepublicvoidonSuccess(File file, Call call, Response response){// file 即為文件數(shù)據(jù)，文件保存在指定目錄}@OverridepublicvoiddownloadProgress(longcurrentSize,longtotalSize,floatprogress,longnetworkSpeed){//這里回調(diào)下載進(jìn)度(該回調(diào)在主線程,可以直接更新ui)}? ? });
4.普通Post，直接上傳String類型的文本
一般此種用法用于與服務(wù)器約定的數(shù)據(jù)格式，當(dāng)使用該方法時(shí)，params中的參數(shù)設(shè)置是無效的，所有參數(shù)均需要通過需要上傳的文本中指定，此外，額外指定的header參數(shù)仍然保持有效。
OkGo.post(Urls.URL_TEXT_UPLOAD)//.tag(this)//.upString("這是要上傳的長(zhǎng)文本數(shù)據(jù)！")//.execute(newStringCallback() {@OverridepublicvoidonSuccess(String s, Call call, Response response){//上傳成功}@OverridepublicvoidupProgress(longcurrentSize,longtotalSize,floatprogress,longnetworkSpeed){//這里回調(diào)上傳進(jìn)度(該回調(diào)在主線程,可以直接更新ui)}? ? });
5.普通Post，直接上傳Json類型的文本
該方法與postString沒有本質(zhì)區(qū)別，只是數(shù)據(jù)格式是json,一般來說，需要自己創(chuàng)建一個(gè)實(shí)體bean或者一個(gè)map，把需要的參數(shù)設(shè)置進(jìn)去，然后通過三方的Gson或者fastjson轉(zhuǎn)換成json字符串，最后直接使用該方法提交到服務(wù)器。
HashMap params =newHashMap<>();params.put("key1","value1");params.put("key2","這里是需要提交的json格式數(shù)據(jù)");params.put("key3","也可以使用三方工具將對(duì)象轉(zhuǎn)成json字符串");params.put("key4","其實(shí)你怎么高興怎么寫都行");JSONObject jsonObject =newJSONObject(params);? ? ? ? OkGo.post(Urls.URL_TEXT_UPLOAD)//.tag(this)//.upJson(jsonObject.toString())//.execute(newStringCallback() {@OverridepublicvoidonSuccess(String s, Call call, Response response){//上傳成功}@OverridepublicvoidupProgress(longcurrentSize,longtotalSize,floatprogress,longnetworkSpeed){//這里回調(diào)上傳進(jìn)度(該回調(diào)在主線程,可以直接更新ui)}? ? });
6.https請(qǐng)求(證書可以在全局初始化的時(shí)候設(shè)置,不用每次請(qǐng)求設(shè)置一遍)
OkGo.get("https://kyfw.12306.cn/otn")//.tag(this)//.headers("Connection","close")//如果對(duì)于部分自簽名的https訪問不成功，需要加上該控制頭.headers("header1","headerValue1")//.params("param1","paramValue1")////? ? ? .setCertificates()? ? ? ? ? ? ? ? ? ? ? ? ? ? //方法一：信任所有證書//? ? ? .setCertificates(getAssets().open("srca.cer")) //方法二：也可以設(shè)置https證書//方法三：傳入bks證書,密碼,和cer證書,支持雙向加密//? ? ? .setCertificates(getAssets().open("aaaa.bks"), "123456", getAssets().open("srca.cer")).execute(newHttpsCallBack(this));
7.請(qǐng)求功能的所有配置講解
以下代碼包含了以下內(nèi)容：
一次普通請(qǐng)求所有能配置的參數(shù)，真實(shí)使用時(shí)不需要配置這么多，按自己的需要選擇性的使用即可
params添加參數(shù)的時(shí)候,最后一個(gè)isReplace為可選參數(shù),默認(rèn)為true,即代表相同key的時(shí)候,后添加的會(huì)覆蓋先前添加的
多文件和多參數(shù)的表單上傳，同時(shí)支持進(jìn)度監(jiān)聽
自簽名網(wǎng)站https的訪問，調(diào)用setCertificates方法即可
為單個(gè)請(qǐng)求設(shè)置超時(shí)，比如涉及到文件的需要設(shè)置讀寫等待時(shí)間多一點(diǎn)。
Cookie一般情況下只需要在初始化的時(shí)候調(diào)用setCookieStore即可實(shí)現(xiàn)cookie的自動(dòng)管理，如果特殊業(yè)務(wù)需要，需要手動(dòng)額外向服務(wù)器傳遞自定義的cookie，可以在每次請(qǐng)求的時(shí)候調(diào)用addCookie方法，該方法提供了3個(gè)重載形式，可以根據(jù)自己的需要選擇使用。
OkGo.get(Urls.URL_METHOD)// 請(qǐng)求方式和請(qǐng)求url, get請(qǐng)求不需要拼接參數(shù)，支持get，post，put，delete，head，options請(qǐng)求.tag(this)// 請(qǐng)求的 tag, 主要用于取消對(duì)應(yīng)的請(qǐng)求.connTimeOut(10000)// 設(shè)置當(dāng)前請(qǐng)求的連接超時(shí)時(shí)間.readTimeOut(10000)// 設(shè)置當(dāng)前請(qǐng)求的讀取超時(shí)時(shí)間.writeTimeOut(10000)// 設(shè)置當(dāng)前請(qǐng)求的寫入超時(shí)時(shí)間.cacheKey("cacheKey")// 設(shè)置當(dāng)前請(qǐng)求的緩存key,建議每個(gè)不同功能的請(qǐng)求設(shè)置一個(gè).cacheTime(5000)// 緩存的過期時(shí)間,單位毫秒.cacheMode(CacheMode.FIRST_CACHE_THEN_REQUEST)// 緩存模式，詳細(xì)請(qǐng)看第四部分，緩存介紹.setCertificates(getAssets().open("srca.cer"))// 自簽名https的證書，可變參數(shù)，可以設(shè)置多個(gè).addInterceptor(interceptor)// 添加自定義攔截器.headers("header1","headerValue1")// 添加請(qǐng)求頭參數(shù).headers("header2","headerValue2")// 支持多請(qǐng)求頭參數(shù)同時(shí)添加.params("param1","paramValue1")// 添加請(qǐng)求參數(shù).params("param2","paramValue2")// 支持多請(qǐng)求參數(shù)同時(shí)添加.params("file1",newFile("filepath1"))// 可以添加文件上傳.params("file2",newFile("filepath2"))// 支持多文件同時(shí)添加上傳.addUrlParams("key", List values)//這里支持一個(gè)key傳多個(gè)參數(shù).addFileParams("key", List files)//這里支持一個(gè)key傳多個(gè)文件.addFileWrapperParams("key", List fileWrappers)//這里支持一個(gè)key傳多個(gè)文件.addCookie("aaa","bbb")// 這里可以傳遞自己想傳的Cookie.addCookie(cookie)// 可以自己構(gòu)建cookie.addCookies(cookies)// 可以一次傳遞批量的cookie//這里給出的泛型為 ServerModel，同時(shí)傳遞一個(gè)泛型的 class對(duì)象，即可自動(dòng)將數(shù)據(jù)結(jié)果轉(zhuǎn)成對(duì)象返回.execute(newDialogCallback(this) {@OverridepublicvoidonBefore(BaseRequest request){// UI線程 請(qǐng)求網(wǎng)絡(luò)之前調(diào)用// 可以顯示對(duì)話框，添加/修改/移除 請(qǐng)求參數(shù)}@OverridepublicServerModelconvertSuccess(Response response)throwsException{// 子線程，可以做耗時(shí)操作// 根據(jù)傳遞進(jìn)來的 response 對(duì)象，把數(shù)據(jù)解析成需要的 ServerModel 類型并返回// 可以根據(jù)自己的需要，拋出異常，在onError中處理returnnull;? ? ? ? }@OverridepublicvoidparseError(Call call, IOException e){// 子線程，可以做耗時(shí)操作// 用于網(wǎng)絡(luò)錯(cuò)誤時(shí)在子線程中執(zhí)行數(shù)據(jù)耗時(shí)操作,子類可以根據(jù)自己的需要重寫此方法}@OverridepublicvoidonSuccess(ServerModel serverModel, Call call, Response response){// UI 線程，請(qǐng)求成功后回調(diào)// ServerModel 返回泛型約定的實(shí)體類型參數(shù)// call? ? ? ? 本次網(wǎng)絡(luò)的請(qǐng)求信息，如果需要查看請(qǐng)求頭或請(qǐng)求參數(shù)可以從此對(duì)象獲取// response? ? 本次網(wǎng)絡(luò)訪問的結(jié)果對(duì)象，包含了響應(yīng)頭，響應(yīng)碼等? ? ? }@OverridepublicvoidonCacheSuccess(ServerModel serverModel, Call call){// UI 線程，緩存讀取成功后回調(diào)// serverModel 返回泛型約定的實(shí)體類型參數(shù)// call? ? ? ? 本次網(wǎng)絡(luò)的請(qǐng)求信息}@OverridepublicvoidonError(Call call, Response response, Exception e){// UI 線程，請(qǐng)求失敗后回調(diào)// call? ? ? ? 本次網(wǎng)絡(luò)的請(qǐng)求對(duì)象，可以根據(jù)該對(duì)象拿到 request// response? ? 本次網(wǎng)絡(luò)訪問的結(jié)果對(duì)象，包含了響應(yīng)頭，響應(yīng)碼等? ? ? ? ? // e? ? ? ? ? 本次網(wǎng)絡(luò)訪問的異常信息，如果服務(wù)器內(nèi)部發(fā)生了錯(cuò)誤，響應(yīng)碼為 404,或大于等于500}@OverridepublicvoidonCacheError(Call call, Exception e){// UI 線程，讀取緩存失敗后回調(diào)// call? ? ? ? 本次網(wǎng)絡(luò)的請(qǐng)求對(duì)象，可以根據(jù)該對(duì)象拿到 request// e? ? ? ? ? 本次網(wǎng)絡(luò)訪問的異常信息，如果服務(wù)器內(nèi)部發(fā)生了錯(cuò)誤，響應(yīng)碼為 404,或大于等于500}@OverridepublicvoidonAfter(ServerModel serverModel, Exception e){// UI 線程，請(qǐng)求結(jié)束后回調(diào)，無論網(wǎng)絡(luò)請(qǐng)求成功還是失敗，都會(huì)調(diào)用，可以用于關(guān)閉顯示對(duì)話框// ServerModel 返回泛型約定的實(shí)體類型參數(shù)，如果網(wǎng)絡(luò)請(qǐng)求失敗，該對(duì)象為 null// e? ? ? ? ? 本次網(wǎng)絡(luò)訪問的異常信息，如果服務(wù)器內(nèi)部發(fā)生了錯(cuò)誤，響應(yīng)碼為 404,或大于等于500}@OverridepublicvoidupProgress(longcurrentSize,longtotalSize,floatprogress,longnetworkSpeed){// UI 線程，文件上傳過程中回調(diào)，只有請(qǐng)求方式包含請(qǐng)求體才回調(diào)（GET,HEAD不會(huì)回調(diào)）// currentSize? 當(dāng)前上傳的大?。▎挝蛔止?jié)）// totalSize 需要上傳的總大?。▎挝蛔止?jié)）// progress? ? 當(dāng)前上傳的進(jìn)度，范圍 0.0f ~ 1.0f// networkSpeed 當(dāng)前上傳的網(wǎng)速（單位秒）}@OverridepublicvoiddownloadProgress(longcurrentSize,longtotalSize,floatprogress,longnetworkSpeed){// UI 線程，文件下載過程中回調(diào)//參數(shù)含義同 上傳相同}? ? });
8.取消請(qǐng)求
每個(gè)請(qǐng)求前都設(shè)置了一個(gè)參數(shù)tag，取消則通過OkGo.cancel(tag)執(zhí)行。
例如：在Activity中，當(dāng)Activity銷毀取消請(qǐng)求，可以在onDestory里面統(tǒng)一取消。
@OverrideprotectedvoidonDestroy(){super.onDestroy();//根據(jù) Tag 取消請(qǐng)求OkGo.getInstance().cancelTag(this);? ? }
9.同步的請(qǐng)求
execute方法不傳入callback即為同步的請(qǐng)求，返回Response對(duì)象，需要自己解析
Response response = OkGo.get("http://www.baidu.com")//.tag(this)//.headers("aaa","111")//.params("bbb","222")? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? .execute();
10.參數(shù)的順序
添加header和param的方法各有三個(gè)地方,在提交的時(shí)候,他們是有順序的,如果對(duì)提交順序有需要的話,請(qǐng)注意這里
第一個(gè)地方,全局初始化時(shí),使用OkGo.getInstance().addCommonHeaders(),OkGo.getInstance().addCommonParams()?添加
HttpHeaders headers =newHttpHeaders();? ? headers.put("HKAAA","HVAAA");? ? headers.put("HKBBB","HVBBB");? ? HttpParams params =newHttpParams();? ? params.put("PKAAA","PVAAA");? ? params.put("PKBBB","PVBBB");? ? ? ? OkGo.getInstance()? ? ? ? ? ? ? .addCommonHeaders(headers)//設(shè)置全局公共頭.addCommonParams(params);//設(shè)置全局公共參數(shù)
第二個(gè)地方,callback的onBefore方法中添加
publicabstractclassCommonCallbackextendsAbsCallback{@OverridepublicvoidonBefore(BaseRequest request){super.onBefore(request);? ? ? ? ? ? ? ? ? ? ? ? request.headers("HKCCC","HVCCC")//.headers("HKDDD","HVDDD")//.params("PKCCC","PVCCC")//.params("PKDDD","PVDDD")//}? ? }
第三個(gè)地方,執(zhí)行網(wǎng)絡(luò)請(qǐng)求的時(shí)候添加
OkGo.get(Urls.URL_METHOD)//.tag(this)//.headers("HKEEE","HVEEE")//.headers("HKFFF","HVFFF")//.params("PKEEE","PVEEE")//.params("PKFFF","PVFFF")//.execute(newMethodCallBack<>(this, ServerModel.class));
那么,最終執(zhí)行請(qǐng)求的參數(shù)的添加順序?yàn)?/p>
Header順序: HKAAA -> HKBBB -> HKEEE -> HKFFF -> HKCCC -> HKDDD
Params順序: PKAAA -> PKBBB -> PKEEE -> PKFFF -> PKCCC -> PKDDD
總結(jié)一句話就是,全局添加的在最開始,callback添加的在最后,請(qǐng)求添加的在中間
三、自定義CallBack使用
目前內(nèi)部提供的包含AbsCallback,?StringCallBack?,BitmapCallback?,FileCallBack?,可以根據(jù)自己的需求去自定義Callback
AbsCallback: 所有回調(diào)的父類，抽象類
StringCallBack：如果返回值類型是純文本數(shù)據(jù)，即可使用該回調(diào)
BitmapCallback：如果請(qǐng)求的是圖片數(shù)據(jù)，則可以使用該回調(diào)
FileCallBack：如果要做文件下載，則必須使用該回調(diào)，內(nèi)部封裝了關(guān)于文件下載進(jìn)度回調(diào)的方法
該網(wǎng)絡(luò)框架的核心使用方法即為Callback的繼承使用，詳細(xì)請(qǐng)看 Demo 源碼中callback包下的代碼。
因?yàn)椴煌捻?xiàng)目需求，可能對(duì)數(shù)據(jù)格式進(jìn)行了不同的封裝，于是在 Demo 中的進(jìn)行了詳細(xì)的代碼示例，以下是詳細(xì)介紹：
JsonCallback：繼承自AbsCallback,一般來說，服務(wù)器返回的響應(yīng)碼都包含 code，msg，data 三部分，在此根據(jù)自己的業(yè)務(wù)需要完成相應(yīng)的邏輯判斷，并對(duì)數(shù)據(jù)進(jìn)行解析，可以使用?Gson?或者?fastjson，將解析的對(duì)象返回。
DialogCallback：繼承自JsonCallback,對(duì)需要在網(wǎng)絡(luò)請(qǐng)求的時(shí)候顯示對(duì)話框，使用該回調(diào)。
StringDialogCallback：繼承自EncryptCallback,如果網(wǎng)絡(luò)返回的數(shù)據(jù)只是純文本，使用該回調(diào)
BitmapDialogCallback?：繼承自BitmapCallback,如果網(wǎng)絡(luò)返回的是Bitmap對(duì)象，使用該回調(diào)
DownloadFileCallBack?：繼承自FileCallback,如果需要做文件下載，使用該回調(diào)
以上基本是包含了大部分的業(yè)務(wù)邏輯，具體情況請(qǐng)參照demo示例，根據(jù)業(yè)務(wù)需求修改！
四、緩存的使用
使用緩存前，必須讓緩存的數(shù)據(jù)javaBean對(duì)象實(shí)現(xiàn)Serializable接口，否者會(huì)報(bào)NotSerializableException。
因?yàn)榫彺娴脑硎菍?duì)象序列化后直接寫入 數(shù)據(jù)庫(kù)中，如果不實(shí)現(xiàn)Serializable接口，會(huì)導(dǎo)致對(duì)象無法序列化，進(jìn)而無法寫入到數(shù)據(jù)庫(kù)中，也就達(dá)不到緩存的效果。
對(duì)于DEFAULT緩存模式,超時(shí)時(shí)間是無效的,因?yàn)樵撃Ｊ绞峭耆裱瓨?biāo)準(zhǔn)的http協(xié)議的,緩存時(shí)間是依靠服務(wù)端響應(yīng)頭來控制,所以客戶端的cacheTime參數(shù)無效
目前提供了五種CacheMode緩存模式,每種緩存模式都可以指定對(duì)應(yīng)的CacheTime,不同的模式會(huì)有不同的方法回調(diào)順序,詳細(xì)請(qǐng)看上面第二部分的callback執(zhí)行順序
NO_CACHE: 不使用緩存,該模式下,cacheKey,cacheTime?參數(shù)均無效
DEFAULT: 按照HTTP協(xié)議的默認(rèn)緩存規(guī)則，例如有304響應(yīng)頭時(shí)緩存。
REQUEST_FAILED_READ_CACHE：先請(qǐng)求網(wǎng)絡(luò)，如果請(qǐng)求網(wǎng)絡(luò)失敗，則讀取緩存，如果讀取緩存失敗，本次請(qǐng)求失敗。
IF_NONE_CACHE_REQUEST：如果緩存不存在才請(qǐng)求網(wǎng)絡(luò)，否則使用緩存。
FIRST_CACHE_THEN_REQUEST：先使用緩存，不管是否存在，仍然請(qǐng)求網(wǎng)絡(luò)。
無論對(duì)于哪種緩存模式，都可以指定一個(gè)cacheKey，建議針對(duì)不同需要緩存的頁(yè)面設(shè)置不同的cacheKey，如果相同，會(huì)導(dǎo)致數(shù)據(jù)覆蓋。
五、混淆
#okgo? ? -dontwarn com.lzy.okgo.**? ? -keepclasscom.lzy.okgo.**{*;}? ? ? ? #okrx? ? -dontwarn com.lzy.okrx.**? ? -keepclasscom.lzy.okrx.**{*;}? ? ? ? #okserver? ? -dontwarn com.lzy.okserver.**? ? -keepclasscom.lzy.okserver.**{*;}? ? ? ? #okhttp? ? -dontwarn okhttp3.**? ? -keepclassokhttp3.**{*;}? ? ? ? #okio? ? -dontwarn okio.**? ? -keepclassokio.**{*;}
