okhttputils使用（zhuan）

OkHttpUtils

封裝了okhttp的網絡框架，支持大文件上傳下載，上傳進度回調，下載進度回調，表單上傳（多文件和多參數一塊兒上傳），鏈式調用，能夠自定義返回對象，支持Https和自簽名證書，支持cookie自動管理，支持四種緩存模式緩存網絡數據，支持30一、302重定向，擴展了統一的上傳管理和下載管理功能

該項目參考瞭如下項目：

• https://github.com/hongyangAndroid/okhttp-utils
• https://github.com/yanzhenjie/NoHttp
• https://github.com/wyouflf/xUtils

在此特別感謝上述做者，喜歡原做的能夠去使用原項目。同時歡迎你們下載體驗本項目，若是使用過程當中遇到什麼問題，歡迎反饋。

聯繫方式

• 郵箱地址： liaojeason@126.com
• QQ羣： 489873144 （建議使用QQ羣，郵箱使用較少，可能看的不及時）
• 本羣旨在爲使用個人github項目的人提供方便，若是遇到問題歡迎在羣裏提問。我的能力也有限，但願一塊兒學習一塊兒進步。

1.用法

• 爲了方便你們使用，更加通俗的理解http的網絡協議，建議作網絡請求的時候，對每一個請求抓包後查看請求信息和響應信息。
• 若是是 Windows 操做系統，可使用 Fiddler 對手機的請求進行抓包查看。
• 若是是 Mac OS 操做系統，可使用 Charles 對手機的請求進行抓包查看。
• 具體的下載地址和抓包配置方法，我這就不提供了，請自行百度或谷歌。

對於Eclipse不能運行項目的，提供了apk供直接運行

或者點擊下載Demo okhttputils_v1.8.0.apk。

本項目Demo的網絡請求是我本身的服務器，有時候可能不穩定，網速比較慢時請耐心等待。。

• 對於Android Studio的用戶，能夠選擇添加:

    compile 'com.lzy.net:okhttputils:1.8.0' //能夠單獨使用，不須要依賴下方的擴展包 compile 'com.lzy.net:okhttpserver:1.0.2' //擴展了下載管理和上傳管理，根據須要添加 或者 compile 'com.lzy.net:okhttputils:+' //版本號使用 + 能夠自動引用最新版 compile 'com.lzy.net:okhttpserver:+' //版本號使用 + 能夠自動引用最新版

• 對於Eclipse的用戶，能夠選擇添加 /jar 目錄下的:

    okhttputils-1.8.0.jar okhttpserver-1.0.2.jar

• 若是是以jar包的形式引入okhttpserver,須要在清單文件中額外註冊一個服務

    <service android:name="com.lzy.okhttpserver.download.DownloadService"/>

• 若是隻是用了okhttputils的jar,沒有使用okhttpserver的jar,那麼不須要註冊上面的服務

其中的圖片選擇是個人另外一個開源項目，徹底仿微信的圖片選擇庫，自帶 矩形圖片裁剪 和 圓形圖片裁剪 功能，有須要的能夠去下載使用，附上地址：https://github.com/jeasonlzy0216/ImagePicker

其中的九宮格控件也是個人開源項目,相似QQ空間，微信朋友圈，微博主頁等，展現圖片的九宮格控件，自動根據圖片的數量肯定圖片大小和控件大小，使用Adapter模式設置圖片，對外提供接口回調，使用接口加載圖片,支持任意的圖片加載框架,如 Glide,ImageLoader,Fresco,xUtils3,Picasso 等，支持點擊圖片全屏預覽大圖。附上地址：https://github.com/jeasonlzy0216/NineGridView

2.使用注意事項

• okhttputils使用的okhttp的版本是最新的 3.4.1 版本，和之前的 2.x 的版本可能會存在衝突。
• okhttpserver是對okhttputils的擴展，統一了下載管理和上傳管理，對項目有須要作統一下載的能夠考慮使用該擴展，不須要的能夠直接使用okhttputils便可。
• 對於緩存模式使用，須要與返回對象相關的全部javaBean必須實現Serializable接口，否者會報NotSerializableException。
• 使用緩存時，若是不指定cacheKey，默認是用url帶參數的全路徑名爲cacheKey。
• 使用該網絡框架時，必需要在 Application 中作初始化 OkHttpUtils.init(this);。

3.OkHttpUtils 目前支持

• 通常的 get,post,put,delete,head,options請求
• 基於Post的大文本數據上傳
• 多文件和多參數統一的表單上傳
• 支持一個key上傳一個文件，也能夠一個Key上傳多個文件
• 大文件下載和下載進度回調
• 大文件上傳和上傳進度回調
• 支持cookie的內存存儲和持久化存儲，支持傳遞自定義cookie
• 支持304緩存協議，擴展四種本地緩存模式,而且支持緩存時間控制
• 支持30一、302重定向
• 支持鏈式調用
• 支持可信證書和自簽名證書的https的訪問,支持雙向認證
• 支持根據Tag取消請求
• 支持自定義泛型Callback，自動根據泛型返回對象

4.OkHttpServer 擴展功能

4.1 統一的文件下載管理(DownloadManager)：

• 結合OkHttpUtils的request進行網絡請求,支持與OkHttpUtils保持相同的全局公共參數,同時支持請求傳遞參數
• 支持斷點下載，支持忽然斷網,強殺進程後,斷點依然有效
• 支持 下載 暫停 等待 中止 出錯 完成 六種下載狀態
• 全部下載任務按照taskKey區分,切記不一樣的任務必須使用不同的key,否者斷點會發生覆蓋
• 相同的下載url地址若是使用不同的taskKey,也會認爲是兩個下載任務
• 默認同時下載數量爲3個，默認下載路徑/storage/emulated/0/download，下載路徑和下載數量均可以在代碼中配置
• 下載文件名能夠本身定義,也能夠不傳,框架自動解析響應頭或者url地址得到文件名,若是都沒獲取到,使用default做爲文件名
• 下載管理使用了服務提升線程優先級，避免後臺下載時被系統回收

4.2 統一的文件上傳管理(UploadManager)

• 結合OkHttpUtils的request進行網絡請求,支持與OkHttpUtils保持相同的全局公共參數,同時支持請求傳遞參數
• 上傳只能使用Post, Put, Delete, Options 這四種請求,不支持Get, Head
• 該上傳管理爲簡單管理，不支持斷點續傳或分片上傳，只是簡單的將全部上傳任務使用線程池進行了統一管理
• 默認同時上傳數量爲1個,該數列能夠在代碼中配置修改

1、全局配置

通常在 Aplication，或者基類中，只須要調用一次便可，能夠配置調試開關，全局的超時時間，公共的請求頭和請求參數等信息

    @Override
    public 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"); //param支持中文,直接傳,不要本身編碼 params.put("commonParamsKey2", "這裏支持中文參數"); //-----------------------------------------------------------------------------------// //必須調用初始化 OkHttpUtils.init(this); //如下設置的全部參數是全局參數,一樣的參數能夠在請求的時候再設置一遍,那麼對於該請求來說,請求中的參數會覆蓋全局參數 //好處是全局參數統一,特定請求能夠特別定製參數 try { //如下都不是必須的，根據須要自行選擇,通常來講只須要 debug,緩存相關,cookie相關的 就能夠了 OkHttpUtils.getInstance() //打開該調試開關,控制檯會使用 紅色error 級別打印log,並非錯誤,是爲了顯眼,不須要就不要加入該行 .debug("OkHttpUtils") //若是使用默認的 60秒,如下三行也不須要傳 .setConnectTimeout(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的鏈接超時時間 .setReadTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的讀取超時時間 .setWriteTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的寫入超時時間 //能夠全局統一設置緩存模式,默認就是Default,能夠不傳,具體其餘模式看 github 介紹 https://github.com/jeasonlzy0216/ .setCacheMode(CacheMode.DEFAULT) //能夠全局統一設置緩存時間,默認永不過時,具體使用方法看 github 介紹 .setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE) //若是不想讓框架管理cookie,如下不須要 // .setCookieStore(new MemoryCookieStore()) //cookie使用內存緩存（app退出後，cookie消失） .setCookieStore(new PersistentCookieStore()) //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(); } }

2、普通請求

0.寫在開始的話,callback回調默認只須要複寫onSuccess,並不表明全部的回調都只走這一個,實際開發中,錯誤回調並無成功回調使用頻繁,因此callback的失敗回調onError並無聲明爲抽象的,若是有須要,請自行復寫,不要再問我爲何回調沒有執行啊,既然onSuccess沒有執行,那麼必定是出錯了回調了onError

callback一共有如下 10 個回調,除onSuccess必須實現之外,其他都可以按需實現,每一個方法參數詳細說明,請看下面第6點:

• parseNetworkResponse():解析網絡返回的數據回調
• parseNetworkFail():解析網絡失敗的數據回調
• onBefore():網絡請求真正執行前回調
• onSuccess():網絡請求成功的回調
• onCacheSuccess():緩存讀取成功的回調
• onError():網絡請求失敗的回調
• onCacheError():網絡緩存讀取失敗的回調
• onAfter():網絡請求結束的回調,不管成功失敗必定會執行
• upProgress():上傳進度的回調
• downloadProgress():下載進度的回調

Callback回調具備以下順序,雖然順序寫的很複雜,可是理解後,是很簡單,而且合情合理的

1).無緩存模式 CacheMode.NO_CACHE

網絡請求成功 onBefore -> parseNetworkResponse -> onSuccess -> onAfter
網絡請求失敗 onBefore -> parseNetworkFail -> onError -> onAfter

2).默認緩存模式,遵循304頭 CacheMode.DEFAULT

網絡請求成功,服務端返回非304 onBefore -> parseNetworkResponse -> onSuccess -> onAfter
網絡請求成功服務端返回304 onBefore -> onCacheSuccess -> onAfter
網絡請求失敗 onBefore -> parseNetworkFail -> onError -> onAfter

3).請求網絡失敗後讀取緩存 CacheMode.REQUEST_FAILED_READ_CACHE

網絡請求成功,不讀取緩存 onBefore -> parseNetworkResponse -> onSuccess -> onAfter
網絡請求失敗,讀取緩存成功 onBefore -> parseNetworkFail -> onError -> onCacheSuccess -> onAfter
網絡請求失敗,讀取緩存失敗 onBefore -> parseNetworkFail -> onError -> onCacheError -> onAfter

4).若是緩存不存在才請求網絡，不然使用緩存 CacheMode.IF_NONE_CACHE_REQUEST

已經有緩存,不請求網絡 onBefore -> onCacheSuccess -> onAfter
沒有緩存請求網絡成功 onBefore -> onCacheError -> parseNetworkResponse -> onSuccess -> onAfter
沒有緩存請求網絡失敗 onBefore -> onCacheError -> parseNetworkFail -> onError -> onAfter

5).先使用緩存，無論是否存在，仍然請求網絡 CacheMode.FIRST_CACHE_THEN_REQUEST

無緩存時,網絡請求成功 onBefore -> onCacheError -> parseNetworkResponse -> onSuccess -> onAfter
無緩存時,網絡請求失敗 onBefore -> onCacheError -> parseNetworkFail -> onError -> onAfter
有緩存時,網絡請求成功 onBefore -> onCacheSuccess -> parseNetworkResponse -> onSuccess -> onAfter
有緩存時,網絡請求失敗 onBefore -> onCacheSuccess -> parseNetworkFail -> onError -> onAfter

1.基本的網絡請求

OkHttpUtils.get(Urls.URL_METHOD) // 請求方式和請求url .tag(this) // 請求的 tag, 主要用於取消對應的請求 .cacheKey("cacheKey") // 設置當前請求的緩存key,建議每一個不一樣功能的請求設置一個 .cacheMode(CacheMode.DEFAULT) // 緩存模式，詳細請看緩存介紹 .execute(new StringCallback() { @Override public void onSuccess(String s, Call call, Response response) { // s 即爲所須要的結果 } });

2.請求 Bitmap 對象

OkHttpUtils.get(Urls.URL_IMAGE)// .tag(this)// .execute(new BitmapCallback() { @Override public void onSuccess(Bitmap bitmap, Call call, Response response) { // bitmap 即爲返回的圖片數據 } });

3.請求 文件下載

OkHttpUtils.get(Urls.URL_DOWNLOAD)// .tag(this)// .execute(new FileCallback("file.jpg") { //文件下載時，須要指定下載的文件目錄和文件名 @Override public void onSuccess(File file, Call call, Response response) { // file 即爲文件數據，文件保存在指定目錄 } @Override public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) { //這裏回調下載進度(該回調在主線程,能夠直接更新ui) } });

4.普通Post，直接上傳String類型的文本

通常此種用法用於與服務器約定的數據格式，當使用該方法時，params中的參數設置是無效的，全部參數均須要經過須要上傳的文本中指定，此外，額外指定的header參數仍然保持有效。

OkHttpUtils.post(Urls.URL_TEXT_UPLOAD)// .tag(this)// .upString("這是要上傳的長文本數據！")// .execute(new StringCallback() { @Override public void onSuccess(String s, Call call, Response response) { //上傳成功 } @Override public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) { //這裏回調上傳進度(該回調在主線程,能夠直接更新ui) } });

5.普通Post，直接上傳Json類型的文本

該方法與postString沒有本質區別，只是數據格式是json,通常來講，須要本身建立一個實體bean或者一個map，把須要的參數設置進去，而後經過三方的Gson或者fastjson轉換成json字符串，最後直接使用該方法提交到服務器。

HashMap<String, String> params = new HashMap<>(); params.put("key1", "value1"); params.put("key2", "這裏是須要提交的json格式數據"); params.put("key3", "也可使用三方工具將對象轉成json字符串"); params.put("key4", "其實你怎麼高興怎麼寫都行"); JSONObject jsonObject = new JSONObject(params); OkHttpUtils.post(Urls.URL_TEXT_UPLOAD)// .tag(this)// .upJson(jsonObject.toString())// .execute(new StringCallback() { @Override public void onSuccess(String s, Call call, Response response) { //上傳成功 } @Override public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) { //這裏回調上傳進度(該回調在主線程,能夠直接更新ui) } });

6.https請求(證書能夠在全局初始化的時候設置,不用每次請求設置一遍)

OkHttpUtils.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(new HttpsCallBack(this));

7.請求功能的全部配置講解

如下代碼包含了如下內容：

• 一次普通請求全部能配置的參數，真實使用時不須要配置這麼多，按本身的須要選擇性的使用便可
• 多文件和多參數的表單上傳，同時支持進度監聽
• 自簽名網站https的訪問，調用setCertificates方法便可
• 爲單個請求設置超時，好比涉及到文件的須要設置讀寫等待時間多一點。
• Cookie通常狀況下只須要在初始化的時候調用setCookieStore便可實現cookie的自動管理，若是特殊業務須要，須要手動額外向服務器傳遞自定義的cookie，能夠在每次請求的時候調用addCookie方法，該方法提供了3個重載形式，能夠根據本身的須要選擇使用。

OkHttpUtils.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", new File("filepath1")) // 能夠添加文件上傳 .params("file2", new File("filepath2")) // 支持多文件同時添加上傳 .addUrlParams("key", List<String> values) //這裏支持一個key傳多個參數 .addFileParams("key", List<File> files) //這裏支持一個key傳多個文件 .addFileWrapperParams("key", List<HttpParams.FileWrapper> fileWrappers)//這裏支持一個key傳多個文件 .addCookie("aaa", "bbb") // 這裏能夠傳遞本身想傳的Cookie .addCookie(cookie) // 能夠本身構建cookie .addCookies(cookies) // 能夠一次傳遞批量的cookie //這裏給出的泛型爲 ServerModel，同時傳遞一個泛型的 class對象，便可自動將數據結果轉成對象返回 .execute(new DialogCallback<ServerModel>(this, ServerModel.class) { @Override public void onBefore(BaseRequest request) { // UI線程 請求網絡以前調用 // 能夠顯示對話框，添加/修改/移除 請求參數 } @Override public ServerModel parseNetworkResponse(Response response) throws Exception{ // 子線程，能夠作耗時操做 // 根據傳遞進來的 response 對象，把數據解析成須要的 ServerModel 類型並返回 // 能夠根據本身的須要，拋出異常，在onError中處理 return null; } @Override public void parseNetworkFail(Call call, IOException e) { // 子線程，能夠作耗時操做 // 用於網絡錯誤時在子線程中執行數據耗時操做,子類能夠根據本身的須要重寫此方法 } @Override public void onSuccess(ServerModel serverModel, Call call, Response response) { // UI 線程，請求成功後回調 // ServerModel 返回泛型約定的實體類型參數 // call 本次網絡的請求信息，若是須要查看請求頭或請求參數能夠今後對象獲取 // response 本次網絡訪問的結果對象，包含了響應頭，響應碼等 } @Override public void onCacheSuccess(ServerModel serverModel, Call call) { // UI 線程，緩存讀取成功後回調 // serverModel 返回泛型約定的實體類型參數 // call 本次網絡的請求信息 } @Override public void onError(Call call, Response response, Exception e) { // UI 線程，請求失敗後回調 // call 本次網絡的請求對象，能夠根據該對象拿到 request // response 本次網絡訪問的結果對象，包含了響應頭，響應碼等 // e 本次網絡訪問的異常信息，若是服務器內部發生了錯誤，響應碼爲 404,或大於等於500 } @Override public void onCacheError(Call call, Exception e) { // UI 線程，讀取緩存失敗後回調 // call 本次網絡的請求對象，能夠根據該對象拿到 request // e 本次網絡訪問的異常信息，若是服務器內部發生了錯誤，響應碼爲 404,或大於等於500 } @Override public void onAfter(ServerModel serverModel, Exception e) { // UI 線程，請求結束後回調，不管網絡請求成功仍是失敗，都會調用，能夠用於關閉顯示對話框 // ServerModel 返回泛型約定的實體類型參數，若是網絡請求失敗，該對象爲　null // e 本次網絡訪問的異常信息，若是服務器內部發生了錯誤，響應碼爲 404,或大於等於500 } @Override public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) { // UI 線程，文件上傳過程當中回調，只有請求方式包含請求體纔回調（GET,HEAD不會回調） // currentSize 當前上傳的大小（單位字節） // totalSize 　 須要上傳的總大小（單位字節） // progress 當前上傳的進度，範圍　0.0f ~ 1.0f // networkSpeed 當前上傳的網速（單位秒） } @Override public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) { // UI 線程，文件下載過程當中回調 //參數含義同　上傳相同 } });

8.取消請求

每一個請求前都設置了一個參數tag，取消則經過OkHttpUtils.cancel(tag)執行。 例如：在Activity中，當Activity銷燬取消請求，能夠在onDestory裏面統一取消。

    @Override
    protected void onDestroy() { super.onDestroy(); //根據 Tag 取消請求 OkHttpUtils.getInstance().cancelTag(this); }

9.同步的請求

execute方法不傳入callback即爲同步的請求，返回Response對象，須要本身解析

    Response response = OkHttpUtils.get("http://www.baidu.com")// .tag(this)// .headers("aaa", "111")// .params("bbb", "222") .execute();

10.參數的順序

添加header和param的方法各有三個地方,在提交的時候,他們是有順序的,若是對提交順序有須要的話,請注意這裏

• 第一個地方,全局初始化時,使用OkHttpUtils.getInstance().addCommonHeaders(),OkHttpUtils.getInstance().addCommonParams() 添加

    HttpHeaders headers = new HttpHeaders(); headers.put("HKAAA", "HVAAA"); headers.put("HKBBB", "HVBBB"); HttpParams params = new HttpParams(); params.put("PKAAA", "PVAAA"); params.put("PKBBB", "PVBBB"); OkHttpUtils.getInstance() .addCommonHeaders(headers) //設置全局公共頭 .addCommonParams(params); //設置全局公共參數

• 第二個地方,callback的onBefore方法中添加

    public abstract class CommonCallback<T> extends AbsCallback<T> { @Override public void onBefore(BaseRequest request) { super.onBefore(request); request.headers("HKCCC", "HVCCC")// .headers("HKDDD", "HVDDD")// .params("PKCCC", "PVCCC")// .params("PKDDD", "PVDDD")// } }

• 第三個地方,執行網絡請求的時候添加

    OkHttpUtils.get(Urls.URL_METHOD)// .tag(this)// .headers("HKEEE", "HVEEE")// .headers("HKFFF", "HVFFF")// .params("PKEEE", "PVEEE")// .params("PKFFF", "PVFFF")// .execute(new MethodCallBack<>(this, ServerModel.class));

那麼,最終執行請求的參數的添加順序爲

• Header順序: HKAAA -> HKBBB -> HKEEE -> HKFFF -> HKCCC -> HKDDD
• Params順序: PKAAA -> PKBBB -> PKEEE -> PKFFF -> PKCCC -> PKDDD

總結一句話就是,全局添加的在最開始,callback添加的在最後,請求添加的在中間

3、自定義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示例，根據業務需求修改！

4、緩存的使用

使用緩存前，必須讓緩存的數據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，若是相同，會致使數據覆蓋。

5、混淆

    #okhttputils
    -dontwarn com.lzy.okhttputils.** -keep class com.lzy.okhttputils.**{*;} #okhttpserver -dontwarn com.lzy.okhttpserver.** -keep class com.lzy.okhttpserver.**{*;} #okhttp -dontwarn okhttp3.** -keep class okhttp3.**{*;} #okio -dontwarn okio.** -keep class okio.**{*;}