摘要:注和是當(dāng)下非常火爆的開(kāi)源框架,均來(lái)自神一般的公司。特點(diǎn)比使用更簡(jiǎn)單更易用。默認(rèn)初始化如果使用默認(rèn)始化后,一切采用默認(rèn)設(shè)置。為單個(gè)請(qǐng)求設(shè)置超時(shí),比如涉及到文件的需要設(shè)置讀寫(xiě)等待時(shí)間多一點(diǎn)。
github源碼地址:https://github.com/zhou-you/RxEasyHttp RxEasyHttp
本庫(kù)是一款基于RxJava2+Retrofit2實(shí)現(xiàn)簡(jiǎn)單易用的網(wǎng)絡(luò)請(qǐng)求框架,結(jié)合android平臺(tái)特性的網(wǎng)絡(luò)封裝庫(kù),采用api鏈?zhǔn)秸{(diào)用一點(diǎn)到底,集成cookie管理,多種緩存模式,極簡(jiǎn)https配置,上傳下載進(jìn)度顯示,請(qǐng)求錯(cuò)誤自動(dòng)重試,請(qǐng)求攜帶token、時(shí)間戳、簽名sign動(dòng)態(tài)配置,自動(dòng)登錄成功后請(qǐng)求重發(fā)功能,3種層次的參數(shù)設(shè)置默認(rèn)全局局部,默認(rèn)標(biāo)準(zhǔn)ApiResult同時(shí)可以支持自定義的數(shù)據(jù)結(jié)構(gòu),已經(jīng)能滿足現(xiàn)在的大部分網(wǎng)絡(luò)請(qǐng)求。
注:Retrofit和Rxjava是當(dāng)下非常火爆的開(kāi)源框架,均來(lái)自神一般的Square公司。本庫(kù)就不介紹Retrofit和Rxjava2的用法。
網(wǎng)上好的開(kāi)源網(wǎng)絡(luò)庫(kù)像Volley、async-http、okhttp、retrofit等都非常強(qiáng)大,但是實(shí)際應(yīng)用中我們不會(huì)直接去使用,一般都會(huì)根據(jù)自己的業(yè)務(wù)再封裝一層,這樣更方便快捷,又能統(tǒng)一處理業(yè)務(wù)共性的東西例如:統(tǒng)一的數(shù)據(jù)結(jié)構(gòu)(code、msg、data)、token處理、網(wǎng)絡(luò)異常等情況。在使用retrofit來(lái)請(qǐng)求網(wǎng)絡(luò)的時(shí)候,項(xiàng)目的需求越來(lái)越多,api也隨之越來(lái)越多,一個(gè)普通的應(yīng)用api一般也在100+左右。如果把這些api放在一個(gè)ApiService內(nèi)會(huì)很臃腫,不利于查看api.如果采用模塊的方式對(duì)api進(jìn)行分類,每個(gè)模塊對(duì)應(yīng)若干個(gè)api.以retrofit的使用方式又需要?jiǎng)?chuàng)建若干個(gè)ApiService,這種方式維護(hù)方便,但是模塊增多了,類也增多了很多。對(duì)于懶人來(lái)說(shuō)就想通過(guò)一個(gè)URL就能回調(diào)你所需要的數(shù)據(jù),什么ApiService都不想理會(huì),同時(shí)又可以很快的與自己的業(yè)務(wù)相關(guān)聯(lián),就類似于代替你在開(kāi)源網(wǎng)絡(luò)庫(kù)基礎(chǔ)上再封裝一層的作用,于是本庫(kù)就應(yīng)運(yùn)而生。
特點(diǎn)比Retrofit使用更簡(jiǎn)單、更易用。
采用鏈?zhǔn)秸{(diào)用一點(diǎn)到底
加入基礎(chǔ)ApiService,減少Api冗余
支持動(dòng)態(tài)配置和自定義底層框架Okhttpclient、Retrofit.
支持多種方式訪問(wèn)網(wǎng)絡(luò)GET、POST、PUT、DELETE等請(qǐng)求協(xié)議
支持網(wǎng)絡(luò)緩存,六種緩存策略可選,涵蓋大多數(shù)業(yè)務(wù)場(chǎng)景
支持固定添加header和動(dòng)態(tài)添加header
支持添加全局參數(shù)和動(dòng)態(tài)添加局部參數(shù)
支持文件下載、多文件上傳和表單提交數(shù)據(jù)
支持文件請(qǐng)求、上傳、下載的進(jìn)度回調(diào)、錯(cuò)誤回調(diào),也可以自定義回調(diào)
支持默認(rèn)、全局、局部三個(gè)層次的配置功能
支持任意數(shù)據(jù)結(jié)構(gòu)的自動(dòng)解析
支持添加動(dòng)態(tài)參數(shù)例如timeStamp時(shí)間戳、token、簽名sign
支持自定義的擴(kuò)展API
支持多個(gè)請(qǐng)求合并
支持Cookie管理
支持異步、同步請(qǐng)求
支持Https、自簽名網(wǎng)站Https的訪問(wèn)、雙向驗(yàn)證
支持失敗重試機(jī)制,可以指定重試次數(shù)、重試間隔時(shí)間
支持根據(jù)ky刪除網(wǎng)絡(luò)緩存和清空網(wǎng)絡(luò)緩存
提供默認(rèn)的標(biāo)準(zhǔn)ApiResult解析和回調(diào),并且可自定義ApiResult
支持取消數(shù)據(jù)請(qǐng)求,取消訂閱,帶有對(duì)話框的請(qǐng)求不需要手動(dòng)取消請(qǐng)求,對(duì)話框消失會(huì)自動(dòng)取消請(qǐng)求
支持請(qǐng)求數(shù)據(jù)結(jié)果采用回調(diào)和訂閱兩種方式
api設(shè)計(jì)上結(jié)合http協(xié)議和android平臺(tái)特點(diǎn)來(lái)實(shí)現(xiàn),loading對(duì)話框,實(shí)時(shí)進(jìn)度條顯示
返回結(jié)果和異常統(tǒng)一處理
結(jié)合RxJava2,線程智能控制
聯(lián)系方式郵箱地址: 478319399@qq.com
QQ群: 581235049(建議使用QQ群,郵箱使用較少,可能看的不及時(shí))
本群旨在為使用我的github項(xiàng)目的人提供方便,如果遇到問(wèn)題歡迎在群里提問(wèn)。一個(gè)人的能力也有限,希望一起學(xué)習(xí)一起進(jìn)步。
關(guān)注我的github,了解我的最新項(xiàng)目。關(guān)注我的博客,閱讀我的最新文章。
V2.0.5
網(wǎng)絡(luò)庫(kù)從Rxjava升級(jí)到Rxjava2
優(yōu)化緩存策略實(shí)現(xiàn)
修復(fù)同步請(qǐng)求回調(diào)問(wèn)題
修復(fù)put請(qǐng)求失敗問(wèn)題
修改圖片請(qǐng)求失敗@url問(wèn)題導(dǎo)致404錯(cuò)誤
修復(fù)多圖片表單上傳失敗問(wèn)題
Demo增加根據(jù)key獲取緩存的演示
修復(fù)post提交json到后臺(tái)問(wèn)題
定位upObject失敗原因,需要加轉(zhuǎn)換器addConverterFactory(GsonConverterFactory.create())
更新日志點(diǎn)擊查看更新日志
用法介紹目前只支持主流開(kāi)發(fā)工具AndtoidStudio的使用,沒(méi)有提供Eclipse使用方式.
本項(xiàng)目Demo的網(wǎng)絡(luò)請(qǐng)求的服務(wù)器地址為了安全,把url去掉了,但是Demo程序中的示例都是ok的
dependencies { compile "com.zhouyou:rxeasyhttp:2.0.5" }
想查看所有版本,請(qǐng)點(diǎn)擊下面地址。
Latest release: https://jcenter.bintray.com/com/zhouyou/rxeasyhttp/
權(quán)限說(shuō)明如果使用本庫(kù)實(shí)現(xiàn)文件下載到SD卡、或者配置了緩存數(shù)據(jù)到SD卡,你必須要考慮到Android6.0及以上系統(tǒng)的運(yùn)行時(shí)權(quán)限,給大家推薦兩個(gè)權(quán)限庫(kù):
AndPermission
RxPermissions
因?yàn)橐?qǐng)求網(wǎng)絡(luò)、從SD卡讀寫(xiě)緩存、下載文件到SD卡等等,所以需要在manifest.xml中配置以下幾個(gè)權(quán)限,如果你已經(jīng)配置過(guò)了這些權(quán)限,請(qǐng)不要重復(fù)配置:
全局配置
一般在 Aplication,或者基類中,只需要調(diào)用一次即可,可以配置調(diào)試開(kāi)關(guān),全局的超時(shí)時(shí)間,公共的請(qǐng)求頭和請(qǐng)求參數(shù)等信息
初始化需要一個(gè)Context,最好在Application#onCreate()中初始化,記得在manifest.xml中注冊(cè)Application。
public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); } }manifest.xml:
...默認(rèn)初始化
如果使用默認(rèn)始化后,一切采用默認(rèn)設(shè)置。如果你需要配置全局超時(shí)時(shí)間、緩存、Cookie、底層為OkHttp的話,請(qǐng)看高級(jí)初始化。
public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); EasyHttp.init(this);//默認(rèn)初始化 } }高級(jí)初始化
可以進(jìn)行超時(shí)配置、網(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è)置請(qǐng)求頭 HttpHeaders headers = new HttpHeaders(); headers.put("User-Agent", SystemInfoUtils.getUserAgent(this, AppConstant.APPID)); //全局設(shè)置請(qǐng)求參數(shù) HttpParams params = new HttpParams(); params.put("appId", AppConstant.APPID); //以下設(shè)置的所有參數(shù)是全局參數(shù),同樣的參數(shù)可以在請(qǐng)求的時(shí)候再設(shè)置一遍,那么對(duì)于該請(qǐng)求來(lái)講,請(qǐng)求中的參數(shù)會(huì)覆蓋全局參數(shù) EasyHttp.getInstance() //可以全局統(tǒng)一設(shè)置全局URL .setBaseUrl(Url)//設(shè)置全局URL // 打開(kāi)該調(diào)試開(kāi)關(guān)并設(shè)置TAG,不需要就不要加入該行 // 最后的true表示是否打印okgo的內(nèi)部異常,一般打開(kāi)方便調(diào)試錯(cuò)誤 .debug("EasyHttp", true) //如果使用默認(rèn)的60秒,以下三行也不需要設(shè)置 .setReadTimeOut(60 * 1000) .setWriteTimeOut(60 * 100) .setConnectTimeout(60 * 100) //可以全局統(tǒng)一設(shè)置超時(shí)重連次數(shù),默認(rèn)為3次,那么最差的情況會(huì)請(qǐng)求4次(一次原始請(qǐng)求,三次重連請(qǐng)求), //不需要可以設(shè)置為0 .setRetryCount(3)//網(wǎng)絡(luò)不好自動(dòng)重試3次 //可以全局統(tǒng)一設(shè)置超時(shí)重試間隔時(shí)間,默認(rèn)為500ms,不需要可以設(shè)置為0 .setRetryDelay(500)//每次延時(shí)500ms重試 //可以全局統(tǒng)一設(shè)置超時(shí)重試間隔疊加時(shí)間,默認(rèn)為0ms不疊加 .setRetryIncreaseDelay(500)//每次延時(shí)疊加500ms //可以全局統(tǒng)一設(shè)置緩存模式,默認(rèn)是不使用緩存,可以不傳,具體請(qǐng)看CacheMode .setCacheMode(CacheMode.NO_CACHE) //可以全局統(tǒng)一設(shè)置緩存時(shí)間,默認(rèn)永不過(guò)期 .setCacheTime(-1)//-1表示永久緩存,單位:秒 ,Okhttp和自定義RxCache緩存都起作用 //全局設(shè)置自定義緩存保存轉(zhuǎn)換器,主要針對(duì)自定義RxCache緩存 .setCacheDiskConverter(new SerializableDiskConverter())//默認(rèn)緩存使用序列化轉(zhuǎn)化 //全局設(shè)置自定義緩存大小,默認(rèn)50M .setCacheMaxSize(100 * 1024 * 1024)//設(shè)置緩存大小為100M //設(shè)置緩存版本,如果緩存有變化,修改版本后,緩存就不會(huì)被加載。特別是用于版本重大升級(jí)時(shí)緩存不能使用的情況 .setCacheVersion(1)//緩存版本為1 //.setHttpCache(new Cache())//設(shè)置Okhttp緩存,在緩存模式為DEFAULT才起作用 //可以設(shè)置https的證書(shū),以下幾種方案根據(jù)需要自己設(shè)置 .setCertificates() //方法一:信任所有證書(shū),不安全有風(fēng)險(xiǎn) //.setCertificates(new SafeTrustManager()) //方法二:自定義信任規(guī)則,校驗(yàn)服務(wù)端證書(shū) //配置https的域名匹配規(guī)則,不需要就不要加入,使用不當(dāng)會(huì)導(dǎo)致https握手失敗 //.setHostnameVerifier(new SafeHostnameVerifier()) //.addConverterFactory(GsonConverterFactory.create(gson))//本框架沒(méi)有采用Retrofit的Gson轉(zhuǎn)化,所以不用配置 .addCommonHeaders(headers)//設(shè)置全局公共頭 .addCommonParams(params)//設(shè)置全局公共參數(shù) //.addNetworkInterceptor(new NoCacheInterceptor())//設(shè)置網(wǎng)絡(luò)攔截器 //.setCallFactory()//局設(shè)置Retrofit對(duì)象Factory //.setCookieStore()//設(shè)置cookie //.setOkproxy()//設(shè)置全局代理 //.setOkconnectionPool()//設(shè)置請(qǐng)求連接池 //.setCallbackExecutor()//全局設(shè)置Retrofit callbackExecutor //可以添加全局?jǐn)r截器,不需要就不要加入,錯(cuò)誤寫(xiě)法直接導(dǎo)致任何回調(diào)不執(zhí)行 //.addInterceptor(new GzipRequestInterceptor())//開(kāi)啟post數(shù)據(jù)進(jìn)行g(shù)zip后發(fā)送給服務(wù)器 .addInterceptor(new CustomSignInterceptor());//添加參數(shù)簽名攔截器 } }請(qǐng)求數(shù)據(jù)
網(wǎng)絡(luò)請(qǐng)求,采用鏈?zhǔn)秸{(diào)用,支持一點(diǎn)到底。
入口方法/** * get請(qǐng)求 */ public static GetRequest get(String url); /** * post請(qǐng)求和文件上傳 */ public static PostRequest post(String url); /** * delete請(qǐng)求 */ public static DeleteRequest delete(String url) ; /** * 自定義請(qǐng)求 */ public static CustomRequest custom(); /** * 文件下載 */ public static DownloadRequest downLoad(String url) ; /** * put請(qǐng)求 */ public static PutRequest put(String url);通用功能配置
1.包含一次普通請(qǐng)求所有能配置的參數(shù),真實(shí)使用時(shí)不需要配置這么多,按自己的需要選擇性的使用即可
2.以下配置全部是單次請(qǐng)求配置,不會(huì)影響全局配置,沒(méi)有配置的仍然是使用全局參數(shù)。
3.為單個(gè)請(qǐng)求設(shè)置超時(shí),比如涉及到文件的需要設(shè)置讀寫(xiě)等待時(shí)間多一點(diǎn)。
完整參數(shù)GET示例:
EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult") .baseUrl("http://www.xxxx.com")//設(shè)置url .writeTimeOut(30*1000)//局部寫(xiě)超時(shí)30s,單位毫秒 .readTimeOut(30*1000)//局部讀超時(shí)30s,單位毫秒 .connectTimeout(30*1000)//局部連接超時(shí)30s,單位毫秒 .headers(new HttpHeaders("header1","header1Value"))//添加請(qǐng)求頭參數(shù) .headers("header2","header2Value")//支持添加多個(gè)請(qǐng)求頭同時(shí)添加 .headers("header3","header3Value")//支持添加多個(gè)請(qǐng)求頭同時(shí)添加 .params("param1","param1Value")//支持添加多個(gè)參數(shù)同時(shí)添加 .params("param2","param2Value")//支持添加多個(gè)參數(shù)同時(shí)添加 //.addCookie(new CookieManger(this).addCookies())//支持添加Cookie .cacheTime(300)//緩存300s 單位s .cacheKey("cachekey")//緩存key .cacheMode(CacheMode.CACHEANDREMOTE)//設(shè)置請(qǐng)求緩存模式 //.okCache()//使用模式緩存模式時(shí),走Okhttp緩存 .cacheDiskConverter(new GsonDiskConverter())//GSON-數(shù)據(jù)轉(zhuǎn)換器 //.certificates()添加證書(shū) .retryCount(5)//本次請(qǐng)求重試次數(shù) .retryDelay(500)//本次請(qǐng)求重試延遲時(shí)間500ms .addInterceptor(Interceptor)//添加攔截器 .okproxy()//設(shè)置代理 .removeHeader("header2")//移除頭部header2 .removeAllHeaders()//移除全部請(qǐng)求頭 .removeParam("param1") .accessToken(true)//本次請(qǐng)求是否追加token .timeStamp(false)//本次請(qǐng)求是否攜帶時(shí)間戳 .sign(false)//本次請(qǐng)求是否需要簽名 .syncRequest(true)//是否是同步請(qǐng)求,默認(rèn)異步請(qǐng)求。true:同步請(qǐng)求 .execute(new CallBackurl() { @Override public void onStart() { //開(kāi)始請(qǐng)求 } @Override public void onCompleted() { //請(qǐng)求完成 } @Override public void onError(ApiException e) { //請(qǐng)求錯(cuò)誤 } @Override public void onSuccess(SkinTestResult response) { //請(qǐng)求成功 } });
Url可以通過(guò)初始化配置的時(shí)候傳入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,則不會(huì)拼接初始化設(shè)置的baseUrl.
例如:EasyHttp.get("http://www.xxx.com/v1/app/chairdressing/skinAnalyzePower/skinTestResult")則setBaseUrl()和baseUrl()傳入的baseurl都不會(huì)被拼接。
兩種設(shè)置方式
.params(HttpParams params)
.params("param1","param1Value")//添加參數(shù)鍵值對(duì)
HttpParams params = new HttpParams();
params.put("appId", AppConstant.APPID);
.addCommonParams(params)//設(shè)置全局公共參數(shù)
.headers(HttpHeaders headers)
.headers("header2","header2Value")//添加參數(shù)鍵值對(duì)
.addCommonHeaders(headers)//設(shè)置全局公共頭
普通網(wǎng)絡(luò)請(qǐng)求支持get/post/delete/put等
鏈?zhǔn)秸{(diào)用的終點(diǎn)請(qǐng)求的執(zhí)行方式有:execute(Class
1.EasyHttp(推薦)
示例:
方式一: //EasyHttp.post("/v1/app/chairdressing/skinAnalyzePower/skinTestResult") EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult") .readTimeOut(30 * 1000)//局部定義讀超時(shí) .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.手動(dòng)創(chuàng)建請(qǐng)求對(duì)象
//GetRequest 、PostRequest、DeleteRequest、PutRequest GetRequest request = new GetRequest("/v1/app/chairdressing/skinAnalyzePower/skinTestResult"); request.readTimeOut(30 * 1000)//局部定義讀超時(shí) .params("param1", "param1Value1") .execute(new SimpleCallBackexecute(Class() { @Override public void onError(ApiException e) { } @Override public void onSuccess(SkinTestResult response) { } });
execute(Class
EasyHttp.get(url) .params("param1", "paramValue1") .execute(SkinTestResult.class)//非常簡(jiǎn)單直接傳目標(biāo)class //.execute(new TypeToken請(qǐng)求返回Disposable>() {}.getType())//Type類型 .subscribe(new BaseSubscriber
() { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onNext(SkinTestResult skinTestResult) { showToast(skinTestResult.toString()); } });
網(wǎng)絡(luò)請(qǐng)求會(huì)返回Disposable對(duì)象,方便取消網(wǎng)絡(luò)請(qǐng)求
Disposable disposable = EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult") .params("param1", "paramValue1") .execute(new SimpleCallBack帶有進(jìn)度框的請(qǐng)求() { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onSuccess(SkinTestResult response) { showToast(response.toString()); } }); //在需要取消網(wǎng)絡(luò)請(qǐng)求的地方調(diào)用,一般在onDestroy()中 //EasyHttp.cancelSubscription(disposable);
帶有進(jìn)度框的請(qǐng)求,可以設(shè)置對(duì)話框消失是否自動(dòng)取消網(wǎng)絡(luò)和自定義對(duì)話框功能,具體參數(shù)作用請(qǐng)看請(qǐng)求回調(diào)講解
方式一:ProgressDialogCallBackProgressDialogCallBack帶有進(jìn)度框的請(qǐng)求,可以設(shè)置對(duì)話框消失是否自動(dòng)取消網(wǎng)絡(luò)和自定義對(duì)話框功能,具體參數(shù)作用請(qǐng)看自定義CallBack講解
IProgressDialog mProgressDialog = new IProgressDialog() { @Override public Dialog getDialog() { ProgressDialog dialog = new ProgressDialog(MainActivity.this); dialog.setMessage("請(qǐng)稍候..."); 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)必須寫(xiě)不能刪掉或者忘記了 //請(qǐng)求成功 } @Override public void onSuccess(SkinTestResult response) { //請(qǐng)求失敗 } });
注:錯(cuò)誤回調(diào) super.onError(e);必須寫(xiě)
方式二:ProgressSubscriberIProgressDialog mProgressDialog = new IProgressDialog() { @Override public Dialog getDialog() { ProgressDialog dialog = new ProgressDialog(MainActivity.this); dialog.setMessage("請(qǐng)稍候..."); return dialog; } }; EasyHttp.get(URL) .timeStamp(true) .execute(SkinTestResult.class) .subscribe(new ProgressSubscriber請(qǐng)求返回Observable(this, mProgressDialog) { @Override public void onError(ApiException e) { super.onError(e); showToast(e.getMessage()); } @Override public void onNext(SkinTestResult skinTestResult) { showToast(skinTestResult.toString()); } });
通過(guò)網(wǎng)絡(luò)請(qǐng)求可以返回Observable,這樣就可以很好的通過(guò)Rxjava與其它場(chǎng)景業(yè)務(wù)結(jié)合處理,甚至可以通過(guò)Rxjava的connect()操作符處理多個(gè)網(wǎng)絡(luò)請(qǐng)求。例如:在一個(gè)頁(yè)面有多個(gè)網(wǎng)絡(luò)請(qǐng)求,如何在多個(gè)請(qǐng)求都訪問(wèn)成功后再顯示頁(yè)面呢?這也是Rxjava強(qiáng)大之處。
注:目前通過(guò)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()); } });
本庫(kù)提供的文件下載非常簡(jiǎn)單,沒(méi)有提供復(fù)雜的下載方式例如:下載管理器、斷點(diǎn)續(xù)傳、多線程下載等,因?yàn)椴幌氚驯編?kù)做重。如果復(fù)雜的下載方式,還請(qǐng)考慮其它下載方案。
文件目錄如果不指定,默認(rèn)下載的目錄為/storage/emulated/0/Android/data/包名/files
文件名如果不指定,則按照以下規(guī)則命名:
1.首先檢查用戶是否傳入了文件名,如果傳入,將以用戶傳入的文件名命名
2.如果沒(méi)有傳入文件名,默認(rèn)名字是時(shí)間戳生成的。
3.如果傳入了文件名但是沒(méi)有后綴,程序會(huì)自動(dòng)解析類型追加后綴名
示例:
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)名字是時(shí)間戳生成的 .execute(new DownloadProgressCallBackPOST請(qǐng)求,上傳String、json、object、body、byte[]() { @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() { //開(kāi)始下載 } @Override public void onComplete(String path) { //下載完成,path:下載文件保存的完整路徑 } @Override public void onError(ApiException e) { //下載失敗 } });
一般此種用法用于與服務(wù)器約定的數(shù)據(jù)格式,當(dāng)使用該方法時(shí),params中的參數(shù)設(shè)置是無(wú)效的,所有參數(shù)均需要通過(guò)需要上傳的文本中指定,此外,額外指定的header參數(shù)仍然保持有效。
.upString("這是要上傳的長(zhǎng)文本數(shù)據(jù)!")//默認(rèn)類型是:MediaType.parse("text/plain")
如果你對(duì)請(qǐng)求頭有自己的要求,可以使用這個(gè)重載的形式,傳入自定義的content-type文本
upString("這是要上傳的長(zhǎng)文本數(shù)據(jù)!", "application/xml") // 比如上傳xml數(shù)據(jù),這里就可以自己指定請(qǐng)求頭
upJson該方法與upString沒(méi)有本質(zhì)區(qū)別,只是數(shù)據(jù)格式是json,通常需要自己創(chuàng)建一個(gè)實(shí)體bean或者一個(gè)map,把需要的參數(shù)設(shè)置進(jìn)去,然后通過(guò)三方的Gson或者 fastjson轉(zhuǎn)換成json字符串,最后直接使用該方法提交到服務(wù)器。
.upJson(jsonObject.toString())//上傳json
.upBytes(new byte[]{})//上傳byte[]
.requestBody(body)//上傳自定義RequestBody
.upObject(object)//上傳對(duì)象object 必須要增加.addConverterFactory(GsonConverterFactory.create())設(shè)置
注:upString、upJson、requestBody、upBytes、upObject五個(gè)方法不能同時(shí)使用,當(dāng)前只能選用一個(gè)
示例:
HashMap上傳圖片或者文件params = new HashMap<>(); params.put("key1", "value1"); params.put("key2", "這里是需要提交的json格式數(shù)據(jù)"); params.put("key3", "也可以使用三方工具將對(duì)象轉(zhuǎn)成json字符串"); JSONObject jsonObject = new JSONObject(params); RequestBody body=RequestBody.create(MediaType.parse("xxx/xx"),"內(nèi)容"); EasyHttp.post("v1/app/chairdressing/news/favorite") //.params("param1", "paramValue1")//不能使用params,upString 與 params 是互斥的,只有 upString 的數(shù)據(jù)會(huì)被上傳 .upString("這里是要上傳的文本!")//默認(rèn)類型是:MediaType.parse("text/plain") //.upString("這是要上傳的長(zhǎng)文本數(shù)據(jù)!", "application/xml") // 比如上傳xml數(shù)據(jù),這里就可以自己指定請(qǐng)求頭 //.upJson(jsonObject.toString()) //.requestBody(body) //.upBytes(new byte[]{}) //.upObject(object) .execute(new SimpleCallBack () { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onSuccess(String response) { showToast(response); } });
支持單文件上傳、多文件上傳、混合上傳,同時(shí)支持進(jìn)度回調(diào),
暫不實(shí)現(xiàn)多線程上傳/分片上傳/斷點(diǎn)續(xù)傳等高級(jí)功能
上傳文件支持文件與參數(shù)一起同時(shí)上傳,也支持一個(gè)key上傳多個(gè)文件,以下方式可以任選
上傳文件支持兩種進(jìn)度回調(diào):ProgressResponseCallBack(線程中回調(diào))和UIProgressResponseCallBack(可以刷新UI)
final UIProgressResponseCallBack listener = new UIProgressResponseCallBack() { @Override public void onUIResponseProgress(long bytesRead, long contentLength, boolean done) { int progress = (int) (bytesRead * 100 / contentLength); if (done) {//完成 } ... } }; EasyHttp.post("/v1/user/uploadAvatar") //支持上傳新增的參數(shù) //.params(String key, File file, ProgressResponseCallBack responseCallBack) //.params(String key, InputStream stream, String fileName, ProgressResponseCallBack responseCallBack) //.params(String key, byte[] bytes, String fileName, ProgressResponseCallBack responseCallBack) //.addFileParams(String key, List取消請(qǐng)求 通過(guò)Disposable取消files, ProgressResponseCallBack responseCallBack) //.addFileWrapperParams(String key, List fileWrappers) //.params(String key, File file, String fileName, ProgressResponseCallBack responseCallBack) //.params(String key, T file, String fileName, MediaType contentType, ProgressResponseCallBack responseCallBack) //方式一:文件上傳 File file = new File("/sdcard/1.jpg"); //如果有文件名字可以不用再傳Type,會(huì)自動(dòng)解析到是image/* .params("avatar", file, file.getName(), listener) //.params("avatar", file, file.getName(),MediaType.parse("image/*"), listener) //方式二:InputStream上傳 final InputStream inputStream = getResources().getAssets().open("1.jpg"); .params("avatar", inputStream, "test.png", listener) //方式三:byte[]上傳 Bitmap bitmap = BitmapFactory.decodeResource(getResources(), R.mipmap.test); ByteArrayOutputStream baos = new ByteArrayOutputStream(); bitmap.compress(Bitmap.CompressFormat.PNG, 100, baos); final byte[] bytes = baos.toByteArray(); //.params("avatar",bytes,"streamfile.png",MediaType.parse("image/*"),listener) //如果有文件名字可以不用再傳Type,會(huì)自動(dòng)解析到是image/* .params("avatar", bytes, "streamfile.png", listener) .params("file1", new File("filepath1")) // 可以添加文件上傳 .params("file2", new File("filepath2")) // 支持多文件同時(shí)添加上傳 .addFileParams("key", List files) // 這里支持一個(gè)key傳多個(gè)文件 .params("param1", "paramValue1") // 這里可以上傳參數(shù) .accessToken(true) .timeStamp(true) .execute(new ProgressDialogCallBack (mProgressDialog, true, true) { @Override public void onError(ApiException e) { super.onError(e); showToast(e.getMessage()); } @Override public void onSuccess(String response) { showToast(response); } });
每個(gè)請(qǐng)求前都會(huì)返回一個(gè)Disposable,取消訂閱就可以取消網(wǎng)絡(luò)請(qǐng)求,如果是帶有進(jìn)度框的網(wǎng)絡(luò)請(qǐng)求,則不需要手動(dòng)取消網(wǎng)絡(luò)請(qǐng)求,會(huì)自動(dòng)取消。
Disposable mSubscription = EasyHttp.get(url).execute(callback); ... @Override protected void onDestroy() { super.onDestroy(); EasyHttp.cancelSubscription(mSubscription); }通過(guò)dialog取消
自動(dòng)取消使用ProgressDialogCallBack回調(diào)或者使用ProgressSubscriber,就不用再手動(dòng)調(diào)用cancelSubscription();
ProgressDialogCallBack:
EasyHttp.get(url).execute(new ProgressDialogCallBack());
ProgressSubscriber
EasyHttp.get(url).execute(SkinTestResult.class).subscribe(new ProgressSubscriber同步請(qǐng)求(this, mProgressDialog) { @Override public void onError(ApiException e) { super.onError(e); showToast(e.getMessage()); } @Override public void onNext(SkinTestResult skinTestResult) { showToast(skinTestResult.toString()); } })
同步請(qǐng)求只需要設(shè)置syncRequest()方法
EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult") ... .syncRequest(true)//設(shè)置同步請(qǐng)求 .execute(new CallBack請(qǐng)求回調(diào)CallBack支持的類型() {});
//支持回調(diào)的類型可以是Bean、String、CacheResult、CacheResult 、List new SimpleCallBack >()//支持緩存的回調(diào),請(qǐng)看緩存講解 new SimpleCallBack >()//支持緩存的回調(diào),請(qǐng)看緩存講解 new SimpleCallBack ()//返回Bean new SimpleCallBack ()//返回字符串 new SimpleCallBack ()//返回集合
注:其它回調(diào)同理
cookie使用cookie的內(nèi)容主要包括:名字,值,過(guò)期時(shí)間,路徑和域。路徑與域一起構(gòu)成cookie的作用范圍,關(guān)于cookie的作用這里就不再科普,自己可以去了解
cookie設(shè)置:
EasyHttp.getInstance() ... //如果不想讓本庫(kù)管理cookie,以下不需要 .setCookieStore(new CookieManger(this)) //cookie持久化存儲(chǔ),如果cookie不過(guò)期,則一直有效 ...
查看url所對(duì)應(yīng)的cookie
HttpUrl httpUrl = HttpUrl.parse("http://www.xxx.com/test"); CookieManger cookieManger = getCookieJar(); Listcookies = cookieManger.loadForRequest(httpUrl);
查看CookieManger所有cookie
PersistentCookieStore cookieStore= getCookieJar().getCookieStore(); Listcookies1= cookieStore.getCookies();
添加cookie
Cookie.Builder builder = new Cookie.Builder(); Cookie cookie = builder.name("mCookieKey1").value("mCookieValue1").domain(httpUrl.host()).build(); CookieManger cookieManger = getCookieJar(); cookieManger.saveFromResponse(httpUrl, cookie); //cookieStore.saveFromResponse(httpUrl, cookieList);//添加cookie集合
移除cookie
HttpUrl httpUrl = HttpUrl.parse("http://www.xxx.com/test"); CookieManger cookieManger = EasyHttp.getCookieJar(); Cookie cookie = builder.name("mCookieKey1").value("mCookieValue1").domain(httpUrl.host()).build(); cookieManger.remove(httpUrl,cookie);
清空cookie
CookieManger cookieManger = EasyHttp.getCookieJar(); cookieManger.removeAll();自定義call()請(qǐng)求
提供了用戶自定義ApiService的接口,您只需調(diào)用call方法即可.
示例:
public interface LoginService { @POST("{path}") @FormUrlEncoded Observable自定義apiCall()請(qǐng)求> login(@Path("path") String path, @FieldMap Map map); } final CustomRequest request = EasyHttp.custom() .addConverterFactory(GsonConverterFactory.create(new Gson()))//自定義的可以設(shè)置GsonConverterFactory .params("param1", "paramValue1") .build(); LoginService mLoginService = request.create(LoginService.class); LoginService mLoginService = request.create(LoginService.class); Observable > observable = request.call(mLoginService.login("v1/account/login", request.getParams().urlParamsMap)); Disposable subscription = observable.subscribe(new Action1 >() { @Override public void call(ApiResult result) { //請(qǐng)求成功 } }, new Action1 () { @Override public void call(Throwable throwable) { //請(qǐng)求失敗 } });
提供默認(rèn)的支持ApiResult結(jié)構(gòu),數(shù)據(jù)返回不需要帶ApiResult,直接返回目標(biāo).
示例:
Observable請(qǐng)求回調(diào)和訂閱observable = request.apiCall(mLoginService.login("v1/account/login", request.getParams().urlParamsMap));
請(qǐng)求回調(diào)本庫(kù)提供兩種方式Callback和Subscriber
回調(diào)方式此種方式主要針對(duì)execute(CallBack
CallBack所有回調(diào)的基類,抽象類
SimpleCallBack簡(jiǎn)單回調(diào),只有成功和失敗
ProgressDialogCallBack帶有進(jìn)度框的回調(diào),可以自定義進(jìn)度框、支持是否可以取消對(duì)話框、對(duì)話框消失自動(dòng)取消網(wǎng)絡(luò)請(qǐng)求等參數(shù)設(shè)置
DownloadProgressCallBack如果要做文件下載,則必須使用該回調(diào),內(nèi)部封裝了關(guān)于文件下載進(jìn)度回調(diào)的方法,如果使用其他回調(diào)也可以,但是沒(méi)有進(jìn)度通知
該網(wǎng)絡(luò)框架的核心使用方法即為Callback的繼承使用,因?yàn)椴煌捻?xiàng)目需求,會(huì)有個(gè)性化的回調(diào)請(qǐng)自定義
CallBack回調(diào)new CallBackSimpleCallBack回調(diào)() { @Override public void onStart() { //請(qǐng)求開(kāi)始 } @Override public void onCompleted() { //請(qǐng)求完成 } @Override public void onError(ApiException e) { //請(qǐng)求失敗 } @Override public void onSuccess(T t) { //請(qǐng)求成功 } }
new SimpleCallBackProgressDialogCallBack回調(diào)() { @Override public void onError(ApiException e) { //請(qǐng)求失敗 } @Override public void onSuccess(T t) { //請(qǐng)求成功 } }
可以自定義帶有加載進(jìn)度框的回調(diào),取消對(duì)話框會(huì)自動(dòng)取消掉網(wǎng)絡(luò)請(qǐng)求
提供兩個(gè)構(gòu)造
public ProgressDialogCallBack(IProgressDialog progressDialog);//默認(rèn)不能取消對(duì)話框
public ProgressDialogCallBack(IProgressDialog progressDialog, boolean isShowProgress, boolean isCancel);//自定義加載進(jìn)度框,可以設(shè)置是否顯示彈出框,是否可以取消 progressDialog: dialog對(duì)象接口 isShowProgress:對(duì)話框消失是否取消網(wǎng)絡(luò)請(qǐng)求 isCancel:是否可以取消對(duì)話框?qū)?yīng)Dialog的setCancelable(isCancel)方法;
自定義ProgressDialog對(duì)話框
private IProgressDialog mProgressDialog = new IProgressDialog() { @Override public Dialog getDialog() { ProgressDialog dialog = new ProgressDialog(MainActivity.this); dialog.setMessage("請(qǐng)稍候..."); return dialog; } };DownloadProgressCallBack回調(diào)
此回調(diào)只用于文件下載,具體請(qǐng)看文件下載講解
自定義CallBack回調(diào)如果對(duì)回調(diào)有特殊需求,支持可以繼承CallBack自己擴(kuò)展功能
訂閱方式此種方式主要是針對(duì)execute(Class
BaseSubscriber所有訂閱者的基類,抽象類
DownloadSubscriber下載的訂閱者,上層不需要關(guān)注
ProgressSubscriber帶有進(jìn)度框的訂閱,可以自定義進(jìn)度框、支持是否可以取消對(duì)話框、對(duì)話框消失自動(dòng)取消網(wǎng)絡(luò)請(qǐng)求等參數(shù)設(shè)置
new BaseSubscriber() { @Override public void onError(ApiException e) { //請(qǐng)求失敗 } @Override public void onNext(T t) { //請(qǐng)求成功 } }
new ProgressSubscriber自定義Subscriber(this, mProgressDialog) { @Override public void onError(ApiException e) { super.onError(e); //請(qǐng)求失敗 } @Override public void onNext(T t) { //請(qǐng)求成功 } }
如果對(duì)Subscriber有特殊需求,支持可以繼承BaseSubscriber自己擴(kuò)展訂閱者
緩存使用 緩存介紹本庫(kù)的緩存主要分okhttp的Cache緩存和自定義的RxCache緩存,大家有疑問(wèn)okhttp有緩存,retrofit也是支持通過(guò)header來(lái)設(shè)置緩存,為什么還要自定義一個(gè)緩存機(jī)制呢?通過(guò)自定義RxCache緩存使用更簡(jiǎn)單,更符合我們常用的業(yè)務(wù)需求(常用的緩存策略也不會(huì)太復(fù)雜), retrofit的緩存借助于okhttp通過(guò)攔截器interceptor實(shí)現(xiàn)或者通過(guò)@Headers("Cache-Control: public, max-age=3600)具體用法這里不做詳細(xì)描述,有興趣的可以自己去了解。動(dòng)態(tài)修改緩存時(shí)間不方便,例如:同一個(gè)接口,不同時(shí)間段請(qǐng)求的內(nèi)容緩存的時(shí)間不一樣,需要?jiǎng)討B(tài)修改。
對(duì)于DEFAULT模式是okhttp的Cache緩存。因?yàn)樵撃J绞峭耆裱瓨?biāo)準(zhǔn)的http協(xié)議的,緩存時(shí)間是依靠服務(wù)端響應(yīng)頭來(lái)控制,也可以通過(guò)攔截器自己處理
對(duì)于RxCache的緩存支持多種存儲(chǔ)方式,提供IDiskConverter轉(zhuǎn)換器接口目前支持SerializableDiskConverter和GsonDiskConverter兩種方式,也可以自定義Parcelable、fastjson、xml、kryo等轉(zhuǎn)換器
SerializableDiskConverter
使用緩存前,必須讓緩存的數(shù)據(jù)所有javaBean對(duì)象實(shí)現(xiàn)Serializable接口,否則會(huì)報(bào)NotSerializableException。 因?yàn)榫彺娴脑硎菍?duì)象序列化后保存,如果不實(shí)現(xiàn)Serializable接口,會(huì)導(dǎo)致對(duì)象無(wú)法序列化,進(jìn)而無(wú)法保存,也就達(dá)不到緩存的效果。
優(yōu)點(diǎn):存儲(chǔ)和讀取都不用再轉(zhuǎn)化直接就是需要的對(duì)象速度快
缺點(diǎn):如果javabean里面還有javabean且層級(jí)比較多,也必須每個(gè)都要實(shí)現(xiàn)Serializable接口,比較麻煩
GsonDiskConverter
此種方式就是以json字符串的方式存儲(chǔ)
優(yōu)點(diǎn):相對(duì)于SerializableDiskConverter轉(zhuǎn)換器,存儲(chǔ)的對(duì)象不需要進(jìn)行序列化
缺點(diǎn):就是存儲(chǔ)和讀取都要使用Gson進(jìn)行轉(zhuǎn)換,object->String->Object的給一個(gè)過(guò)程,相對(duì)來(lái)說(shuō)每次都要轉(zhuǎn)換性能略低,但是性能基本忽略不計(jì)
目前提供了八種CacheMode緩存模式,每種緩存模式都可以指定對(duì)應(yīng)的CacheTime,將復(fù)雜常用的業(yè)務(wù)場(chǎng)景封裝在里面,讓你不用關(guān)心緩存的具體實(shí)現(xiàn),而專注于數(shù)據(jù)的處理
NO_CACHE:不使用緩存,該模式下,cacheKey,cacheTime 等參數(shù)均無(wú)效
DEFAULT:按照HTTP協(xié)議的默認(rèn)緩存規(guī)則,走OKhttp的Cache緩存
FIRSTREMOTE:先請(qǐng)求網(wǎng)絡(luò),請(qǐng)求網(wǎng)絡(luò)失敗后再加載緩存
FIRSTCACHE:先加載緩存,緩存沒(méi)有再去請(qǐng)求網(wǎng)絡(luò)
ONLYREMOTE:僅加載網(wǎng)絡(luò),但數(shù)據(jù)依然會(huì)被緩存
ONLYCACHE:只讀取緩存,緩存沒(méi)有會(huì)返回null
CACHEANDREMOTE:先使用緩存,不管是否存在,仍然請(qǐng)求網(wǎng)絡(luò),CallBack會(huì)回調(diào)兩次.
CACHEANDREMOTEDISTINCT:先使用緩存,不管是否存在,仍然請(qǐng)求網(wǎng)絡(luò),CallBack回調(diào)不一定是兩次,如果發(fā)現(xiàn)請(qǐng)求的網(wǎng)絡(luò)數(shù)據(jù)和緩存數(shù)據(jù)是一樣的,就不會(huì)再返回網(wǎng)絡(luò)的回調(diào),既回調(diào)一次。否則不相同仍然會(huì)回調(diào)兩次。(目的是為了防止數(shù)據(jù)沒(méi)有發(fā)生變化,也需要回調(diào)兩次導(dǎo)致界面無(wú)用的重復(fù)刷新)
注:無(wú)論對(duì)于哪種緩存模式,都可以指定一個(gè)cacheKey,建議針對(duì)不同需要緩存的頁(yè)面設(shè)置不同的cacheKey,如果相同,會(huì)導(dǎo)致數(shù)據(jù)覆蓋。
緩存設(shè)置緩存設(shè)置有兩種方式
方式一:全局設(shè)置,所有請(qǐng)求都會(huì)默認(rèn)使用此模式
EasyHttp.getInstance() ... .setCacheMode(CacheMode.CACHEANDREMOTE)//不設(shè)置默認(rèn)是NO_CACHE模式 ...
方式二:?jiǎn)蝹€(gè)請(qǐng)求設(shè)置緩存模式
EasyHttp.get(URL) ... .cacheMode(CacheMode.FIRSTREMOTE) ...設(shè)置轉(zhuǎn)換器
方式一:全局設(shè)置,所有請(qǐng)求都會(huì)默認(rèn)使用此存儲(chǔ)轉(zhuǎn)換器
EasyHttp.getInstance().setCacheDiskConverter(new SerializableDiskConverter())//默認(rèn)緩存使用序列化轉(zhuǎn)化
方式二:?jiǎn)蝹€(gè)請(qǐng)求設(shè)置存儲(chǔ)轉(zhuǎn)換器
EasyHttp.get(URL).cacheDiskConverter(new GsonDiskConverter());
注:一個(gè)請(qǐng)求就選用一種轉(zhuǎn)換器,切記不要使用SerializableDiskConverter來(lái)緩存,又用GsonDiskConverter來(lái)讀會(huì)報(bào)錯(cuò)
自定義轉(zhuǎn)換器如果你想擁有自己的轉(zhuǎn)換器請(qǐng)實(shí)現(xiàn)IDiskConverter接口。
示例:
public class CustomDiskConverter implements IDiskConverter { @Override public緩存回調(diào)T load(InputStream source, Type type) { //實(shí)現(xiàn)讀功能 return null; } @Override public boolean writer(OutputStream sink, Object data) { //實(shí)現(xiàn)寫(xiě)功能 return false; } }
對(duì)具有緩存的回調(diào)CallBack,如果你想知道當(dāng)前的緩存是來(lái)自本地還是網(wǎng)絡(luò),只需要回調(diào)中加入CacheResult,其它和普通的網(wǎng)絡(luò)請(qǐng)求方式一模一樣。CacheResult中的isFromCache可以知道是否來(lái)自緩存,true:來(lái)自緩存,false:來(lái)自網(wǎng)絡(luò)。請(qǐng)使用new SimpleCallBack
帶有CacheResult回調(diào)示例:
EasyHttp.get(url) .readTimeOut(30 * 1000)//測(cè)試局部讀超時(shí)30s .cacheMode(cacheMode) .cacheKey(this.getClass().getSimpleName())//緩存key .retryCount(5)//重試次數(shù) .cacheTime(5 * 60)//緩存時(shí)間300s,默認(rèn)-1永久緩存 okhttp和自定義緩存都起作用 //.okCache(new Cache());//okhttp緩存,模式為默認(rèn)模式(CacheMode.DEFAULT)才生效 //.cacheDiskConverter(new GsonDiskConverter())//默認(rèn)使用的是 new SerializableDiskConverter(); .cacheDiskConverter(new SerializableDiskConverter())//默認(rèn)使用的是 new SerializableDiskConverter(); .timeStamp(true) .execute(new SimpleCallBack移除緩存>() { @Override public void onError(ApiException e) { //請(qǐng)求失敗 } @Override public void onSuccess(CacheResult cacheResult) { HttpLog.i(cacheResult.toString()); String from = ""; if (cacheResult.isFromCache) { from = "我來(lái)自緩存"; } else { from = "我來(lái)自遠(yuǎn)程網(wǎng)絡(luò)"; } .... } });
支持根據(jù)緩存key移除緩存,主要是針對(duì)RxCache才能起作用
EasyHttp.removeCache("cachekey");清空緩存
EasyHttp.clearCache();RxCache
RxCache是自己封裝的一個(gè)本地緩存功能庫(kù),采用Rxjava+DiskLruCache來(lái)實(shí)現(xiàn),線程安全內(nèi)部采用ReadWriteLock機(jī)制防止頻繁讀寫(xiě)緩存造成的異常,可以獨(dú)立使用,多帶帶用RxCache來(lái)存儲(chǔ)數(shù)據(jù)。采用transformer與網(wǎng)絡(luò)請(qǐng)求結(jié)合,可以實(shí)現(xiàn)網(wǎng)絡(luò)緩存功能,本地硬緩存,具有緩存讀寫(xiě)功能(異步)、緩存是否存在、根據(jù)key刪除緩存、清空緩存(異步)、緩存Key會(huì)自動(dòng)進(jìn)行MD5加密、可以設(shè)置緩存磁盤大小、緩存key、緩存時(shí)間、緩存存儲(chǔ)的轉(zhuǎn)換器、緩存目錄、緩存Version等功能本庫(kù)不作為重點(diǎn)介紹。后期會(huì)將此代碼獨(dú)立開(kāi)源一個(gè)庫(kù),作為一分鐘讓你自己的網(wǎng)絡(luò)庫(kù)也具有緩存功能,敬請(qǐng)期待!!!
動(dòng)態(tài)參數(shù)動(dòng)態(tài)參數(shù)就是像我們的token、時(shí)間戳timeStamp、簽名sign等,這些參數(shù)不能是全局參數(shù)因?yàn)槭亲兓模O(shè)置成局部參數(shù)又太麻煩,每次都要獲取。token是有有效時(shí)間的或者異地登錄等都會(huì)變化重新獲取,時(shí)間戳一般是根據(jù)系統(tǒng)的時(shí)間,sign是根據(jù)請(qǐng)求的url和參數(shù)進(jìn)行加密簽名一般都有自己的簽名規(guī)則。有的接口需要這些參數(shù)有的接口不需要,本庫(kù)很好的解決這個(gè)問(wèn)題。
1.在請(qǐng)求的時(shí)候可以設(shè)置下面三個(gè)參數(shù).accessToken(true)//本次請(qǐng)求是否追加token .timeStamp(false)//本次請(qǐng)求是否攜帶時(shí)間戳 .sign(false)//本次請(qǐng)求是否需要簽名2.需要繼承庫(kù)中提供的動(dòng)態(tài)攔截器BaseDynamicInterceptor
繼承BaseDynamicInterceptor后就可以獲取到參數(shù)的設(shè)置值,請(qǐng)?jiān)敿?xì)看CustomSignInterceptor的注釋講解,也可以查看Demo示例
示例:
/** *3.設(shè)置自定義的動(dòng)態(tài)攔截器描述:對(duì)參數(shù)進(jìn)行簽名、添加token、時(shí)間戳處理的攔截器
* 主要功能說(shuō)明:
* 因?yàn)閰?shù)簽名沒(méi)辦法統(tǒng)一,簽名的規(guī)則不一樣,簽名加密的方式也不同有MD5、BASE64等等,只提供自己能夠擴(kuò)展的能力。
* 作者: zhouyou
* 日期: 2017/5/4 15:21
* 版本: v1.0
*/ public class CustomSignInterceptor extends BaseDynamicInterceptor{ @Override public TreeMap dynamic(TreeMap dynamicMap) { //dynamicMap:是原有的全局參數(shù)+局部參數(shù) //你不必關(guān)心當(dāng)前是get/post/上傳文件/混合上傳等,庫(kù)中會(huì)自動(dòng)幫你處理。 //根據(jù)需要自己處理,如果你只用到token則不必處理isTimeStamp()、isSign() if (isTimeStamp()) {//是否添加時(shí)間戳,因?yàn)槟愕淖侄蝛ey可能不是timestamp,這種動(dòng)態(tài)的自己處理 dynamicMap.put(ComParamContact.Common.TIMESTAMP, String.valueOf(System.currentTimeMillis())); } if (isSign()) {是否簽名 //1.因?yàn)槟愕淖侄蝛ey可能不是sign,這種需要?jiǎng)討B(tài)的自己處理 //2.因?yàn)槟愕暮灻囊?guī)則不一樣,簽名加密方式也不一樣,只提供自己能夠擴(kuò)展的能力 dynamicMap.put(ComParamContact.Common.SIGN, sign(dynamicMap)); } if (isAccessToken()) {//是否添加token String acccess = TokenManager.getInstance().getAuthModel().getAccessToken(); dynamicMap.put(ComParamContact.Common.ACCESSTOKEN, acccess); } //Logc.i("dynamicMap:" + dynamicMap.toString()); return dynamicMap;//dynamicMap:是原有的全局參數(shù)+局部參數(shù)+新增的動(dòng)態(tài)參數(shù) } //示例->簽名規(guī)則:POST+url+參數(shù)的拼裝+secret private String sign(TreeMap dynamicMap) { String url = getHttpUrl().url().toString(); url = url.replaceAll("%2F", "/"); StringBuilder sb = new StringBuilder("POST"); sb.append(url); for (Map.Entry entry : dynamicMap.entrySet()) { sb.append(entry.getKey()).append("=").append(entry.getValue()).append("&"); } sb.append(AppConstant.APP_SECRET); HttpLog.i(sb.toString()); return MD5.encode(sb.toString()); } }
最好通過(guò)全局的方式設(shè)置,因?yàn)橐话愫芏嘟涌诙紩?huì)使用到
EasyHttp.getInstance() ... .addInterceptor(new CustomSignInterceptor())//添加動(dòng)態(tài)參數(shù)(簽名、token、時(shí)間戳)攔截器 ...自定義ApiResult
本庫(kù)中默認(rèn)提供的是標(biāo)準(zhǔn)ApiResult.內(nèi)部是靠ApiResult進(jìn)行解析的,如果你的數(shù)據(jù)結(jié)構(gòu)跟ApiResult不同,你可以在你的項(xiàng)目中繼承ApiResult,然后重寫(xiě)getCode()、getData()、getMsg()和isOk()等方法來(lái)實(shí)現(xiàn)自己的需求。
本庫(kù)中ApiResult如下:
public class ApiResult{ private int code; private String msg; private T data; public int getCode() { return code; } public void setCode(int code) { this.code = code; } public String getMsg() { return msg; } public void setMsg(String msg) { this.msg = msg; } public T getData() { return data; } public void setData(T data) { this.data = data; } public boolean isOk() {//請(qǐng)求成功的判斷方法 return code == 0 ? true : false; } }
json格式類似:
{ "code": 100010101, "data": 內(nèi)容, "msg": "請(qǐng)求成功" }
假如你的數(shù)據(jù)結(jié)構(gòu)是這樣的:
{ "error_code": 0, "result": 內(nèi)容, "reason": "請(qǐng)求成功" }
那么你的basebean可以寫(xiě)成這樣
public class CustomApiResultextends ApiResult { String reason; int error_code; //int resultcode; T result; @Override public int getCode() { return error_code; } @Override public void setCode(int code) { error_code = code; } @Override public String getMsg() { return reason; } @Override public void setMsg(String msg) { reason = msg; } @Override public T getData() { return result; } @Override public void setData(T data) { result = data; } /* @Override public boolean isOk() { return error_code==200;//如果不是0表示成功,請(qǐng)重寫(xiě)isOk()方法。 }*/ }
那么你的網(wǎng)絡(luò)請(qǐng)求可以這樣寫(xiě)
EasyHttp.get(url) .readTimeOut(30 * 1000)//局部定義讀超時(shí) .writeTimeOut(30 * 1000) .connectTimeout(30 * 1000) //.cacheKey(this.getClass().getSimpleName()+"11") //.cacheMode(CacheMode.CACHEANDREMOTE) //.cacheMode(CacheMode.ONLYREMOTE) //.headers("","")//設(shè)置頭參數(shù) //.params("name","張三")//設(shè)置參數(shù) //.addInterceptor() //.addConverterFactory() //.addCookie() //.timeStamp(true) .baseUrl("http://apis.juhe.cn") .params("phone", "手機(jī)號(hào)") .params("dtype", "json") .params("key", "5682c1f44a7f486e40f9720d6c97ffe4") .execute(new CallBackProxy, ResultBean>(new SimpleCallBack () { @Override public void onError(ApiException e) { //請(qǐng)求錯(cuò)誤 } @Override public void onSuccess(ResultBean response) { //請(qǐng)求成功 } }) { });
這種寫(xiě)法會(huì)覺(jué)得有點(diǎn)長(zhǎng),CallBackProxy的泛型參數(shù)每次都需要填寫(xiě),其中CustomApiResult是繼承ApiResult的,CustomApiResult相當(dāng)于項(xiàng)目的basebean,對(duì)于一個(gè)實(shí)際項(xiàng)目來(lái)講,basebean是固定的,所以我們可以繼續(xù)封裝這個(gè)方法,根據(jù)需要一般只需要封裝get和post請(qǐng)求就可以了。
public staticDisposable customExecute(CallBack callBack) { return execute(new CallBackProxy , T>(callBack) { }); }
通過(guò)以上改造,再次調(diào)用時(shí)直接使用CallBack,不用再關(guān)注CallBackProxy,是不是明顯簡(jiǎn)單很多了,具體請(qǐng)看代碼Demo!!!
Observable調(diào)試模式observable = EasyHttp.get("/mobile/get") .readTimeOut(30 * 1000)//局部定義讀超時(shí) .writeTimeOut(30 * 1000) .baseUrl("http://apis.juhe.cn") .params("phone", "18688994275") .params("dtype", "json") .params("key", "5682c1f44a7f486e40f9720d6c97ffe4") .execute(new CallClazzProxy , ResultBean>(ResultBean.class) { }); observable.subscribe(new ProgressSubscriber (this, mProgressDialog) { @Override public void onError(ApiException e) { super.onError(e); showToast(e.getMessage()); } @Override public void onNext(ResultBean result) { showToast(result.toString()); } });
一個(gè)好的庫(kù),一定有比較人性化的調(diào)試模式,為了方便開(kāi)發(fā)者查看請(qǐng)求過(guò)程和請(qǐng)求日志,本庫(kù)提供詳細(xì)的日志打印,最好在開(kāi)發(fā)階段,請(qǐng)打開(kāi)調(diào)試模式輸出優(yōu)雅的Log.
調(diào)試模式的控制在初始化配置時(shí)就可以直接設(shè)置。
public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); ... EasyHttp.getInstance() ... // 打開(kāi)該調(diào)試開(kāi)關(guān)并設(shè)置TAG,不需要就不要加入該行 // 最后的true表示是否打印okgo的內(nèi)部異常,一般打開(kāi)方便調(diào)試錯(cuò)誤 .debug("EasyHttp", true); } }Log預(yù)覽說(shuō)明
這里一個(gè)成功請(qǐng)求的例子:
上方的Log打印了一個(gè)Request完整的聲明周期,一個(gè)請(qǐng)求的Log有以下特點(diǎn):
1.開(kāi)頭和結(jié)尾打了-->http is start和 -->http is Complete分割請(qǐng)求,完整的生命周期的內(nèi)容都會(huì)打印在開(kāi)頭和結(jié)尾的里面。
2.request請(qǐng)求和response響應(yīng)分割,分別是
-------------------------------request--------------------------------------------------------------response-------------------------------
3.在---request---之后會(huì)打印請(qǐng)求的url、當(dāng)前請(qǐng)求的類型GET/POST... -->GET/POST開(kāi)頭 -->END GET/POST結(jié)尾。如果是GET、HEAD請(qǐng)求方式添加的參數(shù)將會(huì)在這里完整的以u(píng)rl?key=value&key=value的形式打印。
4.在----response----之后會(huì)打印(在服務(wù)器響應(yīng)后被打印),包含響應(yīng)碼、響應(yīng)狀態(tài)、響應(yīng)頭、cookie,body等以<--200(響應(yīng)碼)開(kāi)頭,<--END HTTP結(jié)尾
5.loadCache key=如果設(shè)置了緩存,會(huì)看到緩存的key,開(kāi)啟了網(wǎng)絡(luò)緩存功能才會(huì)輸出。
6.loadCache result=從緩存里讀取的結(jié)果,開(kāi)啟了網(wǎng)絡(luò)緩存功能才會(huì)輸出。
7.save status => true保存緩存的狀態(tài)
-dontwarn okio.** -dontwarn javax.annotation.Nullable -dontwarn javax.annotation.ParametersAreNonnullByDefault -dontwarn javax.annotation.** -keep com.zhouyou.http.model -keep com.zhouyou.http.cache.model歡迎加入我的圈子
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://specialneedsforspecialkids.com/yun/70156.html
摘要:本文主要是講與怎么結(jié)合的,也不會(huì)的操作符深入講解,不然就脫離了本文的重心廢話不多說(shuō)了,一起來(lái)看看是如何使用的。延遲請(qǐng)求利用的操作符。 前言 之前在github開(kāi)源過(guò)一個(gè)網(wǎng)絡(luò)庫(kù)RxEasyHttp,這是一款基于RxJava2+Retrofit2實(shí)現(xiàn)簡(jiǎn)單易用的網(wǎng)絡(luò)請(qǐng)求框架。在這里對(duì)網(wǎng)絡(luò)庫(kù)的用法就不做過(guò)多介紹,感興趣的可以去了解下。在使用過(guò)程中一些網(wǎng)友反饋不知道怎么結(jié)合Rxjava2來(lái)實(shí)現(xiàn)一...
摘要:本文主要是講與怎么結(jié)合的,也不會(huì)的操作符深入講解,不然就脫離了本文的重心廢話不多說(shuō)了,一起來(lái)看看是如何使用的。延遲請(qǐng)求利用的操作符。 前言 之前在github開(kāi)源過(guò)一個(gè)網(wǎng)絡(luò)庫(kù)RxEasyHttp,這是一款基于RxJava2+Retrofit2實(shí)現(xiàn)簡(jiǎn)單易用的網(wǎng)絡(luò)請(qǐng)求框架。在這里對(duì)網(wǎng)絡(luò)庫(kù)的用法就不做過(guò)多介紹,感興趣的可以去了解下。在使用過(guò)程中一些網(wǎng)友反饋不知道怎么結(jié)合Rxjava2來(lái)實(shí)現(xiàn)一...
摘要:網(wǎng)絡(luò)組件基于的網(wǎng)絡(luò)框架可以忽略的內(nèi)容訪問(wèn)的是自己編寫(xiě)的程序,地址使用方式初始化創(chuàng)建方式響應(yīng)數(shù)據(jù)類型不需要繼承父類地址響應(yīng)數(shù)據(jù)類型請(qǐng)求參數(shù)方式響應(yīng)數(shù)據(jù)類型需要繼承地址響應(yīng)數(shù)據(jù)類型請(qǐng)求參數(shù)方式響應(yīng)數(shù)據(jù)類型不需要繼承地址響應(yīng)數(shù)據(jù)類型請(qǐng)求參數(shù)發(fā)起請(qǐng) NetworkComponent 網(wǎng)絡(luò)組件 基于Retrofit2+RxJava2+GSON/Fastjson的網(wǎng)絡(luò)框架 可以忽略的內(nèi)容 Hell...
閱讀 1035·2021-11-22 13:53
閱讀 1590·2021-11-17 09:33
閱讀 2390·2021-10-14 09:43
閱讀 2850·2021-09-01 11:41
閱讀 2271·2021-09-01 10:44
閱讀 2911·2021-08-31 09:39
閱讀 1448·2019-08-30 15:44
閱讀 1860·2019-08-30 13:02