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