資訊專欄INFORMATION COLUMN
摘要：注和是當(dāng)下非常火爆的開源框架，均來自神一般的公司。特點比使用更簡單更易用。默認(rèn)初始化如果使用默認(rèn)始化后，一切采用默認(rèn)設(shè)置。為單個請求設(shè)置超時，比如涉及到文件的需要設(shè)置讀寫等待時間多一點。
github源碼地址：https://github.com/zhou-you/RxEasyHttp RxEasyHttp
本庫是一款基于RxJava2+Retrofit2實現(xiàn)簡單易用的網(wǎng)絡(luò)請求框架，結(jié)合android平臺特性的網(wǎng)絡(luò)封裝庫,采用api鏈?zhǔn)秸{(diào)用一點到底,集成cookie管理,多種緩存模式,極簡https配置,上傳下載進(jìn)度顯示,請求錯誤自動重試,請求攜帶token、時間戳、簽名sign動態(tài)配置,自動登錄成功后請求重發(fā)功能,3種層次的參數(shù)設(shè)置默認(rèn)全局局部,默認(rèn)標(biāo)準(zhǔn)ApiResult同時可以支持自定義的數(shù)據(jù)結(jié)構(gòu)，已經(jīng)能滿足現(xiàn)在的大部分網(wǎng)絡(luò)請求。
注：Retrofit和Rxjava是當(dāng)下非常火爆的開源框架，均來自神一般的Square公司。本庫就不介紹Retrofit和Rxjava2的用法。
網(wǎng)上好的開源網(wǎng)絡(luò)庫像Volley、async-http、okhttp、retrofit等都非常強(qiáng)大，但是實際應(yīng)用中我們不會直接去使用，一般都會根據(jù)自己的業(yè)務(wù)再封裝一層，這樣更方便快捷，又能統(tǒng)一處理業(yè)務(wù)共性的東西例如：統(tǒng)一的數(shù)據(jù)結(jié)構(gòu)（code、msg、data）、token處理、網(wǎng)絡(luò)異常等情況。在使用retrofit來請求網(wǎng)絡(luò)的時候，項目的需求越來越多，api也隨之越來越多，一個普通的應(yīng)用api一般也在100+左右。如果把這些api放在一個ApiService內(nèi)會很臃腫，不利于查看api.如果采用模塊的方式對api進(jìn)行分類，每個模塊對應(yīng)若干個api.以retrofit的使用方式又需要創(chuàng)建若干個ApiService，這種方式維護(hù)方便，但是模塊增多了，類也增多了很多。對于懶人來說就想通過一個URL就能回調(diào)你所需要的數(shù)據(jù)，什么ApiService都不想理會，同時又可以很快的與自己的業(yè)務(wù)相關(guān)聯(lián)，就類似于代替你在開源網(wǎng)絡(luò)庫基礎(chǔ)上再封裝一層的作用，于是本庫就應(yīng)運而生。
特點比Retrofit使用更簡單、更易用。
采用鏈?zhǔn)秸{(diào)用一點到底
加入基礎(chǔ)ApiService，減少Api冗余
支持動態(tài)配置和自定義底層框架Okhttpclient、Retrofit.
支持多種方式訪問網(wǎng)絡(luò)GET、POST、PUT、DELETE等請求協(xié)議
支持網(wǎng)絡(luò)緩存,六種緩存策略可選,涵蓋大多數(shù)業(yè)務(wù)場景
支持固定添加header和動態(tài)添加header
支持添加全局參數(shù)和動態(tài)添加局部參數(shù)
支持文件下載、多文件上傳和表單提交數(shù)據(jù)
支持文件請求、上傳、下載的進(jìn)度回調(diào)、錯誤回調(diào)，也可以自定義回調(diào)
支持默認(rèn)、全局、局部三個層次的配置功能
支持任意數(shù)據(jù)結(jié)構(gòu)的自動解析
支持添加動態(tài)參數(shù)例如timeStamp時間戳、token、簽名sign
支持自定義的擴(kuò)展API
支持多個請求合并
支持Cookie管理
支持異步、同步請求
支持Https、自簽名網(wǎng)站Https的訪問、雙向驗證
支持失敗重試機(jī)制，可以指定重試次數(shù)、重試間隔時間
支持根據(jù)ky刪除網(wǎng)絡(luò)緩存和清空網(wǎng)絡(luò)緩存
提供默認(rèn)的標(biāo)準(zhǔn)ApiResult解析和回調(diào)，并且可自定義ApiResult
支持取消數(shù)據(jù)請求，取消訂閱，帶有對話框的請求不需要手動取消請求，對話框消失會自動取消請求
支持請求數(shù)據(jù)結(jié)果采用回調(diào)和訂閱兩種方式
api設(shè)計上結(jié)合http協(xié)議和android平臺特點來實現(xiàn),loading對話框,實時進(jìn)度條顯示
返回結(jié)果和異常統(tǒng)一處理
結(jié)合RxJava2，線程智能控制
聯(lián)系方式郵箱地址： 478319399@qq.com
QQ群： 581235049（建議使用QQ群，郵箱使用較少，可能看的不及時）
本群旨在為使用我的github項目的人提供方便，如果遇到問題歡迎在群里提問。一個人的能力也有限，希望一起學(xué)習(xí)一起進(jìn)步。
關(guān)注我的github，了解我的最新項目。關(guān)注我的博客，閱讀我的最新文章。
V2.0.5
網(wǎng)絡(luò)庫從Rxjava升級到Rxjava2
優(yōu)化緩存策略實現(xiàn)
修復(fù)同步請求回調(diào)問題
修復(fù)put請求失敗問題
修改圖片請求失敗@url問題導(dǎo)致404錯誤
修復(fù)多圖片表單上傳失敗問題
Demo增加根據(jù)key獲取緩存的演示
修復(fù)post提交json到后臺問題
定位upObject失敗原因，需要加轉(zhuǎn)換器addConverterFactory(GsonConverterFactory.create())
更新日志點擊查看更新日志
用法介紹目前只支持主流開發(fā)工具AndtoidStudio的使用，沒有提供Eclipse使用方式.
本項目Demo的網(wǎng)絡(luò)請求的服務(wù)器地址為了安全，把url去掉了，但是Demo程序中的示例都是ok的
dependencies {
compile "com.zhouyou:rxeasyhttp:2.0.5"
}
想查看所有版本，請點擊下面地址。
Latest release: https://jcenter.bintray.com/com/zhouyou/rxeasyhttp/
權(quán)限說明如果使用本庫實現(xiàn)文件下載到SD卡、或者配置了緩存數(shù)據(jù)到SD卡，你必須要考慮到Android6.0及以上系統(tǒng)的運行時權(quán)限，給大家推薦兩個權(quán)限庫：
AndPermission
RxPermissions
因為要請求網(wǎng)絡(luò)、從SD卡讀寫緩存、下載文件到SD卡等等，所以需要在manifest.xml中配置以下幾個權(quán)限，如果你已經(jīng)配置過了這些權(quán)限，請不要重復(fù)配置：
全局配置
一般在 Aplication，或者基類中，只需要調(diào)用一次即可，可以配置調(diào)試開關(guān)，全局的超時時間，公共的請求頭和請求參數(shù)等信息
初始化需要一個Context，最好在Application#onCreate()中初始化，記得在manifest.xml中注冊Application。
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
}
}
manifest.xml：
...默認(rèn)初始化
如果使用默認(rèn)始化后，一切采用默認(rèn)設(shè)置。如果你需要配置全局超時時間、緩存、Cookie、底層為OkHttp的話，請看高級初始化。
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
EasyHttp.init(this);//默認(rèn)初始化
}
}
高級初始化
可以進(jìn)行超時配置、網(wǎng)絡(luò)緩存配置、okhttp相關(guān)參數(shù)配置、retrofit相關(guān)參數(shù)配置、cookie配置等，這些參數(shù)可以選擇性的根據(jù)業(yè)務(wù)需要配置。
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
EasyHttp.init(this);//默認(rèn)初始化,必須調(diào)用
//全局設(shè)置請求頭
HttpHeaders headers = new HttpHeaders();
headers.put("User-Agent", SystemInfoUtils.getUserAgent(this, AppConstant.APPID));
//全局設(shè)置請求參數(shù)
HttpParams params = new HttpParams();
params.put("appId", AppConstant.APPID);
//以下設(shè)置的所有參數(shù)是全局參數(shù),同樣的參數(shù)可以在請求的時候再設(shè)置一遍,那么對于該請求來講,請求中的參數(shù)會覆蓋全局參數(shù)
EasyHttp.getInstance()
//可以全局統(tǒng)一設(shè)置全局URL
.setBaseUrl(Url)//設(shè)置全局URL
// 打開該調(diào)試開關(guān)并設(shè)置TAG,不需要就不要加入該行
// 最后的true表示是否打印okgo的內(nèi)部異常，一般打開方便調(diào)試錯誤
.debug("EasyHttp", true)
//如果使用默認(rèn)的60秒,以下三行也不需要設(shè)置
.setReadTimeOut(60 * 1000)
.setWriteTimeOut(60 * 100)
.setConnectTimeout(60 * 100)
//可以全局統(tǒng)一設(shè)置超時重連次數(shù),默認(rèn)為3次,那么最差的情況會請求4次(一次原始請求,三次重連請求),
//不需要可以設(shè)置為0
.setRetryCount(3)//網(wǎng)絡(luò)不好自動重試3次
//可以全局統(tǒng)一設(shè)置超時重試間隔時間,默認(rèn)為500ms,不需要可以設(shè)置為0
.setRetryDelay(500)//每次延時500ms重試
//可以全局統(tǒng)一設(shè)置超時重試間隔疊加時間,默認(rèn)為0ms不疊加
.setRetryIncreaseDelay(500)//每次延時疊加500ms
//可以全局統(tǒng)一設(shè)置緩存模式,默認(rèn)是不使用緩存,可以不傳,具體請看CacheMode
.setCacheMode(CacheMode.NO_CACHE)
//可以全局統(tǒng)一設(shè)置緩存時間,默認(rèn)永不過期
.setCacheTime(-1)//-1表示永久緩存,單位:秒 ，Okhttp和自定義RxCache緩存都起作用
//全局設(shè)置自定義緩存保存轉(zhuǎn)換器，主要針對自定義RxCache緩存
.setCacheDiskConverter(new SerializableDiskConverter())//默認(rèn)緩存使用序列化轉(zhuǎn)化
//全局設(shè)置自定義緩存大小，默認(rèn)50M
.setCacheMaxSize(100 * 1024 * 1024)//設(shè)置緩存大小為100M
//設(shè)置緩存版本，如果緩存有變化，修改版本后，緩存就不會被加載。特別是用于版本重大升級時緩存不能使用的情況
.setCacheVersion(1)//緩存版本為1
//.setHttpCache(new Cache())//設(shè)置Okhttp緩存，在緩存模式為DEFAULT才起作用
//可以設(shè)置https的證書,以下幾種方案根據(jù)需要自己設(shè)置
.setCertificates() //方法一：信任所有證書,不安全有風(fēng)險
//.setCertificates(new SafeTrustManager()) //方法二：自定義信任規(guī)則，校驗服務(wù)端證書
//配置https的域名匹配規(guī)則，不需要就不要加入，使用不當(dāng)會導(dǎo)致https握手失敗
//.setHostnameVerifier(new SafeHostnameVerifier())
//.addConverterFactory(GsonConverterFactory.create(gson))//本框架沒有采用Retrofit的Gson轉(zhuǎn)化，所以不用配置
.addCommonHeaders(headers)//設(shè)置全局公共頭
.addCommonParams(params)//設(shè)置全局公共參數(shù)
//.addNetworkInterceptor(new NoCacheInterceptor())//設(shè)置網(wǎng)絡(luò)攔截器
//.setCallFactory()//局設(shè)置Retrofit對象Factory
//.setCookieStore()//設(shè)置cookie
//.setOkproxy()//設(shè)置全局代理
//.setOkconnectionPool()//設(shè)置請求連接池
//.setCallbackExecutor()//全局設(shè)置Retrofit callbackExecutor
//可以添加全局?jǐn)r截器，不需要就不要加入，錯誤寫法直接導(dǎo)致任何回調(diào)不執(zhí)行
//.addInterceptor(new GzipRequestInterceptor())//開啟post數(shù)據(jù)進(jìn)行g(shù)zip后發(fā)送給服務(wù)器
.addInterceptor(new CustomSignInterceptor());//添加參數(shù)簽名攔截器
}
}
請求數(shù)據(jù)
網(wǎng)絡(luò)請求，采用鏈?zhǔn)秸{(diào)用，支持一點到底。
入口方法 /**
* get請求
*/
public static GetRequest get(String url);
/**
* post請求和文件上傳
*/
public static PostRequest post(String url);
/**
* delete請求
*/
public static DeleteRequest delete(String url) ;
/**
* 自定義請求
*/
public static CustomRequest custom();
/**
* 文件下載
*/
public static DownloadRequest downLoad(String url) ;
/**
* put請求
*/
public static PutRequest put(String url);
通用功能配置
1.包含一次普通請求所有能配置的參數(shù)，真實使用時不需要配置這么多，按自己的需要選擇性的使用即可
2.以下配置全部是單次請求配置，不會影響全局配置，沒有配置的仍然是使用全局參數(shù)。
3.為單個請求設(shè)置超時，比如涉及到文件的需要設(shè)置讀寫等待時間多一點。
完整參數(shù)GET示例：
EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
.baseUrl("http://www.xxxx.com")//設(shè)置url
.writeTimeOut(30*1000)//局部寫超時30s,單位毫秒
.readTimeOut(30*1000)//局部讀超時30s,單位毫秒
.connectTimeout(30*1000)//局部連接超時30s,單位毫秒
.headers(new HttpHeaders("header1","header1Value"))//添加請求頭參數(shù)
.headers("header2","header2Value")//支持添加多個請求頭同時添加
.headers("header3","header3Value")//支持添加多個請求頭同時添加
.params("param1","param1Value")//支持添加多個參數(shù)同時添加
.params("param2","param2Value")//支持添加多個參數(shù)同時添加
//.addCookie(new CookieManger(this).addCookies())//支持添加Cookie
.cacheTime(300)//緩存300s 單位s
.cacheKey("cachekey")//緩存key
.cacheMode(CacheMode.CACHEANDREMOTE)//設(shè)置請求緩存模式
//.okCache()//使用模式緩存模式時，走Okhttp緩存
.cacheDiskConverter(new GsonDiskConverter())//GSON-數(shù)據(jù)轉(zhuǎn)換器
//.certificates()添加證書
.retryCount(5)//本次請求重試次數(shù)
.retryDelay(500)//本次請求重試延遲時間500ms
.addInterceptor(Interceptor)//添加攔截器
.okproxy()//設(shè)置代理
.removeHeader("header2")//移除頭部header2
.removeAllHeaders()//移除全部請求頭
.removeParam("param1")
.accessToken(true)//本次請求是否追加token
.timeStamp(false)//本次請求是否攜帶時間戳
.sign(false)//本次請求是否需要簽名
.syncRequest(true)//是否是同步請求，默認(rèn)異步請求。true:同步請求
.execute(new CallBack() {
@Override
public void onStart() {
//開始請求
}
@Override
public void onCompleted() {
//請求完成
}
@Override
public void onError(ApiException e) {
//請求錯誤
}
@Override
public void onSuccess(SkinTestResult response) {
//請求成功
}
});
url
Url可以通過初始化配置的時候傳入EasyHttp.getInstance().setBaseUrl("http://www.xxx.com");
入口方法傳入： EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult").baseUrl("http://www.xxxx.com")
如果入口方法中傳入的url含有http或者h(yuǎn)ttps,則不會拼接初始化設(shè)置的baseUrl.
例如：EasyHttp.get("http://www.xxx.com/v1/app/chairdressing/skinAnalyzePower/skinTestResult")則setBaseUrl()和baseUrl()傳入的baseurl都不會被拼接。
兩種設(shè)置方式
.params(HttpParams params)
.params("param1","param1Value")//添加參數(shù)鍵值對
HttpParams params = new HttpParams();
params.put("appId", AppConstant.APPID);
.addCommonParams(params)//設(shè)置全局公共參數(shù)
.headers(HttpHeaders headers)
.headers("header2","header2Value")//添加參數(shù)鍵值對
.addCommonHeaders(headers)//設(shè)置全局公共頭
普通網(wǎng)絡(luò)請求支持get/post/delete/put等
鏈?zhǔn)秸{(diào)用的終點請求的執(zhí)行方式有：execute(Class
1.EasyHttp（推薦）
示例：
方式一：
//EasyHttp.post("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
.readTimeOut(30 * 1000)//局部定義讀超時
.writeTimeOut(30 * 1000)
.connectTimeout(30 * 1000)
.params("name","張三")
.timeStamp(true)
.execute(new SimpleCallBack() {
@Override
public void onError(ApiException e) {
showToast(e.getMessage());
}
@Override
public void onSuccess(SkinTestResult response) {
if (response != null) showToast(response.toString());
}
});
2.手動創(chuàng)建請求對象
//GetRequest 、PostRequest、DeleteRequest、PutRequest
GetRequest request = new GetRequest("/v1/app/chairdressing/skinAnalyzePower/skinTestResult");
request.readTimeOut(30 * 1000)//局部定義讀超時
.params("param1", "param1Value1")
.execute(new SimpleCallBack() {
@Override
public void onError(ApiException e) {
}
@Override
public void onSuccess(SkinTestResult response) {
}
});
execute(Classexecute(Class
EasyHttp.get(url)
.params("param1", "paramValue1")
.execute(SkinTestResult.class)//非常簡單直接傳目標(biāo)class
//.execute(new TypeToken>() {}.getType())//Type類型
.subscribe(new BaseSubscriber() {
@Override
public void onError(ApiException e) {
showToast(e.getMessage());
}
@Override
public void onNext(SkinTestResult skinTestResult) {
showToast(skinTestResult.toString());
}
});
請求返回Disposable
網(wǎng)絡(luò)請求會返回Disposable對象，方便取消網(wǎng)絡(luò)請求
Disposable disposable = EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
.params("param1", "paramValue1")
.execute(new SimpleCallBack() {
@Override
public void onError(ApiException e) {
showToast(e.getMessage());
}
@Override
public void onSuccess(SkinTestResult response) {
showToast(response.toString());
}
});
//在需要取消網(wǎng)絡(luò)請求的地方調(diào)用,一般在onDestroy()中
//EasyHttp.cancelSubscription(disposable);
帶有進(jìn)度框的請求
帶有進(jìn)度框的請求，可以設(shè)置對話框消失是否自動取消網(wǎng)絡(luò)和自定義對話框功能，具體參數(shù)作用請看請求回調(diào)講解
方式一：ProgressDialogCallBackProgressDialogCallBack帶有進(jìn)度框的請求，可以設(shè)置對話框消失是否自動取消網(wǎng)絡(luò)和自定義對話框功能，具體參數(shù)作用請看自定義CallBack講解
IProgressDialog mProgressDialog = new IProgressDialog() {
@Override
public Dialog getDialog() {
ProgressDialog dialog = new ProgressDialog(MainActivity.this);
dialog.setMessage("請稍候...");
return dialog;
}
};
EasyHttp.get("/v1/app/chairdressing/")
.params("param1", "paramValue1")
.execute(new ProgressDialogCallBack(mProgressDialog, true, true) {
@Override
public void onError(ApiException e) {
super.onError(e);//super.onError(e)必須寫不能刪掉或者忘記了
//請求成功
}
@Override
public void onSuccess(SkinTestResult response) {
//請求失敗
}
});
注：錯誤回調(diào) super.onError(e);必須寫
方式二：ProgressSubscriberIProgressDialog mProgressDialog = new IProgressDialog() {
@Override
public Dialog getDialog() {
ProgressDialog dialog = new ProgressDialog(MainActivity.this);
dialog.setMessage("請稍候...");
return dialog;
}
};
EasyHttp.get(URL)
.timeStamp(true)
.execute(SkinTestResult.class)
.subscribe(new ProgressSubscriber(this, mProgressDialog) {
@Override
public void onError(ApiException e) {
super.onError(e);
showToast(e.getMessage());
}
@Override
public void onNext(SkinTestResult skinTestResult) {
showToast(skinTestResult.toString());
}
});
請求返回Observable
通過網(wǎng)絡(luò)請求可以返回Observable，這樣就可以很好的通過Rxjava與其它場景業(yè)務(wù)結(jié)合處理，甚至可以通過Rxjava的connect()操作符處理多個網(wǎng)絡(luò)請求。例如：在一個頁面有多個網(wǎng)絡(luò)請求，如何在多個請求都訪問成功后再顯示頁面呢？這也是Rxjava強(qiáng)大之處。
注：目前通過execute(Class
示例：
Observable文件下載observable = EasyHttp.get(url) .params("param1", "paramValue1") .execute(SkinTestResult.class); observable.subscribe(new BaseSubscriber () { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onNext(SkinTestResult skinTestResult) { showToast(skinTestResult.toString()); } });
本庫提供的文件下載非常簡單，沒有提供復(fù)雜的下載方式例如：下載管理器、斷點續(xù)傳、多線程下載等，因為不想把本庫做重。如果復(fù)雜的下載方式，還請考慮其它下載方案。
文件目錄如果不指定,默認(rèn)下載的目錄為/storage/emulated/0/Android/data/包名/files
文件名如果不指定,則按照以下規(guī)則命名:
1.首先檢查用戶是否傳入了文件名,如果傳入,將以用戶傳入的文件名命名
2.如果沒有傳入文件名，默認(rèn)名字是時間戳生成的。
3.如果傳入了文件名但是沒有后綴，程序會自動解析類型追加后綴名
示例：
String url = "http://61.144.207.146:8081/b8154d3d-4166-4561-ad8d-7188a96eb195/2005/07/6c/076ce42f-3a78-4b5b-9aae-3c2959b7b1ba/kfid/2475751/qqlite_3.5.0.660_android_r108360_GuanWang_537047121_release_10000484.apk";
EasyHttp.downLoad(url)
.savePath("/sdcard/test/QQ")
.saveName("release_10000484.apk")//不設(shè)置默認(rèn)名字是時間戳生成的
.execute(new DownloadProgressCallBack() {
@Override
public void update(long bytesRead, long contentLength, boolean done) {
int progress = (int) (bytesRead * 100 / contentLength);
HttpLog.e(progress + "% ");
dialog.setProgress(progress);
if (done) {//下載完成
}
...
}
@Override
public void onStart() {
//開始下載
}
@Override
public void onComplete(String path) {
//下載完成，path：下載文件保存的完整路徑
}
@Override
public void onError(ApiException e) {
//下載失敗
}
});
POST請求，上傳String、json、object、body、byte[]
一般此種用法用于與服務(wù)器約定的數(shù)據(jù)格式，當(dāng)使用該方法時，params中的參數(shù)設(shè)置是無效的，所有參數(shù)均需要通過需要上傳的文本中指定，此外，額外指定的header參數(shù)仍然保持有效。
.upString("這是要上傳的長文本數(shù)據(jù)！")//默認(rèn)類型是：MediaType.parse("text/plain")
如果你對請求頭有自己的要求，可以使用這個重載的形式，傳入自定義的content-type文本
upString("這是要上傳的長文本數(shù)據(jù)！", "application/xml") // 比如上傳xml數(shù)據(jù)，這里就可以自己指定請求頭
upJson該方法與upString沒有本質(zhì)區(qū)別，只是數(shù)據(jù)格式是json,通常需要自己創(chuàng)建一個實體bean或者一個map，把需要的參數(shù)設(shè)置進(jìn)去，然后通過三方的Gson或者 fastjson轉(zhuǎn)換成json字符串，最后直接使用該方法提交到服務(wù)器。
.upJson(jsonObject.toString())//上傳json
.upBytes(new byte[]{})//上傳byte[]
.requestBody(body)//上傳自定義RequestBody
.upObject(object)//上傳對象object 必須要增加.addConverterFactory(GsonConverterFactory.create())設(shè)置
注：upString、upJson、requestBody、upBytes、upObject五個方法不能同時使用，當(dāng)前只能選用一個
示例：
