本庫是一款基於RxJava2+Retrofit2實現簡單易用的網絡請求框架,結合android平臺特性的網絡封裝庫,採用api鏈式調用一點到底,集成cookie管理,多種緩存模式,極簡https配置,上傳下載進度顯示,請求錯誤自動重試,請求攜帶token、時間戳、簽名sign動態配置,自動登陸成功後請求重發功能,3種層次的參數設置默認全局局部,默認標準ApiResult同時能夠支持自定義的數據結構,已經能知足如今的大部分網絡請求。
注:Retrofit和Rxjava是當下很是火爆的開源框架,均來自神通常的Square公司。本庫就不介紹Retrofit和Rxjava2的用法。java
網上好的開源網絡庫像Volley、async-http、okhttp、retrofit等都很是強大,可是實際應用中咱們不會直接去使用,通常都會根據本身的業務再封裝一層,這樣更方便快捷,又能統一處理業務共性的東西例如:統一的數據結構(code、msg、data)、token處理、網絡異常等狀況。在使用retrofit來請求網絡的時候,項目的需求愈來愈多,api也隨之愈來愈多,一個普通的應用api通常也在100+左右。若是把這些api放在一個ApiService內會很臃腫,不利於查看api.若是採用模塊的方式對api進行分類,每一個模塊對應若干個api.以retrofit的使用方式又須要建立若干個ApiService,這種方式維護方便,可是模塊增多了,類也增多了不少。對於懶人來講就想經過一個URL就能回調你所須要的數據,什麼ApiService都不想理會,同時又能夠很快的與本身的業務相關聯,就相似於代替你在開源網絡庫基礎上再封裝一層的做用,因而本庫就應運而生。android
郵箱地址: 478319399@qq.com
QQ羣: 581235049(建議使用QQ羣,郵箱使用較少,可能看的不及時)
本羣旨在爲使用個人github項目的人提供方便,若是遇到問題歡迎在羣裏提問。一我的的能力也有限,但願一塊兒學習一塊兒進步。
關注個人github,瞭解個人最新項目。關注個人博客,閱讀個人最新文章。git
V2.0.5github
點擊查看更新日誌json
目前只支持主流開發工具AndtoidStudio的使用,沒有提供Eclipse使用方式.
本項目Demo的網絡請求的服務器地址爲了安全,把url去掉了,可是Demo程序中的示例都是ok的api
dependencies { compile 'com.zhouyou:rxeasyhttp:2.0.5' }
想查看全部版本,請點擊下面地址。緩存
Latest release: https://jcenter.bintray.com/com/zhouyou/rxeasyhttp/安全
若是使用本庫實現文件下載到SD卡、或者配置了緩存數據到SD卡,你必需要考慮到Android6.0及以上系統的運行時權限,給你們推薦兩個權限庫:服務器
AndPermission
RxPermissions cookie
由於要請求網絡、從SD卡讀寫緩存、下載文件到SD卡等等,因此須要在manifest.xml中配置如下幾個權限,若是你已經配置過了這些權限,請不要重複配置:
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> <uses-permission android:name="android.permission.INTERNET"/>
通常在 Aplication,或者基類中,只須要調用一次便可,能夠配置調試開關,全局的超時時間,公共的請求頭和請求參數等信息
初始化須要一個Context,最好在Application#onCreate()中初始化,記得在manifest.xml中註冊Application。
public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); } }
... <application android:name=".MyApplication" ... />
若是使用默認始化後,一切採用默認設置。若是你須要配置全局超時時間、緩存、Cookie、底層爲OkHttp的話,請看高級初始化。
public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); EasyHttp.init(this);//默認初始化 } }
能夠進行超時配置、網絡緩存配置、okhttp相關參數配置、retrofit相關參數配置、cookie配置等,這些參數能夠選擇性的根據業務須要配置。
public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); EasyHttp.init(this);//默認初始化,必須調用 //全局設置請求頭 HttpHeaders headers = new HttpHeaders(); headers.put("User-Agent", SystemInfoUtils.getUserAgent(this, AppConstant.APPID)); //全局設置請求參數 HttpParams params = new HttpParams(); params.put("appId", AppConstant.APPID); //如下設置的全部參數是全局參數,一樣的參數能夠在請求的時候再設置一遍,那麼對於該請求來說,請求中的參數會覆蓋全局參數 EasyHttp.getInstance() //能夠全局統一設置全局URL .setBaseUrl(Url)//設置全局URL // 打開該調試開關並設置TAG,不須要就不要加入該行 // 最後的true表示是否打印okgo的內部異常,通常打開方便調試錯誤 .debug("EasyHttp", true) //若是使用默認的60秒,如下三行也不須要設置 .setReadTimeOut(60 * 1000) .setWriteTimeOut(60 * 100) .setConnectTimeout(60 * 100) //能夠全局統一設置超時重連次數,默認爲3次,那麼最差的狀況會請求4次(一次原始請求,三次重連請求), //不須要能夠設置爲0 .setRetryCount(3)//網絡很差自動重試3次 //能夠全局統一設置超時重試間隔時間,默認爲500ms,不須要能夠設置爲0 .setRetryDelay(500)//每次延時500ms重試 //能夠全局統一設置超時重試間隔疊加時間,默認爲0ms不疊加 .setRetryIncreaseDelay(500)//每次延時疊加500ms //能夠全局統一設置緩存模式,默認是不使用緩存,能夠不傳,具體請看CacheMode .setCacheMode(CacheMode.NO_CACHE) //能夠全局統一設置緩存時間,默認永不過時 .setCacheTime(-1)//-1表示永久緩存,單位:秒 ,Okhttp和自定義RxCache緩存都起做用 //全局設置自定義緩存保存轉換器,主要針對自定義RxCache緩存 .setCacheDiskConverter(new SerializableDiskConverter())//默認緩存使用序列化轉化 //全局設置自定義緩存大小,默認50M .setCacheMaxSize(100 * 1024 * 1024)//設置緩存大小爲100M //設置緩存版本,若是緩存有變化,修改版本後,緩存就不會被加載。特別是用於版本重大升級時緩存不能使用的狀況 .setCacheVersion(1)//緩存版本爲1 //.setHttpCache(new Cache())//設置Okhttp緩存,在緩存模式爲DEFAULT才起做用 //能夠設置https的證書,如下幾種方案根據須要本身設置 .setCertificates() //方法一:信任全部證書,不安全有風險 //.setCertificates(new SafeTrustManager()) //方法二:自定義信任規則,校驗服務端證書 //配置https的域名匹配規則,不須要就不要加入,使用不當會致使https握手失敗 //.setHostnameVerifier(new SafeHostnameVerifier()) //.addConverterFactory(GsonConverterFactory.create(gson))//本框架沒有采用Retrofit的Gson轉化,因此不用配置 .addCommonHeaders(headers)//設置全局公共頭 .addCommonParams(params)//設置全局公共參數 //.addNetworkInterceptor(new NoCacheInterceptor())//設置網絡攔截器 //.setCallFactory()//局設置Retrofit對象Factory //.setCookieStore()//設置cookie //.setOkproxy()//設置全局代理 //.setOkconnectionPool()//設置請求鏈接池 //.setCallbackExecutor()//全局設置Retrofit callbackExecutor //能夠添加全局攔截器,不須要就不要加入,錯誤寫法直接致使任何回調不執行 //.addInterceptor(new GzipRequestInterceptor())//開啓post數據進行gzip後發送給服務器 .addInterceptor(new CustomSignInterceptor());//添加參數簽名攔截器 } }
網絡請求,採用鏈式調用,支持一點到底。
/** * 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.包含一次普通請求全部能配置的參數,真實使用時不須要配置這麼多,按本身的須要選擇性的使用便可<br/>
2.如下配置所有是單次請求配置,不會影響全局配置,沒有配置的仍然是使用全局參數。<br/>
3.爲單個請求設置超時,好比涉及到文件的須要設置讀寫等待時間多一點。<br/>
完整參數GET示例:
EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult") .baseUrl("http://www.xxxx.com")//設置url .writeTimeOut(30*1000)//局部寫超時30s,單位毫秒 .readTimeOut(30*1000)//局部讀超時30s,單位毫秒 .connectTimeout(30*1000)//局部鏈接超時30s,單位毫秒 .headers(new HttpHeaders("header1","header1Value"))//添加請求頭參數 .headers("header2","header2Value")//支持添加多個請求頭同時添加 .headers("header3","header3Value")//支持添加多個請求頭同時添加 .params("param1","param1Value")//支持添加多個參數同時添加 .params("param2","param2Value")//支持添加多個參數同時添加 //.addCookie(new CookieManger(this).addCookies())//支持添加Cookie .cacheTime(300)//緩存300s 單位s .cacheKey("cachekey")//緩存key .cacheMode(CacheMode.CACHEANDREMOTE)//設置請求緩存模式 //.okCache()//使用模式緩存模式時,走Okhttp緩存 .cacheDiskConverter(new GsonDiskConverter())//GSON-數據轉換器 //.certificates()添加證書 .retryCount(5)//本次請求重試次數 .retryDelay(500)//本次請求重試延遲時間500ms .addInterceptor(Interceptor)//添加攔截器 .okproxy()//設置代理 .removeHeader("header2")//移除頭部header2 .removeAllHeaders()//移除所有請求頭 .removeParam("param1") .accessToken(true)//本次請求是否追加token .timeStamp(false)//本次請求是否攜帶時間戳 .sign(false)//本次請求是否須要簽名 .syncRequest(true)//是不是同步請求,默認異步請求。true:同步請求 .execute(new CallBack<SkinTestResult>() { @Override public void onStart() { //開始請求 } @Override public void onCompleted() { //請求完成 } @Override public void onError(ApiException e) { //請求錯誤 } @Override public void onSuccess(SkinTestResult response) { //請求成功 } });
Url能夠經過初始化配置的時候傳入EasyHttp.getInstance().setBaseUrl("http://www.xxx.com");
入口方法傳入: EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult").baseUrl("http://www.xxxx.com")
若是入口方法中傳入的url含有http或者https,則不會拼接初始化設置的baseUrl.
例如:EasyHttp.get("http://www.xxx.com/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
則setBaseUrl()和baseUrl()傳入的baseurl都不會被拼接。
兩種設置方式
.params(HttpParams params)
.params("param1","param1Value")//添加參數鍵值對
HttpParams params = new HttpParams();
params.put("appId", AppConstant.APPID);
.addCommonParams(params)//設置全局公共參數
.headers(HttpHeaders headers)
.headers("header2","header2Value")//添加參數鍵值對
.addCommonHeaders(headers)//設置全局公共頭
支持get/post/delete/put等
鏈式調用的終點請求的執行方式有:execute(Class<T> clazz) 、execute(Type type)、execute(CallBack<T> callBack)三種方式,都是針對標準的ApiResult
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<SkinTestResult>() { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onSuccess(SkinTestResult response) { if (response != null) showToast(response.toString()); } });
2.手動建立請求對象
//GetRequest 、PostRequest、DeleteRequest、PutRequest GetRequest request = new GetRequest("/v1/app/chairdressing/skinAnalyzePower/skinTestResult"); request.readTimeOut(30 * 1000)//局部定義讀超時 .params("param1", "param1Value1") .execute(new SimpleCallBack<SkinTestResult>() { @Override public void onError(ApiException e) { } @Override public void onSuccess(SkinTestResult response) { } });
execute(Class<T> clazz)和execute(Type type)功能基本同樣,execute(Type type)主要是針對集合不能直接傳遞Class
EasyHttp.get(url) .params("param1", "paramValue1") .execute(SkinTestResult.class)//很是簡單直接傳目標class //.execute(new TypeToken<List<SectionItem>>() {}.getType())//Type類型 .subscribe(new BaseSubscriber<SkinTestResult>() { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onNext(SkinTestResult skinTestResult) { showToast(skinTestResult.toString()); } });
網絡請求會返回Disposable對象,方便取消網絡請求
Disposable disposable = EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult") .params("param1", "paramValue1") .execute(new SimpleCallBack<SkinTestResult>() { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onSuccess(SkinTestResult response) { showToast(response.toString()); } }); //在須要取消網絡請求的地方調用,通常在onDestroy()中 //EasyHttp.cancelSubscription(disposable);
帶有進度框的請求,能夠設置對話框消失是否自動取消網絡和自定義對話框功能,具體參數做用請看請求回調講解
ProgressDialogCallBack帶有進度框的請求,能夠設置對話框消失是否自動取消網絡和自定義對話框功能,具體參數做用請看自定義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<SkinTestResult>(mProgressDialog, true, true) { @Override public void onError(ApiException e) { super.onError(e);//super.onError(e)必須寫不能刪掉或者忘記了 //請求成功 } @Override public void onSuccess(SkinTestResult response) { //請求失敗 } });
注:錯誤回調 super.onError(e);必須寫
IProgressDialog 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<SkinTestResult>(this, mProgressDialog) { @Override public void onError(ApiException e) { super.onError(e); showToast(e.getMessage()); } @Override public void onNext(SkinTestResult skinTestResult) { showToast(skinTestResult.toString()); } });
經過網絡請求能夠返回Observable,這樣就能夠很好的經過Rxjava與其它場景業務結合處理,甚至能夠經過Rxjava的connect()操做符處理多個網絡請求。例如:在一個頁面有多個網絡請求,如何在多個請求都訪問成功後再顯示頁面呢?這也是Rxjava強大之處。
注:目前經過execute(Class<T> clazz)方式只支持標註的ApiResult結構,不支持自定義的ApiResult
示例:
Observable<SkinTestResult> observable = EasyHttp.get(url) .params("param1", "paramValue1") .execute(SkinTestResult.class); observable.subscribe(new BaseSubscriber<SkinTestResult>() { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onNext(SkinTestResult skinTestResult) { showToast(skinTestResult.toString()); } });
本庫提供的文件下載很是簡單,沒有提供複雜的下載方式例如:下載管理器、斷點續傳、多線程下載等,由於不想把本庫作重。若是複雜的下載方式,還請考慮其它下載方案。
文件目錄若是不指定,默認下載的目錄爲/storage/emulated/0/Android/data/包名/files
文件名若是不指定,則按照如下規則命名:
1.首先檢查用戶是否傳入了文件名,若是傳入,將以用戶傳入的文件名命名
2.若是沒有傳入文件名,默認名字是時間戳生成的。
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")//不設置默認名字是時間戳生成的 .execute(new DownloadProgressCallBack<String>() { @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) { //下載失敗 } });
通常此種用法用於與服務器約定的數據格式,當使用該方法時,params中的參數設置是無效的,全部參數均須要經過須要上傳的文本中指定,此外,額外指定的header參數仍然保持有效。
.upString("這是要上傳的長文本數據!")//默認類型是:MediaType.parse("text/plain")
upString("這是要上傳的長文本數據!", "application/xml") // 好比上傳xml數據,這裏就能夠本身指定請求頭
.upJson(jsonObject.toString())//上傳json
.upBytes(new byte[]{})//上傳byte[]
.requestBody(body)//上傳自定義RequestBody
.upObject(object)//上傳對象object
必需要增長.addConverterFactory(GsonConverterFactory.create())
設置注:upString、upJson、requestBody、upBytes、upObject五個方法不能同時使用,當前只能選用一個
示例:
HashMap<String, String> params = new HashMap<>(); params.put("key1", "value1"); params.put("key2", "這裏是須要提交的json格式數據"); params.put("key3", "也可使用三方工具將對象轉成json字符串"); JSONObject jsonObject = new JSONObject(params); RequestBody body=RequestBody.create(MediaType.parse("xxx/xx"),"內容"); EasyHttp.post("v1/app/chairdressing/news/favorite") //.params("param1", "paramValue1")//不能使用params,upString 與 params 是互斥的,只有 upString 的數據會被上傳 .upString("這裏是要上傳的文本!")//默認類型是:MediaType.parse("text/plain") //.upString("這是要上傳的長文本數據!", "application/xml") // 好比上傳xml數據,這裏就能夠本身指定請求頭 //.upJson(jsonObject.toString()) //.requestBody(body) //.upBytes(new byte[]{}) //.upObject(object) .execute(new SimpleCallBack<String>() { @Override public void onError(ApiException e) { showToast(e.getMessage()); } @Override public void onSuccess(String response) { showToast(response); } });
支持單文件上傳、多文件上傳、混合上傳,同時支持進度回調,
暫不實現多線程上傳/分片上傳/斷點續傳等高級功能
上傳文件支持文件與參數一塊兒同時上傳,也支持一個key上傳多個文件,如下方式能夠任選
上傳文件支持兩種進度回調:ProgressResponseCallBack(線程中回調)和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") //支持上傳新增的參數 //.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<File> files, ProgressResponseCallBack responseCallBack) //.addFileWrapperParams(String key, List<HttpParams.FileWrapper> 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,會自動解析到是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,會自動解析到是image/* .params("avatar", bytes, "streamfile.png", listener) .params("file1", new File("filepath1")) // 能夠添加文件上傳 .params("file2", new File("filepath2")) // 支持多文件同時添加上傳 .addFileParams("key", List<File> files) // 這裏支持一個key傳多個文件 .params("param1", "paramValue1") // 這裏能夠上傳參數 .accessToken(true) .timeStamp(true) .execute(new ProgressDialogCallBack<String>(mProgressDialog, true, true) { @Override public void onError(ApiException e) { super.onError(e); showToast(e.getMessage()); } @Override public void onSuccess(String response) { showToast(response); } });
每一個請求前都會返回一個Disposable,取消訂閱就能夠取消網絡請求,若是是帶有進度框的網絡請求,則不須要手動取消網絡請求,會自動取消。
Disposable mSubscription = EasyHttp.get(url).execute(callback); ... @Override protected void onDestroy() { super.onDestroy(); EasyHttp.cancelSubscription(mSubscription); }
自動取消使用ProgressDialogCallBack回調或者使用ProgressSubscriber,就不用再手動調用cancelSubscription();
ProgressDialogCallBack:
EasyHttp.get(url).execute(new ProgressDialogCallBack());
ProgressSubscriber
EasyHttp.get(url).execute(SkinTestResult.class).subscribe(new ProgressSubscriber<SkinTestResult>(this, mProgressDialog) { @Override public void onError(ApiException e) { super.onError(e); showToast(e.getMessage()); } @Override public void onNext(SkinTestResult skinTestResult) { showToast(skinTestResult.toString()); } })
同步請求只須要設置syncRequest()方法
EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult") ... .syncRequest(true)//設置同步請求 .execute(new CallBack<SkinTestResult>() {});
//支持回調的類型能夠是Bean、String、CacheResult<Bean>、CacheResult<String>、List<Bean> new SimpleCallBack<CacheResult<Bean>>()//支持緩存的回調,請看緩存講解 new SimpleCallBack<CacheResult<String>>()//支持緩存的回調,請看緩存講解 new SimpleCallBack<Bean>()//返回Bean new SimpleCallBack<String>()//返回字符串 new SimpleCallBack<List<Bean>()//返回集合
注:其它回調同理
cookie的內容主要包括:名字,值,過時時間,路徑和域。路徑與域一塊兒構成cookie的做用範圍,關於cookie的做用這裏就再也不科普,本身能夠去了解
cookie設置:
EasyHttp.getInstance() ... //若是不想讓本庫管理cookie,如下不須要 .setCookieStore(new CookieManger(this)) //cookie持久化存儲,若是cookie不過時,則一直有效 ...
HttpUrl httpUrl = HttpUrl.parse("http://www.xxx.com/test"); CookieManger cookieManger = getCookieJar(); List<Cookie> cookies = cookieManger.loadForRequest(httpUrl);
PersistentCookieStore cookieStore= getCookieJar().getCookieStore(); List<Cookie> cookies1= cookieStore.getCookies();
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集合
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);
CookieManger cookieManger = EasyHttp.getCookieJar(); cookieManger.removeAll();
提供了用戶自定義ApiService的接口,您只需調用call方法便可.
示例:
public interface LoginService { @POST("{path}") @FormUrlEncoded Observable<ApiResult<AuthModel>> login(@Path("path") String path, @FieldMap Map<String, String> map); } final CustomRequest request = EasyHttp.custom() .addConverterFactory(GsonConverterFactory.create(new Gson()))//自定義的能夠設置GsonConverterFactory .params("param1", "paramValue1") .build(); LoginService mLoginService = request.create(LoginService.class); LoginService mLoginService = request.create(LoginService.class); Observable<ApiResult<AuthModel>> observable = request.call(mLoginService.login("v1/account/login", request.getParams().urlParamsMap)); Disposable subscription = observable.subscribe(new Action1<ApiResult<AuthModel>>() { @Override public void call(ApiResult<AuthModel> result) { //請求成功 } }, new Action1<Throwable>() { @Override public void call(Throwable throwable) { //請求失敗 } });
提供默認的支持ApiResult結構,數據返回不須要帶ApiResult,直接返回目標.
示例:
Observable<AuthModel> observable = request.apiCall(mLoginService.login("v1/account/login", request.getParams().urlParamsMap));
請求回調本庫提供兩種方式Callback和Subscriber
此種方式主要針對execute(CallBack<T> callBack),目前內部提供的回調包含CallBack, SimpleCallBack ,ProgressDialogCallBack ,DownloadProgressCallBack 能夠根據本身的需求去自定義Callback
該網絡框架的核心使用方法即爲Callback的繼承使用,由於不一樣的項目需求,會有個性化的回調請自定義
new CallBack<T>() { @Override public void onStart() { //請求開始 } @Override public void onCompleted() { //請求完成 } @Override public void onError(ApiException e) { //請求失敗 } @Override public void onSuccess(T t) { //請求成功 } }
new SimpleCallBack<T>() { @Override public void onError(ApiException e) { //請求失敗 } @Override public void onSuccess(T t) { //請求成功 } }
能夠自定義帶有加載進度框的回調,取消對話框會自動取消掉網絡請求
提供兩個構造
public ProgressDialogCallBack(IProgressDialog progressDialog);//默認不能取消對話框
public ProgressDialogCallBack(IProgressDialog progressDialog, boolean isShowProgress, boolean isCancel);//自定義加載進度框,能夠設置是否顯示彈出框,是否能夠取消 progressDialog: dialog對象接口 isShowProgress:對話框消失是否取消網絡請求 isCancel:是否能夠取消對話框對應Dialog的setCancelable(isCancel)方法;
自定義ProgressDialog對話框
private IProgressDialog mProgressDialog = new IProgressDialog() { @Override public Dialog getDialog() { ProgressDialog dialog = new ProgressDialog(MainActivity.this); dialog.setMessage("請稍候..."); return dialog; } };
此回調只用於文件下載,具體請看文件下載講解
若是對回調有特殊需求,支持能夠繼承CallBack本身擴展功能
此種方式主要是針對execute(Class<T> clazz)和execute(Type type),目前內部提供的Subscriber包含BaseSubscriber、DownloadSubscriber、ProgressSubscriber,能夠根據本身的需求去自定義Subscriber
new BaseSubscriber<T>() { @Override public void onError(ApiException e) { //請求失敗 } @Override public void onNext(T t) { //請求成功 } }
new ProgressSubscriber<T>(this, mProgressDialog) { @Override public void onError(ApiException e) { super.onError(e); //請求失敗 } @Override public void onNext(T t) { //請求成功 } }
若是對Subscriber有特殊需求,支持能夠繼承BaseSubscriber本身擴展訂閱者
本庫的緩存主要分okhttp的Cache緩存和自定義的RxCache緩存,你們有疑問okhttp有緩存,retrofit也是支持經過header來設置緩存,爲何還要自定義一個緩存機制呢?經過自定義RxCache緩存使用更簡單,更符合咱們經常使用的業務需求(經常使用的緩存策略也不會太複雜), retrofit的緩存藉助於okhttp經過攔截器interceptor實現或者經過@Headers("Cache-Control: public, max-age=3600)
具體用法這裏不作詳細描述,有興趣的能夠本身去了解。動態修改緩存時間不方便,例如:同一個接口,不一樣時間段請求的內容緩存的時間不同,須要動態修改。
對於DEFAULT
模式是okhttp的Cache緩存。由於該模式是徹底遵循標準的http協議的,緩存時間是依靠服務端響應頭來控制,也能夠經過攔截器本身處理
對於RxCache的緩存支持多種存儲方式,提供IDiskConverter
轉換器接口目前支持SerializableDiskConverter
和GsonDiskConverter
兩種方式,也能夠自定義Parcelable、fastjson、xml、kryo等轉換器
SerializableDiskConverter
使用緩存前,必須讓緩存的數據全部javaBean對象實現Serializable接口,不然會報NotSerializableException。 由於緩存的原理是將對象序列化後保存,若是不實現Serializable接口,會致使對象沒法序列化,進而沒法保存,也就達不到緩存的效果。
優勢:存儲和讀取都不用再轉化直接就是須要的對象速度快
缺點:若是javabean裏面還有javabean且層級比較多,也必須每一個都要實現Serializable接口,比較麻煩
GsonDiskConverter
此種方式就是以json字符串的方式存儲
優勢:相對於SerializableDiskConverter轉換器,存儲的對象不須要進行序列化
缺點:就是存儲和讀取都要使用Gson進行轉換,object->String->Object的給一個過程,相對來講每次都要轉換性能略低,可是性能基本忽略不計
目前提供了八種CacheMode緩存模式,每種緩存模式均可以指定對應的CacheTime,將複雜經常使用的業務場景封裝在裏面,讓你不用關心緩存的具體實現,而專一於數據的處理
注:不管對於哪一種緩存模式,均可以指定一個cacheKey,建議針對不一樣須要緩存的頁面設置不一樣的cacheKey,若是相同,會致使數據覆蓋。
緩存設置有兩種方式
方式一:全局設置,全部請求都會默認使用此模式
EasyHttp.getInstance() ... .setCacheMode(CacheMode.CACHEANDREMOTE)//不設置默認是NO_CACHE模式 ...
方式二:單個請求設置緩存模式
EasyHttp.get(URL) ... .cacheMode(CacheMode.FIRSTREMOTE) ...
方式一:全局設置,全部請求都會默認使用此存儲轉換器
EasyHttp.getInstance().setCacheDiskConverter(new SerializableDiskConverter())//默認緩存使用序列化轉化
方式二:單個請求設置存儲轉換器
EasyHttp.get(URL).cacheDiskConverter(new GsonDiskConverter());
注:一個請求就選用一種轉換器,切記不要使用SerializableDiskConverter來緩存,又用GsonDiskConverter來讀會報錯
若是你想擁有本身的轉換器請實現IDiskConverter
接口。
示例:
public class CustomDiskConverter implements IDiskConverter { @Override public <T> T load(InputStream source, Type type) { //實現讀功能 return null; } @Override public boolean writer(OutputStream sink, Object data) { //實現寫功能 return false; } }
對具備緩存的回調CallBack,若是你想知道當前的緩存是來自本地仍是網絡,只須要回調中加入CacheResult,其它和普通的網絡請求方式如出一轍。CacheResult中的isFromCache能夠知道是否來自緩存,true:來自緩存,false:來自網絡。請使用new SimpleCallBack<CacheResult<T>>()
也就是在你原有的T上包含一層CacheResult就能夠了。若是不想用到isFromCache就不須要用CacheResult,直接使用new SimpleCallBack<T>()
帶有CacheResult回調示例:
EasyHttp.get(url) .readTimeOut(30 * 1000)//測試局部讀超時30s .cacheMode(cacheMode) .cacheKey(this.getClass().getSimpleName())//緩存key .retryCount(5)//重試次數 .cacheTime(5 * 60)//緩存時間300s,默認-1永久緩存 okhttp和自定義緩存都起做用 //.okCache(new Cache());//okhttp緩存,模式爲默認模式(CacheMode.DEFAULT)才生效 //.cacheDiskConverter(new GsonDiskConverter())//默認使用的是 new SerializableDiskConverter(); .cacheDiskConverter(new SerializableDiskConverter())//默認使用的是 new SerializableDiskConverter(); .timeStamp(true) .execute(new SimpleCallBack<CacheResult<SkinTestResult>>() { @Override public void onError(ApiException e) { //請求失敗 } @Override public void onSuccess(CacheResult<SkinTestResult> cacheResult) { HttpLog.i(cacheResult.toString()); String from = ""; if (cacheResult.isFromCache) { from = "我來自緩存"; } else { from = "我來自遠程網絡"; } .... } });
支持根據緩存key移除緩存,主要是針對RxCache才能起做用
EasyHttp.removeCache("cachekey");
EasyHttp.clearCache();
RxCache是本身封裝的一個本地緩存功能庫,採用Rxjava+DiskLruCache來實現,線程安全內部採用ReadWriteLock機制防止頻繁讀寫緩存形成的異常,能夠獨立使用,單獨用RxCache來存儲數據。採用transformer與網絡請求結合,能夠實現網絡緩存功能,本地硬緩存,具備緩存讀寫功能(異步)、緩存是否存在、根據key刪除緩存、清空緩存(異步)、緩存Key會自動進行MD5加密、能夠設置緩存磁盤大小、緩存key、緩存時間、緩存存儲的轉換器、緩存目錄、緩存Version等功能本庫不做爲重點介紹。後期會將此代碼獨立開源一個庫,做爲一分鐘讓你本身的網絡庫也具備緩存功能,敬請期待!!!
動態參數就是像咱們的token、時間戳timeStamp、簽名sign等,這些參數不能是全局參數由於是變化的,設置成局部參數又太麻煩,每次都要獲取。token是有有效時間的或者異地登陸等都會變化從新獲取,時間戳通常是根據系統的時間,sign是根據請求的url和參數進行加密簽名通常都有本身的簽名規則。有的接口須要這些參數有的接口不須要,本庫很好的解決這個問題。
.accessToken(true)//本次請求是否追加token .timeStamp(false)//本次請求是否攜帶時間戳 .sign(false)//本次請求是否須要簽名
繼承BaseDynamicInterceptor後就能夠獲取到參數的設置值,請詳細看CustomSignInterceptor
的註釋講解,也能夠查看Demo示例
示例:
/** * <p>描述:對參數進行簽名、添加token、時間戳處理的攔截器</p> * 主要功能說明:<br> * 由於參數簽名沒辦法統一,簽名的規則不同,簽名加密的方式也不一樣有MD五、BASE64等等,只提供本身可以擴展的能力。<br> * 做者: zhouyou<br> * 日期: 2017/5/4 15:21 <br> * 版本: v1.0<br> */ public class CustomSignInterceptor extends BaseDynamicInterceptor<CustomSignInterceptor> { @Override public TreeMap<String, String> dynamic(TreeMap<String, String> dynamicMap) { //dynamicMap:是原有的全局參數+局部參數 //你沒必要關心當前是get/post/上傳文件/混合上傳等,庫中會自動幫你處理。 //根據須要本身處理,若是你只用到token則沒必要處理isTimeStamp()、isSign() if (isTimeStamp()) {//是否添加時間戳,由於你的字段key可能不是timestamp,這種動態的本身處理 dynamicMap.put(ComParamContact.Common.TIMESTAMP, String.valueOf(System.currentTimeMillis())); } if (isSign()) {是否簽名 //1.由於你的字段key可能不是sign,這種須要動態的本身處理 //2.由於你的簽名的規則不同,簽名加密方式也不同,只提供本身可以擴展的能力 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:是原有的全局參數+局部參數+新增的動態參數 } //示例->簽名規則:POST+url+參數的拼裝+secret private String sign(TreeMap<String, String> dynamicMap) { String url = getHttpUrl().url().toString(); url = url.replaceAll("%2F", "/"); StringBuilder sb = new StringBuilder("POST"); sb.append(url); for (Map.Entry<String, String> 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()); } }
最好經過全局的方式設置,由於通常不少接口都會使用到
EasyHttp.getInstance() ... .addInterceptor(new CustomSignInterceptor())//添加動態參數(簽名、token、時間戳)攔截器 ...
本庫中默認提供的是標準ApiResult.內部是靠ApiResult進行解析的,若是你的數據結構跟ApiResult不一樣,你能夠在你的項目中繼承ApiResult,而後重寫getCode()、getData()、getMsg()和isOk()等方法來實現本身的需求。
本庫中ApiResult以下:
public class ApiResult<T> { 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() {//請求成功的判斷方法 return code == 0 ? true : false; } }
json格式相似:
{ "code": 100010101, "data": 內容, "msg": "請求成功" }
假如你的數據結構是這樣的:
{ "error_code": 0, "result": 內容, "reason": "請求成功" }
那麼你的basebean能夠寫成這樣
public class CustomApiResult<T> extends ApiResult<T> { 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表示成功,請重寫isOk()方法。 }*/ }
那麼你的網絡請求能夠這樣寫
EasyHttp.get(url) .readTimeOut(30 * 1000)//局部定義讀超時 .writeTimeOut(30 * 1000) .connectTimeout(30 * 1000) //.cacheKey(this.getClass().getSimpleName()+"11") //.cacheMode(CacheMode.CACHEANDREMOTE) //.cacheMode(CacheMode.ONLYREMOTE) //.headers("","")//設置頭參數 //.params("name","張三")//設置參數 //.addInterceptor() //.addConverterFactory() //.addCookie() //.timeStamp(true) .baseUrl("http://apis.juhe.cn") .params("phone", "手機號") .params("dtype", "json") .params("key", "5682c1f44a7f486e40f9720d6c97ffe4") .execute(new CallBackProxy<CustomApiResult<ResultBean>, ResultBean>(new SimpleCallBack<ResultBean>() { @Override public void onError(ApiException e) { //請求錯誤 } @Override public void onSuccess(ResultBean response) { //請求成功 } }) { });
這種寫法會以爲有點長,CallBackProxy的泛型參數每次都須要填寫,其中CustomApiResult是繼承ApiResult的,CustomApiResult至關於項目的basebean,對於一個實際項目來說,basebean是固定的,因此咱們能夠繼續封裝這個方法,根據須要通常只須要封裝get和post請求就能夠了。
public static <T> Disposable customExecute(CallBack<T> callBack) { return execute(new CallBackProxy<CustomApiResult<T>, T>(callBack) { }); }
經過以上改造,再次調用時直接使用CallBack,不用再關注CallBackProxy,是否是明顯簡單不少了,具體請看代碼Demo!!!
Observable<ResultBean> observable = EasyHttp.get("/mobile/get") .readTimeOut(30 * 1000)//局部定義讀超時 .writeTimeOut(30 * 1000) .baseUrl("http://apis.juhe.cn") .params("phone", "18688994275") .params("dtype", "json") .params("key", "5682c1f44a7f486e40f9720d6c97ffe4") .execute(new CallClazzProxy<CustomApiResult<ResultBean>, ResultBean>(ResultBean.class) { }); observable.subscribe(new ProgressSubscriber<ResultBean>(this, mProgressDialog) { @Override public void onError(ApiException e) { super.onError(e); showToast(e.getMessage()); } @Override public void onNext(ResultBean result) { showToast(result.toString()); } });
一個好的庫,必定有比較人性化的調試模式,爲了方便開發者查看請求過程和請求日誌,本庫提供詳細的日誌打印,最好在開發階段,請打開調試模式輸出優雅的Log.
調試模式的控制在初始化配置時就能夠直接設置。
public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); ... EasyHttp.getInstance() ... // 打開該調試開關並設置TAG,不須要就不要加入該行 // 最後的true表示是否打印okgo的內部異常,通常打開方便調試錯誤 .debug("EasyHttp", true); } }
這裏一個成功請求的例子:
上方的Log打印了一個Request完整的聲明週期,一個請求的Log有如下特色:
1.開頭和結尾打了-->http is start和 -->http is Complete分割請求,完整的生命週期的內容都會打印在開頭和結尾的裏面。
2.request請求和response響應分割,分別是
-------------------------------request--------------------------------------------------------------response-------------------------------
3.在---request---以後會打印請求的url、當前請求的類型GET/POST... -->GET/POST開頭 -->END GET/POST結尾。若是是GET、HEAD請求方式添加的參數將會在這裏完整的以url?key=value&key=value的形式打印。
4.在----response----以後會打印(在服務器響應後被打印),包含響應碼、響應狀態、響應頭、cookie,body等以<--200(響應碼)開頭,<--END HTTP結尾
5.loadCache key=若是設置了緩存,會看到緩存的key,開啓了網絡緩存功能纔會輸出。
6.loadCache result=從緩存裏讀取的結果,開啓了網絡緩存功能纔會輸出。
7.save status => true保存緩存的狀態
-dontwarn okio.** -dontwarn javax.annotation.Nullable -dontwarn javax.annotation.ParametersAreNonnullByDefault -dontwarn javax.annotation.** -keep com.zhouyou.http.model -keep com.zhouyou.http.cache.model