RxEasyHttp一款基於RxJava2+Retrofit2實現簡單易用的網路請求框架
RxEasyHttp
本庫是一款基於Retrofit2+RxJava2實現簡單易用的網路請求框架,結合android平臺特性的網路封裝庫,採用api鏈式呼叫一點到底,整合cookie管理,多種快取模式,極簡https配置,上傳下載進度顯示,請求錯誤自動重試,請求攜帶token、時間戳、簽名sign動態配置,自動登入成功後請求重發功能,3種層次的引數設定預設全域性區域性,預設標準ApiResult同時可以支援自定義的資料結構,已經能滿足現在的大部分網路請求。
注:Retrofit和Rxjava是當下非常火爆的開源框架,均來自神一般的Square公司。本庫就不介紹Retrofit和Rxjava的用法。
為什麼會封裝此庫?
網上好的開源網路庫像Volley、async-http、okhttp、retrofit等都非常強大,但是實際應用中我們不會直接去使用,一般都會根據自己的業務再封裝一層,這樣更方便快捷,又能統一處理業務共性的東西例如:統一的資料結構(code、msg、data)、token處理、網路異常等情況。在使用retrofit來請求網路的時候,專案的需求越來越多,api也隨之越來越多,一個普通的應用api一般也在100+左右。如果把這些api放在一個ApiService內會很臃腫,不利於檢視api.如果採用模組的方式對api進行分類,每個模組對應若干個api.以retrofit的使用方式又需要建立若干個ApiService,這種方式維護方便,但是模組增多了,類也增多了很多。對於懶人來說就想通過一個URL就能回撥你所需要的資料,什麼ApiService都不想理會,同時又可以很快的與自己的業務相關聯,就類似於代替你在開源網路庫基礎上再封裝一層的作用,於是本庫就應運而生。
特點
- 比Retrofit使用更簡單、更易用。
- 採用鏈式呼叫一點到底
- 加入基礎ApiService,減少Api冗餘
- 支援動態配置和自定義底層框架Okhttpclient、Retrofit.
- 支援多種方式訪問網路GET、POST、PUT、DELETE等請求協議
- 支援網路快取,六種快取策略可選,涵蓋大多數業務場景
- 支援固定新增header和動態新增header
- 支援新增全域性引數和動態新增區域性引數
- 支援檔案下載、多檔案上傳和表單提交資料
- 支援檔案請求、上傳、下載的進度回撥、錯誤回撥,也可以自定義回撥
- 支援預設、全域性、區域性三個層次的配置功能
- 支援任意資料結構的自動解析
- 支援新增動態引數例如timeStamp時間戳、token、簽名sign
- 支援自定義的擴充套件API
- 支援多個請求合併
- 支援Cookie管理
- 支援非同步、同步請求
- 支援Https、自簽名網站Https的訪問、雙向驗證
- 支援失敗重試機制,可以指定重試次數、重試間隔時間
- 支援根據ky刪除網路快取和清空網路快取
- 提供預設的標準ApiResult解析和回撥,並且可自定義ApiResult
- 支援取消資料請求,取消訂閱,帶有對話方塊的請求不需要手動取消請求,對話方塊消失會自動取消請求
- 支援請求資料結果採用回撥和訂閱兩種方式
- api設計上結合http協議和android平臺特點來實現,loading對話方塊,實時進度條顯示
- 返回結果和異常統一處理
- 結合RxJava2,執行緒智慧控制
聯絡方式
郵箱地址: [email protected]
QQ群: 581235049(建議使用QQ群,郵箱使用較少,可能看的不及時)
本群旨在為使用我的github專案的人提供方便,如果遇到問題歡迎在群裡提問。一個人的能力也有限,希望一起學習一起進步。
關注我的github,瞭解我的最新專案。關注我的部落格,閱讀我的最新文章。
歡迎加入QQ交流群
演示(請star支援)
版本說明
當前版本
V2.0.0
- 網路庫從Rxjava升級到Rxjava2
- 優化快取策略實現
- 修復同步請求回撥問題
- 修復put請求失敗問題
- 修改圖片請求失敗@url問題導致404錯誤
- 修復多圖片表單上傳失敗問題
- Demo增加根據key獲取快取的演示
- 修復post提交json到後臺問題
- 定位upObject失敗原因,需要加轉換器addConverterFactory(GsonConverterFactory.create())
更新日誌
用法介紹
目前只支援主流開發工具AndtoidStudio的使用,沒有提供Eclipse使用方式.
本專案Demo的網路請求的伺服器地址為了安全,把url去掉了,但是Demo程式中的示例都是ok的
build.gradle設定
dependencies {
compile 'com.zhouyou:rxeasyhttp:2.0.0'
}
想檢視所有版本,請點選下面地址。
許可權說明
如果使用本庫實現檔案下載到SD卡、或者配置了快取資料到SD卡,你必須要考慮到Android6.0及以上系統的執行時許可權,給大家推薦兩個許可權庫:
因為要請求網路、從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。
Application:
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
}
}
manifest.xml:
...
<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轉化,所以不用配置
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.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.包含一次普通請求所有能配置的引數,真實使用時不需要配置這麼多,按自己的需要選擇性的使用即可
2.以下配置全部是單次請求配置,不會影響全域性配置,沒有配置的仍然是使用全域性引數。
3.為單個請求設定超時,比如涉及到檔案的需要設定讀寫等待時間多一點。
完整引數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
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都不會被拼接。
http請求引數
兩種設定方式
.params(HttpParams params)
.params(“param1”,”param1Value”)//新增引數鍵值對
HttpParams params = new HttpParams();
params.put(“appId”, AppConstant.APPID);
.addCommonParams(params)//設定全域性公共引數
http請求頭
.headers(HttpHeaders headers)
.headers(“header2”,”header2Value”)//新增引數鍵值對
.addCommonHeaders(headers)//設定全域性公共頭
普通網路請求
支援get/post/delete/put等
鏈式呼叫的終點請求的執行方式有:execute(Class clazz) 、execute(Type type)、execute(CallBack callBack)三種方式,都是針對標準的ApiResult
execute(CallBack callBack)
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 clazz)和execute(Type type)
execute(Class 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 subscription = 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(subscription);
帶有進度框的請求
帶有進度框的請求,可以設定對話方塊消失是否自動取消網路和自定義對話方塊功能,具體引數作用請看請求回撥講解
方式一:ProgressDialogCallBack
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);必須寫
方式二:ProgressSubscriber
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
通過網路請求可以返回Observable,這樣就可以很好的通過Rxjava與其它場景業務結合處理,甚至可以通過Rxjava的connect()操作符處理多個網路請求。例如:在一個頁面有多個網路請求,如何在多個請求都訪問成功後再顯示頁面呢?這也是Rxjava強大之處。
注:目前通過execute(Class 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) {
//下載失敗
}
});
POST請求,上傳String、json、object、body、byte[]
一般此種用法用於與伺服器約定的資料格式,當使用該方法時,params中的引數設定是無效的,所有引數均需要通過需要上傳的文字中指定,此外,額外指定的header引數仍然保持有效。
- .upString("這是要上傳的長文字資料!")//預設型別是:MediaType.parse("text/plain")
- 如果你對請求頭有自己的要求,可以使用這個過載的形式,傳入自定義的content-type文字
upString("這是要上傳的長文字資料!", "application/xml") // 比如上傳xml資料,這裡就可以自己指定請求頭
- upJson該方法與upString沒有本質區別,只是資料格式是json,通常需要自己建立一個實體bean或者一個map,把需要的引數設定進去,然後通過三方的Gson或者 fastjson轉換成json字串,最後直接使用該方法提交到伺服器。
.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取消
每個請求前都會返回一個Subscription,取消訂閱就可以取消網路請求,如果是帶有進度框的網路請求,則不需要手動取消網路請求,會自動取消。
Disposable mSubscription = EasyHttp.get(url).execute(callback);
...
@Override
protected void onDestroy() {
super.onDestroy();
EasyHttp.cancelSubscription(mSubscription);
}
通過dialog取消
自動取消使用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>() {});
請求回撥CallBack支援的型別
//支援回撥的型別可以是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的作用這裡就不再科普,自己可以去了解
cookie設定:
EasyHttp.getInstance()
...
//如果不想讓本庫管理cookie,以下不需要
.setCookieStore(new CookieManger(this)) //cookie持久化儲存,如果cookie不過期,則一直有效
...
- 檢視url所對應的cookie
HttpUrl httpUrl = HttpUrl.parse("http://www.xxx.com/test");
CookieManger cookieManger = getCookieJar();
List<Cookie> cookies = cookieManger.loadForRequest(httpUrl);
- 檢視CookieManger所有cookie
PersistentCookieStore cookieStore= getCookieJar().getCookieStore();
List<Cookie> cookies1= 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()請求
提供了使用者自定義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));
Subscription subscription = observable.subscribe(new Action1<ApiResult<AuthModel>>() {
@Override
public void call(ApiResult<AuthModel> result) {
//請求成功
}
}, new Action1<Throwable>() {
@Override
public void call(Throwable throwable) {
//請求失敗
}
});
自定義apiCall()請求
提供預設的支援ApiResult結構,資料返回不需要帶ApiResult,直接返回目標.
示例:
Observable<AuthModel> observable = request.apiCall(mLoginService.login("v1/account/login", request.getParams().urlParamsMap));
請求回撥和訂閱
請求回撥本庫提供兩種方式Callback和Subscriber
回撥方式
此種方式主要針對execute(CallBack callBack),目前內部提供的回撥包含CallBack, SimpleCallBack ,ProgressDialogCallBack ,DownloadProgressCallBack 可以根據自己的需求去自定義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) {
//請求成功
}
}
SimpleCallBack回撥
new SimpleCallBack<T>() {
@Override
public void onError(ApiException e) {
//請求失敗
}
@Override
public void onSuccess(T t) {
//請求成功
}
}
ProgressDialogCallBack回撥
可以自定義帶有載入