一杖狼、前言:
OkGo是封裝了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)一的上傳管理和下載管理功能超埋。
今天自己新建了一個(gè)Demo,試了一下使用okGo做簡(jiǎn)單的get佳鳖、post和文件下載霍殴,那么這篇博客就詳細(xì)講訴一下具體的使用過(guò)程。
二腋颠、OkGo配置
在app下的build.gradel里面配置
//必須使用
implementation 'com.lzy.net:okgo:3.0.4'
選擇性配置:
//以下三個(gè)選擇添加繁成,okrx和okrx2不能同時(shí)使用
implementation 'com.lzy.net:okrx:1.0.2'
implementation 'com.lzy.net:okrx2:2.0.2'
implementation 'com.lzy.net:okserver:2.0.5'
三、在Applicaiton中初始化
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
//okGo網(wǎng)絡(luò)框架初始化和全局配置
OkHttpClient.Builder builder = new OkHttpClient.Builder();
//builder.cookieJar(new CookieJarImpl(new SPCookieStore(this))); //使用sp保持cookie淑玫,如果cookie不過(guò)期巾腕,則一直有效
builder.cookieJar(new CookieJarImpl(new DBCookieStore(this)));//使用數(shù)據(jù)庫(kù)保持cookie,如果cookie不過(guò)期絮蒿,則一直有效
//builder.cookieJar(new CookieJarImpl(new MemoryCookieStore())); //使用內(nèi)存保持cookie尊搬,app退出后,cookie消失
//設(shè)置請(qǐng)求頭
HttpHeaders headers = new HttpHeaders();
headers.put("commonHeaderKey1", "commonHeaderValue1"); //header不支持中文土涝,不允許有特殊字符
headers.put("commonHeaderKey2", "commonHeaderValue2");
//設(shè)置請(qǐng)求參數(shù)
HttpParams params = new HttpParams();
params.put("commonParamsKey1", "commonParamsValue1"); //param支持中文,直接傳,不要自己編碼
params.put("commonParamsKey2", "這里支持中文參數(shù)");
OkGo.getInstance().init(this) //必須調(diào)用初始化
.setOkHttpClient(builder.build()) //建議設(shè)置OkHttpClient佛寿,不設(shè)置會(huì)使用默認(rèn)的
.setCacheMode(CacheMode.NO_CACHE) //全局統(tǒng)一緩存模式,默認(rèn)不使用緩存但壮,可以不傳
.setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE) //全局統(tǒng)一緩存時(shí)間冀泻,默認(rèn)永不過(guò)期,可以不傳
.setRetryCount(3) //全局統(tǒng)一超時(shí)重連次數(shù)蜡饵,默認(rèn)為三次弹渔,那么最差的情況會(huì)請(qǐng)求4次(一次原始請(qǐng)求,三次重連請(qǐng)求)溯祸,不需要可以設(shè)置為0
.addCommonHeaders(headers) //全局公共頭
.addCommonParams(params);
}
}
四肢专、OkGo使用示例
1.基本的get請(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(new StringCallback() {
@Override
public void onSuccess(String s, Call call, Response response) {
// s 即為所需要的結(jié)果
}
});
2.請(qǐng)求 Bitmap 對(duì)象
OkGo.get(Urls.URL_IMAGE)//
.tag(this)//
.execute(new BitmapCallback() {
@Override
public void onSuccess(Bitmap bitmap, Call call, Response response) {
// bitmap 即為返回的圖片數(shù)據(jù)
}
});
3.普通Post請(qǐng)求焦辅,直接上傳String類型的文本
一般此種用法用于與服務(wù)器約定的數(shù)據(jù)格式博杖,當(dāng)使用該方法時(shí),params中的參數(shù)設(shè)置是無(wú)效的筷登,所有參數(shù)均需要通過(guò)需要上傳的文本中指定剃根,此外,額外指定的header參數(shù)仍然保持有效前方。
OkGo.post(Urls.URL_TEXT_UPLOAD)//
.tag(this)//
.upString("這是要上傳的長(zhǎng)文本數(shù)據(jù)跟继!")//
.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) {
//這里回調(diào)上傳進(jìn)度(該回調(diào)在主線程,可以直接更新ui)
}
});
4.普通Post种冬,直接上傳Json類型的文本(注意傳遞的類型)
該方法與postString沒有本質(zhì)區(qū)別,只是數(shù)據(jù)格式是json,一般來(lái)說(shuō)舔糖,需要自己創(chuàng)建一個(gè)實(shí)體bean或者一個(gè)map娱两,把需要的參數(shù)設(shè)置進(jìn)去,然后通過(guò)三方的Gson或者fastjson轉(zhuǎn)換成json字符串金吗,最后直接使用該方法提交到服務(wù)器十兢。
HashMap<String, String> params = new HashMap<>();
params.put("key1", "value1");
params.put("key2", "這里是需要提交的json格式數(shù)據(jù)");
params.put("key3", "也可以使用三方工具將對(duì)象轉(zhuǎn)成json字符串");
params.put("key4", "其實(shí)你怎么高興怎么寫都行");
JSONObject jsonObject = new JSONObject(params);
OkGo.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) {
//這里回調(diào)上傳進(jìn)度(該回調(diào)在主線程,可以直接更新ui)
}
});
5.文件下載
OkGo.<File>get(url)
.tag(this)//
.headers("header1", "headerValue1")//
.params("param1", "paramValue1")//
.execute(new FileCallback("OkGo.apk") {
@Override
public void onStart(Request<File, ? extends Request> request) {
btnFileDownload.setText("正在下載中");
}
@Override
public void onSuccess(Response<File> response) {
btnFileDownload.setText("下載完成"+response.body());
}
@Override
public void onError(Response<File> response) {
btnFileDownload.setText("下載出錯(cuò)");
}
@Override
public void downloadProgress(Progress progress) {
System.out.println(progress);
}
});
6.在onDestroy主動(dòng)銷毀請(qǐng)求
protected void onDestroy() {
super.onDestroy();
//取消指定tag的請(qǐng)求
OkGo.getInstance().cancelTag(this);
//取消全部請(qǐng)求
OkGo.getInstance().cancelAll();
//取消OkHttpClient的全部請(qǐng)求
OkGo.cancelAll(new OkHttpClient());
OkGo.cancelTag(new OkHttpClient(), "且指定tag");
}
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的訪問(wèn),調(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) // 緩存的過(guò)期時(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", new File("filepath1")) // 可以添加文件上傳
.params("file2", new File("filepath2")) // 支持多文件同時(shí)添加上傳
.addUrlParams("key", List<String> values) //這里支持一個(gè)key傳多個(gè)參數(shù)
.addFileParams("key", List<File> files) //這里支持一個(gè)key傳多個(gè)文件
.addFileWrapperParams("key", List<HttpParams.FileWrapper> 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(new DialogCallback<ServerModel>(this) {
@Override
public void onBefore(BaseRequest request) {
// UI線程 請(qǐng)求網(wǎng)絡(luò)之前調(diào)用
// 可以顯示對(duì)話框蜘矢,添加/修改/移除 請(qǐng)求參數(shù)
}
@Override
public ServerModel convertSuccess(Response response) throws Exception{
// 子線程狂男,可以做耗時(shí)操作
// 根據(jù)傳遞進(jìn)來(lái)的 response 對(duì)象,把數(shù)據(jù)解析成需要的 ServerModel 類型并返回
// 可以根據(jù)自己的需要品腹,拋出異常岖食,在onError中處理
return null;
}
@Override
public void parseError(Call call, IOException e) {
// 子線程,可以做耗時(shí)操作
// 用于網(wǎng)絡(luò)錯(cuò)誤時(shí)在子線程中執(zhí)行數(shù)據(jù)耗時(shí)操作,子類可以根據(jù)自己的需要重寫此方法
}
@Override
public void onSuccess(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ò)訪問(wèn)的結(jié)果對(duì)象析珊,包含了響應(yīng)頭,響應(yīng)碼等
}
@Override
public void onCacheSuccess(ServerModel serverModel, Call call) {
// UI 線程蔑穴,緩存讀取成功后回調(diào)
// serverModel 返回泛型約定的實(shí)體類型參數(shù)
// call 本次網(wǎng)絡(luò)的請(qǐng)求信息
}
@Override
public void onError(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ò)訪問(wèn)的結(jié)果對(duì)象存和,包含了響應(yīng)頭奕剃,響應(yīng)碼等
// e 本次網(wǎng)絡(luò)訪問(wèn)的異常信息,如果服務(wù)器內(nèi)部發(fā)生了錯(cuò)誤捐腿,響應(yīng)碼為 404,或大于等于500
}
@Override
public void onCacheError(Call call, Exception e) {
// UI 線程纵朋,讀取緩存失敗后回調(diào)
// call 本次網(wǎng)絡(luò)的請(qǐng)求對(duì)象,可以根據(jù)該對(duì)象拿到 request
// e 本次網(wǎng)絡(luò)訪問(wèn)的異常信息茄袖,如果服務(wù)器內(nèi)部發(fā)生了錯(cuò)誤操软,響應(yīng)碼為 404,或大于等于500
}
@Override
public void onAfter(ServerModel serverModel, Exception e) {
// UI 線程,請(qǐng)求結(jié)束后回調(diào)宪祥,無(wú)論網(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)的異常信息,如果服務(wù)器內(nèi)部發(fā)生了錯(cuò)誤肘交,響應(yīng)碼為 404,或大于等于500
}
@Override
public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
// UI 線程笆载,文件上傳過(guò)程中回調(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)速(單位秒)
}
@Override
public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
// UI 線程复罐,文件下載過(guò)程中回調(diào)
//參數(shù)含義同 上傳相同
}
});
至此OKGO的基本使用和簡(jiǎn)單封裝介紹完畢涝登,同時(shí)傳參和抓包的話,還是有幾點(diǎn)需要小伙伴注意的效诅,具體可以參考:傳參與抓包注意點(diǎn)(必看)