OkGO使用详解
1.支持的常用功能
- 一般的 get,post,put,delete,head,options請求
- 基于Post的大文本數(shù)據(jù)上傳，postString(),postJson()等
- 多文件和多參數(shù)統(tǒng)一的表單上傳（允許監(jiān)聽上傳進(jìn)度）
- 支持一個key上傳一個文件，也可以一個Key上傳多個文件
- 大文件下載和下載進(jìn)度回調(diào)
- 大文件上傳和上傳進(jìn)度回調(diào)
- 支持cookie的內(nèi)存存儲和持久化存儲，支持傳遞自定義cookie
- 提供網(wǎng)絡(luò)緩存功能，默認(rèn)支持304緩存協(xié)議，并額外擴(kuò)展了三種本地緩存模式
- 支持301、302重定向
- 支持鏈?zhǔn)秸{(diào)用
- 支持可信證書和自簽名證書的https訪問
- 支持根據(jù)Tag取消網(wǎng)絡(luò)請求
- 支持自定義泛型Callback，自動根據(jù)泛型返回對象
2.支持的擴(kuò)展功能
- 統(tǒng)一的文件下載管理（DownloadManager）
默認(rèn)使用的是 get 請求，同時下載數(shù)量為3個，支持?jǐn)帱c下載，斷點信息使用ORMLite數(shù)據(jù)庫框架保存，默認(rèn)下載路徑/storage/emulated/0/download，下載路徑和下載數(shù)量都可以在代碼中配置，下載管理使用了服務(wù)提高線程優(yōu)先級，避免后臺下載時被系統(tǒng)回收。
當(dāng)你的項目需要做大量的下載的時候，并且多個頁面需要監(jiān)聽下載進(jìn)度，使用該擴(kuò)展讓你更方便。原生支持下載任務(wù)的開始、暫停、停止、出錯、完成五個狀態(tài)，當(dāng)同時下載任務(wù)數(shù)量超過3個（可代碼動態(tài)設(shè)置）時，后續(xù)任務(wù)自動等待，當(dāng)有任務(wù)下載完成時，等待任務(wù)按照優(yōu)先級自動開始下載。 - 統(tǒng)一的文件上傳管理（UploadManager）
默認(rèn)使用的是 post 上傳請求，該上傳管理為簡單管理，不支持?jǐn)帱c續(xù)傳和分片上傳，只是簡單的將所有上傳任務(wù)使用線程池進(jìn)行了統(tǒng)一管理，默認(rèn)同時上傳數(shù)量為1個。由于斷點分片上傳的技術(shù)需要大量的服務(wù)端代碼配合，同時也會極大的增加客戶端代碼量，所以綜合考慮，該框架不做實現(xiàn)。如果確實有特殊需要，可以自己做擴(kuò)展。
2.2 統(tǒng)一的文件上傳管理(UploadManager)
- 結(jié)合OkHttpUtils 的request進(jìn)行網(wǎng)絡(luò)請求,支持與OkHttpUtils 保持相同的全局公共參數(shù),同時支持請求傳遞參數(shù)
- 上傳只能使用Post,?Put,?Delete,?Options?這四種請求,不支持Get,?Head
- 該上傳管理為簡單管理，不支持?jǐn)帱c續(xù)傳或分片上傳，只是簡單的將所有上傳任務(wù)使用線程池進(jìn)行了統(tǒng)一管理
- 默認(rèn)同時上傳數(shù)量為1個,該數(shù)列可以在代碼中配置修改
- 由于斷點分片上傳的技術(shù)需要大量的服務(wù)端代碼配合，同時也會極大的增加客戶端代碼量，所以綜合考慮，該框架不做實現(xiàn)。如果確實有特殊需要，可以自己做擴(kuò)展。
項目的效果圖如下：
項目主頁
請求詳細(xì)信息
下載管理列表頁
下載管理詳情頁
上傳管理和圖片選擇
3.如何選擇網(wǎng)絡(luò)框架
說了這么多功能，我們來看看為什么要使用OkHttpUtils這個框架。
首先目前主流的幾個網(wǎng)絡(luò)框架
- android-async-http
- xUtils
- volley
- retrofit
- okhttp
在此引用知乎上Stay Zhang的回答：
我們來先說一個常識性的錯誤：volley, retrofit, android-async-http 幫你封裝了具體的請求，線程切換以及數(shù)據(jù)轉(zhuǎn)換。而OkHttp 是基于http協(xié)議封裝的一套請求客戶端，雖然它也可以開線程，但根本上它更偏向真正的請求，跟HttpClient, HttpUrlConnection的職責(zé)是一樣的。
所以不要混淆。
-----以下純個人主觀見解
首先，我想即使你單純使用OkHttp，還是會再包一層的，這樣就等價于Volley之流的框架，只是封裝的好與壞而已。
android-async-http內(nèi)部實現(xiàn)是基于HttpClient, 想必你肯定知道6.0之后HttpClient是不是系統(tǒng)自帶的了，不過它在最近的更新中將HttpClient的所有代碼copy了一份進(jìn)來，所以還能使用。
Volley是官方出的，volley在設(shè)計的時候是將具體的請求客戶端做了下封裝：HurlStack，也就是說可以支持HttpUrlConnection, HttpClient, OkHttp，相當(dāng)于模版模式吧，這樣解耦還是非常方便的，可以隨意切換，如果你之前使用過Volley，并習(xí)慣使用，那直接寫個OkHttp擴(kuò)展就行了。
Retrofit因為也是square出的，所以大家可能對它更崇拜些。Retrofit的跟Volley是一個套路，但解耦的更徹底:比方說通過注解來配置請求參數(shù)，通過工廠來生成CallAdapter，Converter，你可以使用不同的請求適配器(CallAdapter), 比方說RxJava，Java8, Guava。你可以使用不同的反序列化工具(Converter)，比方說json, protobuff, xml, moshi等等。關(guān)鍵是想要用好這個框架，最好是和RxJava聯(lián)用，否者和普通的網(wǎng)絡(luò)框架也沒什么區(qū)別，而對于RxJava，特別team人數(shù)多的情況下，總得有個完全精通的吧，萬一掉坑里了呢。。。
4.OkHttpUtils的優(yōu)勢
- 優(yōu)勢一：性能高，專注于簡單易用的網(wǎng)絡(luò)請求，使用主流的okhttp進(jìn)行封裝，對于okhttp大家都知道，在Android4.4的源碼中可以看到HttpURLConnection已經(jīng)替換成OkHttp實現(xiàn)了，并且支持HTTP2/SPDY黑科技，支持socket自動選擇最好路線，并支持自動重連，擁有自動維護(hù)的socket連接池，減少握手次數(shù)，擁有隊列線程池，輕松寫并發(fā)。
- 優(yōu)勢二：特有的網(wǎng)絡(luò)緩存模式，是大多數(shù)網(wǎng)絡(luò)框架所不具備的，說一個應(yīng)用場景，老板說我們的app不僅需要在有網(wǎng)的情況下展示最新的網(wǎng)絡(luò)數(shù)據(jù)，還要在沒網(wǎng)的情況下使用緩存數(shù)據(jù)，這時候是不是項目中出現(xiàn)了大量的代碼判斷當(dāng)前網(wǎng)絡(luò)狀況，根據(jù)不同的狀態(tài)保存不同的數(shù)據(jù)，然后決定是否使用緩存。細(xì)想一下，這是個通用的寫法，于是OkHttpUtils提供了四種緩存模式，讓你不用關(guān)心緩存的實現(xiàn)，而專注于數(shù)據(jù)的處理。（具體緩存的使用方法請看最后第四章節(jié)）。
- 優(yōu)勢三：方便易用的擴(kuò)展接口，可以添加全局的公共參數(shù)，全局?jǐn)r截器，全局超時時間，更可以對單個請求定制攔截器，超時時間，請求參數(shù)修改等等，在使用上更是方便，原生支持的鏈?zhǔn)秸{(diào)用讓你的請求更加清晰。
- 優(yōu)勢四：強(qiáng)大的Cookie保持策略，我們知道在客戶端對cookie的獲取是個不太簡單的事情，特別是還要處理cookie的過期時間，持久化策略等等，OkHttpUtils幫你徹底解決Cookie的難題，默認(rèn)擁有內(nèi)存存儲和持久化存儲兩種實現(xiàn)，cookie全程自動管理，并且提供了額外的addCookie方式，允許介入到自動管理的過程中，添加你想創(chuàng)建的任何cookie。
所以就說這么多啦，選最適合項目的，選大多數(shù)人選擇的，選簡單易用的，就這么個標(biāo)準(zhǔn)，而OkHttpUtils正是在這種情況下誕生啦！！
5.使用方法
對于Android Studio的用戶，可以選擇添加:
compile 'com.lzy.net:okhttputils:1.8.1' //可以單獨使用，不需要依賴下方的擴(kuò)展包compile 'com.lzy.net:okhttpserver:1.0.3' //擴(kuò)展了下載管理和上傳管理，根據(jù)需要添加compile 'com.lzy.net:okhttputils:+' //版本號使用 + 可以自動引用最新版compile 'com.lzy.net:okhttpserver:+' //版本號使用 + 可以自動引用最新版
- 為了方便大家使用，更加通俗的理解http的網(wǎng)絡(luò)協(xié)議，建議做網(wǎng)絡(luò)請求的時候，對每個請求抓包后查看請求信息和響應(yīng)信息。
- 如果是 Windows 操作系統(tǒng)，可以使用?Fiddler?對手機(jī)的請求進(jìn)行抓包查看。
- 如果是 Mac OS 操作系統(tǒng)，可以使用?Charles?對手機(jī)的請求進(jìn)行抓包查看。
- 具體的下載地址和抓包配置方法，我這就不提供了，請自行百度或谷歌。
6.使用注意事項
- okhttputils使用的okhttp的版本是最新的 3.4.1 版本，和以前的 2.x 的版本可能會存在沖突。
- okhttpserver是對okhttputils的擴(kuò)展，統(tǒng)一了下載管理和上傳管理，對項目有需要做統(tǒng)一下載的可以考慮使用該擴(kuò)展，不需要的可以直接使用okhttputils即可。
- 對于緩存模式使用，需要與返回對象相關(guān)的所有javaBean必須實現(xiàn)Serializable接口，否者會報NotSerializableException。
- 使用緩存時，如果不指定cacheKey，默認(rèn)是用url帶參數(shù)的全路徑名為cacheKey。
- 使用該網(wǎng)絡(luò)框架時，必須要在 Application 中做初始化?OkHttpUtils.init(this);。
一、全局配置
一般在 Aplication，或者基類中，只需要調(diào)用一次即可，可以配置調(diào)試開關(guān)，全局的超時時間，公共的請求頭和請求參數(shù)等信息，所有的請求參數(shù)都支持中文，
@Overridepublic void onCreate() {super.onCreate();HttpHeaders headers = new HttpHeaders();headers.put("commonHeaderKey1", "commonHeaderValue1"); //所有的 header 都 不支持 中文headers.put("commonHeaderKey2", "commonHeaderValue2");HttpParams params = new HttpParams();params.put("commonParamsKey1", "commonParamsValue1"); //所有的 params 都 支持 中文params.put("commonParamsKey2", "這里支持中文參數(shù)");//必須調(diào)用初始化OkHttpUtils.init(this);//以下都不是必須的，根據(jù)需要自行選擇OkHttpUtils.getInstance()//.debug("OkHttpUtils") //是否打開調(diào)試.setConnectTimeout(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的連接超時時間.setReadTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的讀取超時時間.setWriteTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的寫入超時時間//.setCookieStore(new MemoryCookieStore()) //cookie使用內(nèi)存緩存（app退出后，cookie消失）//.setCookieStore(new PersistentCookieStore()) //cookie持久化存儲，如果cookie不過期，則一直有效.addCommonHeaders(headers) //設(shè)置全局公共頭.addCommonParams(params); //設(shè)置全局公共參數(shù)}二、普通請求
1.基本的網(wǎng)絡(luò)請求
OkHttpUtils.get(Urls.URL_METHOD) // 請求方式和請求url.tag(this) // 請求的 tag, 主要用于取消對應(yīng)的請求.cacheKey("cacheKey") // 設(shè)置當(dāng)前請求的緩存key,建議每個不同功能的請求設(shè)置一個.cacheMode(CacheMode.DEFAULT) // 緩存模式，詳細(xì)請看緩存介紹.execute(new JsonCallback<RequestInfo>(RequestInfo.class) {@Overridepublic void onResponse(boolean isFromCache, RequestInfo requestInfo, Request request, @Nullable Response response) {// requestInfo 對象即為所需要的結(jié)果對象}});2.請求 Bitmap 對象
OkHttpUtils.get(Urls.URL_IMAGE)//.tag(this)//.execute(new BitmapCallback() {@Overridepublic void onResponse(boolean isFromCache, Bitmap bitmap, Request request, @Nullable Response response) {// bitmap 即為返回的圖片數(shù)據(jù)}});3.請求 文件下載
OkHttpUtils.get(Urls.URL_DOWNLOAD)//.tag(this)//.execute(new FileCallback("/sdcard/temp/", "file.jpg") { //文件下載時，需要指定下載的文件目錄和文件名@Overridepublic void onResponse(boolean isFromCache, File file, Request request, @Nullable Response response) {// file 即為文件數(shù)據(jù)，文件保存在指定布幕}});4.普通Post，直接上傳String類型的文本
一般此種用法用于與服務(wù)器約定的數(shù)據(jù)格式，當(dāng)使用該方法時，params中的參數(shù)設(shè)置是無效的，所有參數(shù)均需要通過需要上傳的文本中指定，此外，額外指定的header參數(shù)仍然保持有效。
OkHttpUtils.post(Urls.URL_TEXT_UPLOAD)//.tag(this)//.postString("這是要上傳的長文本數(shù)據(jù)！")//.execute(new StringCallback() {@Overridepublic void onResponse(boolean isFromCache, String s, Request request, @Nullable Response response) {//上傳成功}});5.普通Post，直接上傳Json類型的文本
該方法與postString沒有本質(zhì)區(qū)別，只是數(shù)據(jù)格式是json,一般來說，需要自己創(chuàng)建一個實體bean或者一個map，把需要的參數(shù)設(shè)置進(jìn)去，然后通過三方的Gson或者fastjson轉(zhuǎn)換成json字符串，最后直接使用該方法提交到服務(wù)器。
OkHttpUtils.post(Urls.URL_TEXT_UPLOAD)//.tag(this)//.postJson("{\"des\": \"這里面要寫標(biāo)準(zhǔn)的json格式數(shù)據(jù)\"}")//.execute(new StringCallback() {@Overridepublic void onResponse(boolean isFromCache, String s, Request request, @Nullable Response response) {//上傳成功}});6.請求功能的所有配置講解
以下代碼包含了以下內(nèi)容：
- 一次普通請求所有能配置的參數(shù)，真實使用時不需要配置這么多，按自己的需要選擇性的使用即可
- 多文件和多參數(shù)的表單上傳，同時支持進(jìn)度監(jiān)聽
- 自簽名網(wǎng)站https的訪問，調(diào)用setCertificates方法即可
- 為單個請求設(shè)置超時，比如涉及到文件的需要設(shè)置讀寫等待時間多一點。
- Cookie一般情況下只需要在初始化的時候調(diào)用setCookieStore即可實現(xiàn)cookie的自動管理，如果特殊業(yè)務(wù)需要，需要手動額外向服務(wù)器傳遞自定義的cookie，可以在每次請求的時候調(diào)用addCookie方法，該方法提供了3個重載形式，可以根據(jù)自己的需要選擇使用。
7.取消請求
每個請求前都設(shè)置了一個參數(shù)tag，取消則通過OkHttpUtils.cancel(tag)執(zhí)行。
例如：在Activity中，當(dāng)Activity銷毀取消請求，可以在onDestory里面統(tǒng)一取消。
8.同步的請求
execute方法不傳入callback即為同步的請求，返回Response對象，需要自己解析
Response response = OkHttpUtils.get("http://www.baidu.com")//.tag(this)//.headers("aaa", "111")//.params("bbb", "222").execute();三、自定義CallBack使用
目前內(nèi)部提供的包含AbsCallback,?StringCallBack?,BitmapCallback?,FileCallBack?,可以根據(jù)自己的需求去自定義Callback
- AbsCallback: 所有回調(diào)的父類，抽象類
- StringCallBack：如果返回值類型是純文本數(shù)據(jù)，即可使用該回調(diào)
- BitmapCallback：如果請求的是圖片數(shù)據(jù)，則可以使用該回調(diào)
- FileCallBack：如果要做文件下載，則必須使用該回調(diào)，內(nèi)部封裝了關(guān)于文件下載進(jìn)度回調(diào)的方法
該網(wǎng)絡(luò)框架的核心使用方法即為Callback的繼承使用，詳細(xì)請看 Demo 源碼中callback包下的代碼。
因為不同的項目需求，可能對數(shù)據(jù)格式進(jìn)行了不同的封裝，于是在 Demo 中的進(jìn)行了詳細(xì)的代碼示例，以下是詳細(xì)介紹：
- CommonCallback:繼承自AbsCallback,主要作用是做全局共同請求參數(shù)的添加，同樣也可以在第一步全局配置的時候設(shè)置，效果一樣。
- EncryptCallback：繼承自CommonCallback,主要功能是做 Url 參數(shù)加密，對每個請求的參數(shù)進(jìn)行編碼，防止攔截數(shù)據(jù)包，篡改數(shù)據(jù)。
- JsonCallback：繼承自EncryptCallback,一般來說，服務(wù)器返回的響應(yīng)碼都包含 code，msg，data 三部分，在此根據(jù)自己的業(yè)務(wù)需要完成相應(yīng)的邏輯判斷，并對數(shù)據(jù)進(jìn)行解析，可以使用?Gson?或者?fastjson，將解析的對象返回。
- DialogCallback：繼承自JsonCallback,對需要在網(wǎng)絡(luò)請求的時候顯示對話框，使用該回調(diào)。
- StringDialogCallback：繼承自EncryptCallback,如果網(wǎng)絡(luò)返回的數(shù)據(jù)只是純文本，使用該回調(diào)
- BitmapDialogCallback?：繼承自BitmapCallback,如果網(wǎng)絡(luò)返回的是Bitmap對象，使用該回調(diào)
- DownloadFileCallBack?：繼承自FileCallback,如果需要做文件下載，使用該回調(diào)
以上基本是包含了大部分的業(yè)務(wù)邏輯，具體情況請參照demo示例，根據(jù)業(yè)務(wù)需求修改！
四、緩存的使用
使用緩存前，必須讓緩存的數(shù)據(jù)javaBean對象實現(xiàn)Serializable接口，否者會報NotSerializableException。
因為緩存的原理是將對象序列化后直接寫入 數(shù)據(jù)庫中，如果不實現(xiàn)Serializable接口，會導(dǎo)致對象無法序列化，進(jìn)而無法寫入到數(shù)據(jù)庫中，也就達(dá)不到緩存的效果。
目前提供了四種CacheMode緩存模式
- DEFAULT: 按照HTTP協(xié)議的默認(rèn)緩存規(guī)則，例如有304響應(yīng)頭時緩存
- REQUEST_FAILED_READ_CACHE：先請求網(wǎng)絡(luò)，如果請求網(wǎng)絡(luò)失敗，則讀取緩存，如果讀取緩存失敗，本次請求失敗。該緩存模式的使用，會根據(jù)實際情況，導(dǎo)致onResponse,onError,onAfter三個方法調(diào)用不只一次，具體請在三個方法返回的參數(shù)中進(jìn)行判斷。
- IF_NONE_CACHE_REQUEST：如果緩存不存在才請求網(wǎng)絡(luò)，否則使用緩存。
- FIRST_CACHE_THEN_REQUEST：先使用緩存，不管是否存在，仍然請求網(wǎng)絡(luò)，如果網(wǎng)絡(luò)順利，會導(dǎo)致onResponse方法執(zhí)行兩次，第一次isFromCache為true，第二次isFromCache為false。使用時根據(jù)實際情況，對onResponse,onError,onAfter三個方法進(jìn)行具體判斷。
無論對于哪種緩存模式，都可以指定一個cacheKey，建議針對不同需要緩存的頁面設(shè)置不同的cacheKey，如果相同，會導(dǎo)致數(shù)據(jù)覆蓋。
文／廖子堯（簡書作者）
原文鏈接： http://www.jianshu.com/p/4c17956fe3b4
著作權(quán)歸作者所有，轉(zhuǎn)載請聯(lián)系作者獲得授權(quán)，并標(biāo)注“簡書作者”。
文／廖子堯（簡書作者）
原文鏈接：http://www.jianshu.com/p/4c17956fe3b4
著作權(quán)歸作者所有，轉(zhuǎn)載請聯(lián)系作者獲得授權(quán)，并標(biāo)注“簡書作者”。
總結(jié)
