Android-对Okhttp3进行二次封装

# MyOkhttp [](https://www.apache.org/licenses/LICENSE-2.0) [ ](https://bintray.com/tangsiyuan/maven/myokhttp/_latestVersion) > 对Okhttp3进行二次封装,对外提供了POST请求、GET请求、PATCH请求、PUT请求、DELETE请求、上传文件、下载文件、取消请求、Raw/Json/Gson返回、后台下载管理等功能. ## 版本更新记录 [版本更新记录](https://github.com/tsy12321/MyOkHttp/releases) ## 文章推荐 对于Okhttp3的封装参考了: 1. [https://github.com/hongyangAndroid/okhttputils](https://github.com/hongyangAndroid/okhttputils) 1. [https://github.com/ZhaoKaiQiang/OkHttpPlus](https://github.com/ZhaoKaiQiang/OkHttpPlus) ## 如何添加 ### 在app目录下的build.gradle中添加依赖 ```gradle compile 'com.tsy:myokhttp:1.1.1' ``` ## 1 总体简介 在项目入口创建唯一MyOkhttp实例 ```java MyOkHttp mMyOkhttp = new MyOkHttp(); ``` 也可以自行配置OkhttpClient. ```java OkHttpClient okHttpClient = new OkHttpClient.Builder() .connectTimeout(10000L, TimeUnit.MILLISECONDS) .readTimeout(10000L, TimeUnit.MILLISECONDS) //其他配置 .build(); MyOkHttp mMyOkhttp = new MyOkHttp(okHttpClient); ``` ### 1.1 调用方式 整个调用采用链式调用的方式. 方便以后扩展. ### 1.2 请求类型 现在有Get, Post, Patch, Put, Delete, Upload, Download 这些请求方式 ### 1.3 添加参数方式 添加参数可以使用addParam一个个添加, 也可以使用params一次性添加 ### 1.4 添加Header方式 添加参数可以使用addHeader一个个添加, 也可以使用headers一次性添加 ### 1.5 回调格式 现在回调格式有以下几种: 1. Raw原生数据 RawResponseHandler 1. Json JsonResponseHandler 1. Gson GsonResponseHandler ## 2 调用示例 ### 2.1 POST请求 + Json回调示例 ```java 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 JSONObject:" + response); } @Override public void onSuccess(int statusCode, JSONArray response) { Log.d(TAG, "doPost onSuccess JSONArray:" + response); } @Override public void onFailure(int statusCode, String error_msg) { Log.d(TAG, "doPost onFailure:" + error_msg); } }); ``` ### 2.2 GET请求 + Raw回调示例 ```java 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.3 Patch请求 + Json回调示例 ```java 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.4 Put请求 + Json回调示例 ```java String url = "http://192.168.2.135/myokhttp/put.php/id/5/name/tsy/age/15"; mMyOkhttp.put() .url(url) .tag(this) .enqueue(new JsonResponseHandler() { @Override public void onSuccess(int statusCode, JSONObject response) { Log.d(TAG, "doPut onSuccess:" + response); } @Override public void onFailure(int statusCode, String error_msg) { Log.d(TAG, "doPut onFailure:" + error_msg); } }); ``` ### 2.5 Delete请求 + Json回调示例 ```java String url = "http://192.168.2.135/myokhttp/delete.php/id/5"; mMyOkhttp.delete() .url(url) .tag(this) .enqueue(new JsonResponseHandler() { @Override public void onSuccess(int statusCode, JSONObject response) { Log.d(TAG, "doDelete onSuccess:" + response); } @Override public void onFailure(int statusCode, String error_msg) { Log.d(TAG, "doDelete onFailure:" + error_msg); } }); ``` ### 2.6 上传文件 + Gson回调示例 ```java 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 下载文件 ```java 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); } }); ``` ## 3 取消请求(建议放在BaseActivity,BaseFragment的onDestroy中) ```java mMyOkhttp.cancel(this); //tag 即之前请求时传入的tag 建议直接将页面作为object传入 ``` ## 4 下载管理 实现了下载管理的核心逻辑，包括添加下载任务、开始任务、暂停任务、删除任务、任务下载等待、下载进度和状态监听等功能。依赖于MyOkhttp ### 4.1 实现AbstractDownloadMgr 项目中创建DownloadMgr继承AbstractDownloadMgr，并实现下载任务的状态，进度的本地持久化保存。（AbstractDownloadMgr只负责在内存中存储所有任务， 需要项目自行实现本地持续化存储，重新进入App后的任务恢复等） 示例： ```java /** * 实现下载管理 AbstractDownloadMgr * Created by t