一句話概括,OkHttpUtils一個專注于讓網(wǎng)絡(luò)請求更簡單的網(wǎng)絡(luò)請求框架我擂,對于任何形式的網(wǎng)絡(luò)請求只需要一行代碼衬以。
- 項目地址:https://github.com/jeasonlzy/okhttp-OkGo
- 聯(lián)系方式:QQ群(489873144)
- 如果你想直接運行apk看效果,點擊這里下載:okhttputils_v1.8.1.apk
- 其中Demo中用到的圖片選擇是我的另一個開源項目校摩,完全仿微信的圖片選擇庫看峻,自帶 矩形圖片裁剪 和 圓形圖片裁剪 功能,有需要的可以去下載使用衙吩,附上地址:https://github.com/jeasonlzy/ImagePicker
- 其中的九宮格控件也是我的開源項目,類似QQ空間互妓,微信朋友圈,微博主頁等坤塞,展示圖片的九宮格控件冯勉,自動根據(jù)圖片的數(shù)量確定圖片大小和控件大小,使用Adapter模式設(shè)置圖片摹芙,對外提供接口回調(diào)灼狰,使用接口加載圖片,支持任意的圖片加載框架,如 Glide,ImageLoader,Fresco,xUtils3,Picasso 等,支持點擊圖片全屏預(yù)覽大圖浮禾。附上地址:https://github.com/jeasonlzy/NineGridView
1.OkHttpUtils 目前支持
- 一般的 get,post,put,delete,head,options請求
- 基于Post的大文本數(shù)據(jù)上傳
- 多文件和多參數(shù)統(tǒng)一的表單上傳
- 支持一個key上傳一個文件交胚,也可以一個Key上傳多個文件
- 大文件下載和下載進(jìn)度回調(diào)
- 大文件上傳和上傳進(jìn)度回調(diào)
- 支持cookie的內(nèi)存存儲和持久化存儲,支持傳遞自定義cookie
- 支持304緩存協(xié)議盈电,擴(kuò)展四種本地緩存模式,并且支持緩存時間控制
- 支持301蝴簇、302重定向
- 支持鏈?zhǔn)秸{(diào)用
- 支持可信證書和自簽名證書的https的訪問,支持雙向認(rèn)證
- 支持根據(jù)Tag取消請求
- 支持自定義泛型Callback,自動根據(jù)泛型返回對象
2.OkHttpServer 擴(kuò)展功能
2.1 統(tǒng)一的文件下載管理(DownloadManager):
- 結(jié)合OkHttpUtils 的request進(jìn)行網(wǎng)絡(luò)請求,支持與OkHttpUtils 保持相同的全局公共參數(shù),同時支持請求傳遞參數(shù)
- 支持?jǐn)帱c下載挣轨,支持突然斷網(wǎng),強(qiáng)殺進(jìn)程后,斷點依然有效
- 支持 下載 暫停 等待 停止 出錯 完成 六種下載狀態(tài)
- 所有下載任務(wù)按照taskKey區(qū)分,切記不同的任務(wù)必須使用不一樣的key,否者斷點會發(fā)生覆蓋
- 相同的下載url地址如果使用不一樣的taskKey,也會認(rèn)為是兩個下載任務(wù)
- 默認(rèn)同時下載數(shù)量為3個军熏,默認(rèn)下載路徑
/storage/emulated/0/download
,下載路徑和下載數(shù)量都可以在代碼中配置 - 下載文件名可以自己定義,也可以不傳,框架自動解析響應(yīng)頭或者url地址獲得文件名,如果都沒獲取到,使用default作為文件名
- 下載管理使用了服務(wù)提高線程優(yōu)先級卷扮,避免后臺下載時被系統(tǒng)回收
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ò)展焦影。
項目的效果圖如下:
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正是在這種情況下誕生啦v杜耙!
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ù)都支持中文尘应,
@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"); //所有的 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) {
@Override
public 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() {
@Override
public 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") { //文件下載時,需要指定下載的文件目錄和文件名
@Override
public 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() {
@Override
public 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() {
@Override
public 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ù)自己的需要選擇使用。
OkHttpUtils.get(Urls.URL_METHOD) // 請求方式和請求url, get請求不需要拼接參數(shù)帽氓,支持get趣斤,post,put黎休,delete浓领,head,options請求
.tag(this) // 請求的 tag, 主要用于取消對應(yīng)的請求
.connTimeOut(10000) // 設(shè)置當(dāng)前請求的連接超時時間
.readTimeOut(10000) // 設(shè)置當(dāng)前請求的讀取超時時間
.writeTimeOut(10000) // 設(shè)置當(dāng)前請求的寫入超時時間
.cacheKey("cacheKey") // 設(shè)置當(dāng)前請求的緩存key,建議每個不同功能的請求設(shè)置一個
.cacheMode(CacheMode.FIRST_CACHE_THEN_REQUEST) // 緩存模式势腮,詳細(xì)請看第四部分联贩,緩存介紹
.setCertificates(getAssets().open("srca.cer")) // 自簽名https的證書,可變參數(shù)捎拯,可以設(shè)置多個
.addInterceptor(interceptor) // 添加自定義攔截器
.headers("header1", "headerValue1") // 添加請求頭參數(shù)
.headers("header2", "headerValue2") // 支持多請求頭參數(shù)同時添加
.params("param1", "paramValue1") // 添加請求參數(shù)
.params("param2", "paramValue2") // 支持多請求參數(shù)同時添加
.params("file1", new File("filepath1")) // 可以添加文件上傳
.params("file2", new File("filepath2")) // 支持多文件同時添加上傳
.addUrlParams("key", List<String> values) //這里支持一個key傳多個參數(shù)
.addFileParams("key", List<File> files) //這里支持一個key傳多個文件
.addFileWrapperParams("key", List<HttpParams.FileWrapper> fileWrappers) //這里支持一個key傳多個文件
.addCookie("aaa", "bbb") // 這里可以傳遞自己想傳的Cookie
.addCookie(cookie) // 可以自己構(gòu)建cookie
.addCookies(cookies) // 可以一次傳遞批量的cookie
//這里給出的泛型為 RequestInfo泪幌,同時傳遞一個泛型的 class對象,即可自動將數(shù)據(jù)結(jié)果轉(zhuǎn)成對象返回
.execute(new DialogCallback<RequestInfo>(this, RequestInfo.class) {
@Override
public void onBefore(BaseRequest request) {
// UI線程 請求網(wǎng)絡(luò)之前調(diào)用
// 可以顯示對話框署照,添加/修改/移除 請求參數(shù)
}
@Override
public RequestInfo parseNetworkResponse(Response response) throws Exception{
// 子線程祸泪,可以做耗時操作
// 根據(jù)傳遞進(jìn)來的 response 對象,把數(shù)據(jù)解析成需要的 RequestInfo 類型并返回
// 可以根據(jù)自己的需要建芙,拋出異常没隘,在onError中處理
return null;
}
@Override
public void onResponse(boolean isFromCache, RequestInfo requestInfo, Request request, @Nullable Response response) {
// UI 線程,請求成功后回調(diào)
// isFromCache 表示當(dāng)前回調(diào)是否來自于緩存
// requestInfo 返回泛型約定的實體類型參數(shù)
// request 本次網(wǎng)絡(luò)的請求信息岁钓,如果需要查看請求頭或請求參數(shù)可以從此對象獲取
// response 本次網(wǎng)絡(luò)訪問的結(jié)果對象升略,包含了響應(yīng)頭,響應(yīng)碼等屡限,如果數(shù)據(jù)來自于緩存品嚣,該對象為null
}
@Override
public void onError(boolean isFromCache, Call call, @Nullable Response response, @Nullable Exception e) {
// UI 線程,請求失敗后回調(diào)
// isFromCache 表示當(dāng)前回調(diào)是否來自于緩存
// call 本次網(wǎng)絡(luò)的請求對象钧大,可以根據(jù)該對象拿到 request
// response 本次網(wǎng)絡(luò)訪問的結(jié)果對象翰撑,包含了響應(yīng)頭,響應(yīng)碼等,如果網(wǎng)絡(luò)異常 或者數(shù)據(jù)來自于緩存眶诈,該對象為null
// e 本次網(wǎng)絡(luò)訪問的異常信息涨醋,如果服務(wù)器內(nèi)部發(fā)生了錯誤,響應(yīng)碼為 400~599之間逝撬,該異常為 null
}
@Override
public void onAfter(boolean isFromCache, @Nullable RequestInfo requestInfo, Call call, @Nullable Response response, @Nullable Exception e) {
// UI 線程浴骂,請求結(jié)束后回調(diào),無論網(wǎng)絡(luò)請求成功還是失敗宪潮,都會調(diào)用溯警,可以用于關(guān)閉顯示對話框
// isFromCache 表示當(dāng)前回調(diào)是否來自于緩存
// requestInfo 返回泛型約定的實體類型參數(shù),如果網(wǎng)絡(luò)請求失敗狡相,該對象為 null
// call 本次網(wǎng)絡(luò)的請求對象梯轻,可以根據(jù)該對象拿到 request
// response 本次網(wǎng)絡(luò)訪問的結(jié)果對象,包含了響應(yīng)頭尽棕,響應(yīng)碼等喳挑,如果網(wǎng)絡(luò)異常 或者數(shù)據(jù)來自于緩存,該對象為null
// e 本次網(wǎng)絡(luò)訪問的異常信息滔悉,如果服務(wù)器內(nèi)部發(fā)生了錯誤伊诵,響應(yīng)碼為 400~599之間,該異常為 null
}
@Override
public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
// UI 線程氧敢,文件上傳過程中回調(diào)日戈,只有請求方式包含請求體才回調(diào)(GET,HEAD不會回調(diào))
// currentSize 當(dāng)前上傳的大小(單位字節(jié))
// totalSize 需要上傳的總大兴锕浴(單位字節(jié))
// progress 當(dāng)前上傳的進(jìn)度,范圍 0.0f ~ 1.0f
// networkSpeed 當(dāng)前上傳的網(wǎng)速(單位秒)
}
@Override
public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
// UI 線程份氧,文件下載過程中回調(diào)
//參數(shù)含義同 上傳相同
}
});
7.取消請求
每個請求前都設(shè)置了一個參數(shù)tag
唯袄,取消則通過OkHttpUtils.cancel(tag)
執(zhí)行。
例如:在Activity中蜗帜,當(dāng)Activity銷毀取消請求恋拷,可以在onDestory里面統(tǒng)一取消。
@Override
protected void onDestroy() {
super.onDestroy();
//根據(jù) Tag 取消請求
OkHttpUtils.getInstance().cancelTag(this);
}
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)行具體判斷伴澄。