對Okhttp3進(jìn)行二次封裝,對外提供了POST請求、GET請求、PATCH請求、PUT請求、DELETE請求、上傳文件、下載文件、取消請求、Raw/Json/Gson返回、后臺下載管理等功能
1 前言
之前的一篇文章 Android架構(gòu)系列-封裝自己的okhttp 對okhttp進(jìn)行了一個簡單的封裝，具有POST、GET、上傳下載功能和JSON、GSON格式返回。
升級版MyOkHttp進(jìn)行了重構(gòu)并增加許多功能點，如下
- 所有請求全部優(yōu)化為了Builder模式傳參（方便參數(shù)擴展）
- 請求增加addHeader可以添加請求頭
- 增加PATCH、PUT、DELETE請求方法
- 增加下載管理后臺，包括斷點續(xù)傳、下載隊列管理功能等
該代碼已經(jīng)抽出來新建了一個庫放在GitHub上，歡迎Star和PR。
https://github.com/tsy12321/MyOkHttp
2 使用說明
2.1 如何添加
在app目錄下的build.gradle中添加依賴
compile 'com.github.tsy12321:MyOkHttp:lastest_version' //lastest_version見github上最新版本
2.2 創(chuàng)建MyOkHttp
在項目入口創(chuàng)建唯一MyOkhttp實例
MyOkHttp mMyOkhttp = new MyOkHttp();
也可以自行配置OkhttpClient.
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.connectTimeout(10000L, TimeUnit.MILLISECONDS)
.readTimeout(10000L, TimeUnit.MILLISECONDS)
//其他配置
.build();
MyOkHttp mMyOkhttp = new MyOkHttp(okHttpClient);
2.3 調(diào)用方式
整個調(diào)用采用鏈?zhǔn)秸{(diào)用的方式. 方便以后擴展.
2.4 請求類型
現(xiàn)在有Get, Post, Patch, Put, Delete, Upload, Download 這些請求方式
2.5 添加參數(shù)方式
添加參數(shù)可以使用addParam一個個添加, 也可以使用params一次性添加
2.6 添加Header方式
添加參數(shù)可以使用addHeader一個個添加, 也可以使用headers一次性添加
2.7 回調(diào)格式
現(xiàn)在回調(diào)格式有以下幾種:
- Raw原生數(shù)據(jù) RawResponseHandler
- Json JsonResponseHandler
- Gson GsonResponseHandler
2.8 調(diào)用示例
2.8.1 POST請求 + Json回調(diào)示例
String url = "http://192.168.2.135/myokhttp/post.php";
Map<String, String> params = new HashMap<>();
params.put("name", "tsy");
params.put("age", "24");
mMyOkhttp.post()
.url(url)
.params(params)
.tag(this)
.enqueue(new JsonResponseHandler() {
@Override
public void onSuccess(int statusCode, JSONObject response) {
Log.d(TAG, "doPost onSuccess:" + response);
}
@Override
public void onFailure(int statusCode, String error_msg) {
Log.d(TAG, "doPost onFailure:" + error_msg);
}
});
2.8.2 GET請求 + Raw回調(diào)示例
String url = "http://192.168.2.135/myokhttp/get.php";
mMyOkhttp.get()
.url(url)
.addParam("name", "tsy")
.addParam("id", "5")
.tag(this)
.enqueue(new RawResponseHandler() {
@Override
public void onSuccess(int statusCode, String response) {
Log.d(TAG, "doGet onSuccess:" + response);
}
@Override
public void onFailure(int statusCode, String error_msg) {
Log.d(TAG, "doGet onFailure:" + error_msg);
}
});
2.8.3 Patch請求 + Json回調(diào)示例
String url = "http://192.168.2.135/myokhttp/patch.php/id/5/name/tsy";
mMyOkhttp.patch()
.url(url)
.tag(this)
.enqueue(new JsonResponseHandler() {
@Override
public void onSuccess(int statusCode, JSONObject response) {
Log.d(TAG, "doPatch onSuccess:" + response);
}
@Override
public void onFailure(int statusCode, String error_msg) {
Log.d(TAG, "doPatch onFailure:" + error_msg);
}
});
2.8.4 上傳文件 + Gson回調(diào)示例
String url = "http://192.168.2.135/myokhttp/upload.php";
mMyOkhttp.upload()
.url(url)
.addParam("name", "tsy")
.addFile("avatar",
new File(Environment.getExternalStorageDirectory()
+ "/ahome/sasas.jpg")) //上傳已經(jīng)存在的File
// .addFile("avatar2", "asdsda.png", byteContents) //直接上傳File bytes
.tag(this)
.enqueue(new GsonResponseHandler<UploadModel>() {
@Override
public void onFailure(int statusCode, String error_msg) {
Log.d(TAG, "doUpload onFailure:" + error_msg);
}
@Override
public void onProgress(long currentBytes, long totalBytes) {
Log.d(TAG, "doUpload onProgress:" + currentBytes + "/" + totalBytes);
}
@Override
public void onSuccess(int statusCode, UploadModel response) {
Log.d(TAG, "doUpload onSuccess:" + response.ret + " " + response.msg);
}
});
2.8.5 下載文件
String url = "http://192.168.2.135/myokhttp/head.jpg";
mMyOkhttp.download()
.url(url)
.filePath(Environment.getExternalStorageDirectory() + "/ahome/a.jpg")
.tag(this)
.enqueue(new DownloadResponseHandler() {
@Override
public void onStart(long totalBytes) {
Log.d(TAG, "doDownload onStart");
}
@Override
public void onFinish(File downloadFile) {
Log.d(TAG, "doDownload onFinish:");
}
@Override
public void onProgress(long currentBytes, long totalBytes) {
Log.d(TAG, "doDownload onProgress:" + currentBytes + "/" + totalBytes);
}
@Override
public void onFailure(String error_msg) {
Log.d(TAG, "doDownload onFailure:" + error_msg);
}
});
2.9 取消請求(建議放在BaseActivity,BaseFragment的onDestroy中)
mMyOkhttp.cancel(this); //tag 即之前請求時傳入的tag 建議直接將頁面作為object傳入
2.10 下載管理
實現(xiàn)了下載管理的核心邏輯，包括添加下載任務(wù)、開始任務(wù)、暫停任務(wù)、刪除任務(wù)、任務(wù)下載等待、下載進(jìn)度和狀態(tài)監(jiān)聽等功能。依賴于MyOkhttp
2.10.1 實現(xiàn)AbstractDownloadMgr
項目中創(chuàng)建DownloadMgr繼承AbstractDownloadMgr，并實現(xiàn)下載任務(wù)的狀態(tài)，進(jìn)度的本地持久化保存。（AbstractDownloadMgr只負(fù)責(zé)在內(nèi)存中存儲所有任務(wù)，
需要項目自行實現(xiàn)本地持續(xù)化存儲，重新進(jìn)入App后的任務(wù)恢復(fù)等）
示例：
/**
* 實現(xiàn)下載管理 AbstractDownloadMgr
* Created by tsy on 2016/11/24.
*/
public class DownloadMgr extends AbstractDownloadMgr {
private DownloadMgr(Builder builder) {
super(builder);
}
/**
* 初始進(jìn)入app 恢復(fù)所有未完成的任務(wù)
*/
@Override
public void resumeTasks() {
if(DEBUG) {
Log.i(TAG, "start resumeTasks");
}
//獲取所有未完成的任務(wù)（已完成的不需要添加）
DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
ArrayList<Task> tasks = downloadInteractor.parseTask(downloadInteractor.getAllUnfinishedDownloadTasks());
//將任務(wù)加到下載管理隊列中
if(tasks != null && tasks.size() > 0) {
for(int i = 0; i < tasks.size(); i ++) {
Task task = tasks.get(i);
task.setDefaultStatus(DEFAULT_TASK_STATUS_PAUSE); //所有任務(wù)初始設(shè)置為暫停
addTask(tasks.get(i));
}
downloadInteractor.pauseAllTask();
}
}
/**
* 保存進(jìn)度
* @param taskId taskId
* @param currentBytes 已經(jīng)下載的bytes
* @param totalBytes 總共bytes
*/
@Override
protected void saveProgress(String taskId, long currentBytes, long totalBytes) {
DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
downloadInteractor.updateProgress(taskId, currentBytes, totalBytes);
}
/**
* 下載任務(wù)開始
* @param taskId task id
*/
@Override
protected void onTaskStart(String taskId) {
DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
downloadInteractor.startTask(taskId);
}
/**
* 下載任務(wù)暫停
* @param taskId task id
*/
@Override
protected void onTaskPause(String taskId) {
DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
downloadInteractor.pauseTask(taskId);
}
/**
* 下載任務(wù)完成
* @param taskId task id
*/
@Override
protected void onTaskFinish(String taskId) {
DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
downloadInteractor.finishTask(taskId);
}
/**
* 下載任務(wù)失敗
* @param taskId task id
*/
@Override
protected void onTaskFail(String taskId) {
//失敗設(shè)置為暫停 允許用戶再次嘗試開始
DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
downloadInteractor.pauseTask(taskId);
}
//實現(xiàn)Builder
public static class Builder extends AbstractDownloadMgr.Builder {
@Override
public AbstractDownloadMgr build() {
return new DownloadMgr(this);
}
}
}
2.10.2 項目開始時初始化唯一實例DownloadMgr 并自定義配置
mDownloadMgr = (DownloadMgr) new DownloadMgr.Builder()
.myOkHttp(mMyOkhttp)
.maxDownloadIngNum(5) //設(shè)置最大同時下載數(shù)量（不設(shè)置默認(rèn)5）
.saveProgressBytes(50 * 1024) //設(shè)置每50kb觸發(fā)一次saveProgress保存進(jìn)度 （不能在onProgress每次都保存 過于頻繁） 不設(shè)置默認(rèn)50kb
.build();
2.10.3 恢復(fù)本地存儲的所有未完成的任務(wù)
mDownloadMgr.resumeTasks();
2.10.4 創(chuàng)建一個下載任務(wù)
DownloadMgr.Task task = new DownloadMgr.Task();
task.setTaskId(mDownloadMgr.genTaskId()); //生成一個taskId
task.setUrl("xxxxx"); //下載地址
task.setFilePath("xxxxxxx"); //下載后文件保存位置
task.setCompleteBytes(1234L); //設(shè)置已完成的bytes （用于恢復(fù)任務(wù)時添加，如果新添加的任務(wù)不需要設(shè)置該字段）
task.setDefaultStatus(DownloadMgr.DEFAULT_TASK_STATUS_START); //任務(wù)添加后開始狀態(tài) 如果不設(shè)置 默認(rèn)任務(wù)添加后就自動開始
mDownloadMgr.addTask(task);
2.10.5 開始 暫停任務(wù)
mDownloadMgr.startTask("taskId");
mDownloadMgr.pauseTask("taskId");
2.10.6 頁面添加下載監(jiān)聽
PS：不要使用匿名類，會造成內(nèi)存泄露。在onStart或者onResume時初始化監(jiān)聽，在onStop或者onPause時銷毀監(jiān)聽
@Override
public void onResume() {
super.onResume();
//每次顯示頁面的時候加上監(jiān)聽
mDownloadTaskListener = new DownloadTaskListener() {
@Override
public void onStart(String taskId, long completeBytes, long totalBytes) {
//開始下載
}
@Override
public void onProgress(String taskId, long currentBytes, long totalBytes) {
//下載進(jìn)度
//建議使用handler延遲刷新下載進(jìn)度 不然過于頻繁刷新
if(!mMyHandler.hasMessages(MSG_DELAY_NOTIFICAION)) {
Message message = new Message();
message.what = MSG_DELAY_NOTIFICAION;
mMyHandler.sendMessageDelayed(message, 300);
}
}
@Override
public void onPause(String taskId, long currentBytes, long totalBytes) {
//下載暫停
}
@Override
public void onFinish(String taskId, File file) {
//下載完成
}
@Override
public void onFailure(String taskId, String error_msg) {
//下載失敗
}
};
//加入監(jiān)聽
mDownloadMgr.addListener(mDownloadTaskListener);
}
@Override
public void onPause() {
//釋放監(jiān)聽 防止內(nèi)存泄露
mDownloadMgr.removeListener(mDownloadTaskListener);
mDownloadTaskListener = null;
super.onPause();
}
3 結(jié)尾
具體實現(xiàn)在代碼中有小Demo。再次附上Github地址：
https://github.com/tsy12321/MyOkHttp
2017-01-06更新
1 增加本地持久化cookie => PersistentCookieJar
設(shè)置cookie.
//設(shè)置開啟cookie
ClearableCookieJar cookieJar =
new PersistentCookieJar(new SetCookieCache(), new SharedPrefsCookiePersistor(getApplicationContext()));
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.cookieJar(cookieJar)
.build();
mMyOkHttp = new MyOkHttp(okHttpClient);
2 POST增加JSON格式參數(shù)請求
String url = "http://192.168.2.135/myokhttp/post_json.php";
JSONObject jsonObject = new JSONObject();
try {
jsonObject.put("name", "tsy");
jsonObject.put("age", 24);
jsonObject.put("type", "json");
} catch (JSONException e) {
e.printStackTrace();
}
mMyOkhttp.post()
.url(url)
.jsonParams(jsonObject.toString()) //與params不共存 以jsonParams優(yōu)先
.tag(this)
.enqueue(new JsonResponseHandler() {
@Override
public void onSuccess(int statusCode, JSONObject response) {
Log.d(TAG, "doPostJSON onSuccess JSONObject:" + response);
}
@Override
public void onSuccess(int statusCode, JSONArray response) {
Log.d(TAG, "doPostJSON onSuccess JSONArray:" + response);
}
@Override
public void onFailure(int statusCode, String error_msg) {
Log.d(TAG, "doPostJSON onFailure:" + error_msg);
}
});
