github源碼地址：https://github.com/zhou-you/RxEasyHttp
請求數(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<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或者h(yuǎn)ttps,則不會拼接初始化設(shè)置的baseUrl.
例如：EasyHttp.get("http://www.xxx.com/v1/app/chairdressing/skinAnalyzePower/skinTestResult")則setBaseUrl()和baseUrl()傳入的baseurl都不會被拼接。
http請求參數(shù)
兩種設(shè)置方式
.params(HttpParams params)
.params("param1","param1Value")//添加參數(shù)鍵值對
HttpParams params = new HttpParams();
params.put("appId", AppConstant.APPID);
.addCommonParams(params)//設(shè)置全局公共參數(shù)
http請求頭
.headers(HttpHeaders headers)
.headers("header2","header2Value")//添加參數(shù)鍵值對
.addCommonHeaders(headers)//設(shè)置全局公共頭
普通網(wǎng)絡(luò)請求
支持get/post/delete/put等
鏈?zhǔn)秸{(diào)用的終點請求的執(zhí)行方式有：execute(Class<T> clazz) 、execute(Type type)、execute(CallBack<T> callBack)三種方式，都是針對標(biāo)準(zhǔn)的ApiResult
execute(CallBack<T> 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.手動創(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<SkinTestResult>() {
@Override
public void onError(ApiException e) {
}
@Override
public void onSuccess(SkinTestResult response) {
}
});
execute(Class<T> clazz)和execute(Type type)
execute(Class<T> clazz)和execute(Type type)功能基本一樣，execute(Type type)主要是針對集合不能直接傳遞Class
EasyHttp.get(url)
.params("param1", "paramValue1")
.execute(SkinTestResult.class)//非常簡單直接傳目標(biāo)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());
}
});
請求返回Subscription
網(wǎng)絡(luò)請求會返回Subscription對象，方便取消網(wǎng)絡(luò)請求
Subscription 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());
}
});
//在需要取消網(wǎng)絡(luò)請求的地方調(diào)用,一般在onDestroy()中
//EasyHttp.cancelSubscription(subscription);
帶有進(jìn)度框的請求
帶有進(jìn)度框的請求，可以設(shè)置對話框消失是否自動取消網(wǎng)絡(luò)和自定義對話框功能，具體參數(shù)作用請看請求回調(diào)講解
方式一：ProgressDialogCallBack
ProgressDialogCallBack帶有進(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<SkinTestResult>(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);必須寫
方式二：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
通過網(wǎng)絡(luò)請求可以返回Observable，這樣就可以很好的通過Rxjava與其它場景業(yè)務(wù)結(jié)合處理，甚至可以通過Rxjava的connect()操作符處理多個網(wǎng)絡(luò)請求。例如：在一個頁面有多個網(wǎng)絡(luò)請求，如何在多個請求都訪問成功后再顯示頁面呢？這也是Rxjava強(qiáng)大之處。
注：目前通過execute(Class<T> clazz)方式只支持標(biāo)注的ApiResult結(jié)構(gòu)，不支持自定義的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());
}
});
文件下載
本庫提供的文件下載非常簡單，沒有提供復(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<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[]
一般此種用法用于與服務(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
注：upString、upJson、requestBody、upBytes、upObject五個方法不能同時使用，當(dāng)前只能選用一個
示例：
HashMap<String, String> params = new HashMap<>();
params.put("key1", "value1");
params.put("key2", "這里是需要提交的json格式數(shù)據(jù)");
params.put("key3", "也可以使用三方工具將對象轉(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ù)會被上傳
.upString("這里是要上傳的文本！")//默認(rèn)類型是：MediaType.parse("text/plain")
//.upString("這是要上傳的長文本數(shù)據(jù)！", "application/xml") // 比如上傳xml數(shù)據(jù)，這里就可以自己指定請求頭
//.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);
}
});
上傳圖片或者文件
支持單文件上傳、多文件上傳、混合上傳，同時支持進(jìn)度回調(diào)，
暫不實現(xiàn)多線程上傳/分片上傳/斷點續(xù)傳等高級功能
上傳文件支持文件與參數(shù)一起同時上傳，也支持一個key上傳多個文件，以下方式可以任選
上傳文件支持兩種進(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<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") // 這里可以上傳參數(shù)
.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);
}
});
取消請求
通過Subscription取消
每個請求前都會返回一個Subscription，取消訂閱就可以取消網(wǎng)絡(luò)請求，如果是帶有進(jìn)度框的網(wǎng)絡(luò)請求，則不需要手動取消網(wǎng)絡(luò)請求，會自動取消。
Subscription mSubscription = EasyHttp.get(url).execute(callback);
...
@Override
protected void onDestroy() {
super.onDestroy();
EasyHttp.cancelSubscription(mSubscription);
}
通過dialog取消
自動取消使用ProgressDialogCallBack回調(diào)或者使用ProgressSubscriber,就不用再手動調(diào)用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());
}
})
同步請求
同步請求只需要設(shè)置syncRequest()方法
EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
...
.syncRequest(true)//設(shè)置同步請求
.execute(new CallBack<SkinTestResult>() {});
請求回調(diào)CallBack支持的類型
//支持回調(diào)的類型可以是Bean、String、CacheResult<Bean>、CacheResult<String>、List<Bean>
new SimpleCallBack<CacheResult<Bean>>()//支持緩存的回調(diào)，請看緩存講解
new SimpleCallBack<CacheResult<String>>()//支持緩存的回調(diào)，請看緩存講解
new SimpleCallBack<Bean>()//返回Bean
new SimpleCallBack<String>()//返回字符串
new SimpleCallBack<List<Bean>()//返回集合
注：其它回調(diào)同理
cookie使用
cookie的內(nèi)容主要包括：名字，值，過期時間，路徑和域。路徑與域一起構(gòu)成cookie的作用范圍,關(guān)于cookie的作用這里就不再科普，自己可以去了解
cookie設(shè)置：
EasyHttp.getInstance()
...
//如果不想讓本庫管理cookie,以下不需要
.setCookieStore(new CookieManger(this)) //cookie持久化存儲，如果cookie不過期，則一直有效
...
- 查看url所對應(yīng)的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的接口，您只需調(diào)用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()))//自定義的可以設(shè)置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()請求
提供默認(rèn)的支持ApiResult結(jié)構(gòu)，數(shù)據(jù)返回不需要帶ApiResult,直接返回目標(biāo).
示例：
Observable<AuthModel> observable = request.apiCall(mLoginService.login("v1/account/login", request.getParams().urlParamsMap));
