Android開源-對Okhttp3進行二次封裝

LucienneCra 8年前發布 | 60K 次閱讀 OkHttp 安卓開發 Android開發移動開發

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

1 前言

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

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

所有請求全部優化為了Builder模式傳參（方便參數擴展）
請求增加addHeader可以添加請求頭
增加PATCH、PUT、DELETE請求方法
增加下載管理后臺，包括斷點續傳、下載隊列管理功能等

2 使用說明

2.1 創建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.2 調用方式

整個調用采用鏈式調用的方式. 方便以后擴展.

2.3 請求類型

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

2.4 添加參數方式

添加參數可以使用addParam一個個添加, 也可以使用params一次性添加

2.5 添加Header方式

添加參數可以使用addHeader一個個添加, 也可以使用headers一次性添加

2.6 回調格式

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

Raw原生數據 RawResponseHandler
Json JsonResponseHandler
Gson GsonResponseHandler

2.7 調用示例

2.7.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.7.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.7.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.7.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.7.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.8 取消請求(建議放在BaseActivity,BaseFragment的onDestroy中)

mMyOkhttp.cancel(this);     //tag 即之前請求時傳入的tag 建議直接將頁面作為object傳入

2.9 下載管理

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

2.9.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.9.2 項目開始時初始化唯一實例DownloadMgr 并自定義配置

mDownloadMgr = (DownloadMgr) new DownloadMgr.Builder()
                .myOkHttp(mMyOkhttp)
                .maxDownloadIngNum(5)       //設置最大同時下載數量（不設置默認5）
                .saveProgressBytes(50 * 1024)  //設置每50kb觸發一次saveProgress保存進度 （不能在onProgress每次都保存 過于頻繁） 不設置默認50kb
                .build();

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

mDownloadMgr.resumeTasks();

2.9.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.9.5 開始暫停任務

mDownloadMgr.startTask("taskId");

mDownloadMgr.pauseTask("taskId");

2.9.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();
}

本文由用戶 LucienneCra 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。

轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。

本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！

本文地址：http://www.baiduhome.net/lib/view/open1481093410439.html

OkHttp 安卓開發 Android開發移動開發