OkHttp封裝進階-MyOkHttp

Tsy遠發表於2017-09-22
HTTP封裝

對Okhttp3進行二次封裝,對外提供了POST請求、GET請求、PATCH請求、PUT請求、DELETE請求、上傳檔案、下載檔案、取消請求、Raw/Json/Gson返回、後臺下載管理等功能

1 前言

之前的一篇文章 Android架構系列-封裝自己的okhttp 對okhttp進行了一個簡單的封裝，具有POST、GET、上傳下載功能和JSON、GSON格式返回。

升級版MyOkHttp進行了重構並增加許多功能點，如下

  1. 所有請求全部優化為了Builder模式傳參（方便引數擴充套件）
  2. 請求增加addHeader可以新增請求頭
  3. 增加PATCH、PUT、DELETE請求方法
  4. 增加下載管理後臺，包括斷點續傳、下載佇列管理功能等

該程式碼已經抽出來新建了一個庫放在GitHub上，歡迎Star和PR。
github.com/tsy12321/My…

2 使用說明

2.1 如何新增

在app目錄下的build.gradle中新增依賴

compile 'com.github.tsy12321:MyOkHttp:lastest_version'  //lastest_version見github上最新版本複製程式碼

2.2 建立MyOkHttp

在專案入口建立唯一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 呼叫方式

整個呼叫採用鏈式呼叫的方式. 方便以後擴充套件.

2.4 請求型別

現在有Get, Post, Patch, Put, Delete, Upload, Download 這些請求方式

2.5 新增引數方式

新增引數可以使用addParam一個個新增, 也可以使用params一次性新增

2.6 新增Header方式

新增引數可以使用addHeader一個個新增, 也可以使用headers一次性新增

2.7 回撥格式

現在回撥格式有以下幾種:

  1. Raw原生資料 RawResponseHandler
  2. Json JsonResponseHandler
  3. Gson GsonResponseHandler

2.8 呼叫示例

2.8.1 POST請求 + Json回撥示例

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回撥示例

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回撥示例

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回撥示例

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"))        //上傳已經存在的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 下載管理

實現了下載管理的核心邏輯，包括新增下載任務、開始任務、暫停任務、刪除任務、任務下載等待、下載進度和狀態監聽等功能。依賴於MyOkhttp

2.10.1 實現AbstractDownloadMgr

專案中建立DownloadMgr繼承AbstractDownloadMgr，並實現下載任務的狀態，進度的本地持久化儲存。（AbstractDownloadMgr只負責在記憶體中儲存所有任務，
需要專案自行實現本地持續化儲存，重新進入App後的任務恢復等）

示例：

/**
 * 實現下載管理 AbstractDownloadMgr
 * Created by tsy on 2016/11/24.
 */

public class DownloadMgr extends AbstractDownloadMgr {

    private DownloadMgr(Builder builder) {
        super(builder);
    }

    /**
     * 初始進入app 恢復所有未完成的任務
     */
    @Override
    public void resumeTasks() {
        if(DEBUG) {
            Log.i(TAG, "start resumeTasks");
        }

        //獲取所有未完成的任務（已完成的不需要新增）
        DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
        ArrayList<Task> tasks = downloadInteractor.parseTask(downloadInteractor.getAllUnfinishedDownloadTasks());

        //將任務加到下載管理佇列中
        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);       //所有任務初始設定為暫停
                addTask(tasks.get(i));
            }

            downloadInteractor.pauseAllTask();
        }
    }

    /**
     * 儲存進度
     * @param taskId taskId
     * @param currentBytes 已經下載的bytes
     * @param totalBytes 總共bytes
     */
    @Override
    protected void saveProgress(String taskId, long currentBytes, long totalBytes) {
        DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
        downloadInteractor.updateProgress(taskId, currentBytes, totalBytes);
    }

    /**
     * 下載任務開始
     * @param taskId task id
     */
    @Override
    protected void onTaskStart(String taskId) {
        DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
        downloadInteractor.startTask(taskId);
    }

    /**
     * 下載任務暫停
     * @param taskId task id
     */
    @Override
    protected void onTaskPause(String taskId) {
        DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
        downloadInteractor.pauseTask(taskId);
    }

    /**
     * 下載任務完成
     * @param taskId task id
     */
    @Override
    protected void onTaskFinish(String taskId) {
        DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
        downloadInteractor.finishTask(taskId);
    }

    /**
     * 下載任務失敗
     * @param taskId task id
     */
    @Override
    protected void onTaskFail(String taskId) {
        //失敗設定為暫停 允許使用者再次嘗試開始
        DownloadContract.Interactor downloadInteractor = new DownloadInteractor();
        downloadInteractor.pauseTask(taskId);
    }

    //實現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)       //設定最大同時下載數量（不設定預設5）
                .saveProgressBytes(50 * 1024)  //設定每50kb觸發一次saveProgress儲存進度 （不能在onProgress每次都儲存 過於頻繁） 不設定預設50kb
                .build();複製程式碼

2.10.3 恢復本地儲存的所有未完成的任務

mDownloadMgr.resumeTasks();複製程式碼

2.10.4 建立一個下載任務

DownloadMgr.Task task = new DownloadMgr.Task();
task.setTaskId(mDownloadMgr.genTaskId());       //生成一個taskId
task.setUrl("xxxxx");   //下載地址
task.setFilePath("xxxxxxx");    //下載後檔案儲存位置
task.setCompleteBytes(1234L);       //設定已完成的bytes （用於恢復任務時新增，如果新新增的任務不需要設定該欄位）
task.setDefaultStatus(DownloadMgr.DEFAULT_TASK_STATUS_START);       //任務新增後開始狀態 如果不設定 預設任務新增後就自動開始

mDownloadMgr.addTask(task);複製程式碼

2.10.5 開始 暫停任務

mDownloadMgr.startTask("taskId");

mDownloadMgr.pauseTask("taskId");複製程式碼

2.10.6 頁面新增下載監聽

PS：不要使用匿名類，會造成記憶體洩露。在onStart或者onResume時初始化監聽，在onStop或者onPause時銷燬監聽

@Override
public void onResume() {
    super.onResume();

    //每次顯示頁面的時候加上監聽
    mDownloadTaskListener = new DownloadTaskListener() {
        @Override
        public void onStart(String taskId, long completeBytes, long totalBytes) {
            //開始下載
        }

        @Override
        public void onProgress(String taskId, long currentBytes, long totalBytes) {
            //下載進度

            //建議使用handler延遲重新整理下載進度 不然過於頻繁重新整理
            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) {
            //下載失敗
        }
    };

    //加入監聽
    mDownloadMgr.addListener(mDownloadTaskListener);
}

@Override
public void onPause() {

    //釋放監聽 防止記憶體洩露
    mDownloadMgr.removeListener(mDownloadTaskListener);
    mDownloadTaskListener = null;

    super.onPause();
}複製程式碼

3 結尾

具體實現在程式碼中有小Demo。再次附上Github地址：
github.com/tsy12321/My…

2017-01-06更新

1 增加本地持久化cookie => PersistentCookieJar

設定cookie.

//設定開啟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格式引數請求

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優先
        .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);
            }
        });複製程式碼

相關文章