okhttp post php,OkHttp封装进阶-MyOkHttp

最新推荐文章于 2023-05-30 16:25:50 发布

weixin_35982673

最新推荐文章于 2023-05-30 16:25:50 发布

阅读量138

点赞数

文章标签： okhttp post php

本文详细介绍了如何对Okhttp3进行二次封装，增加了POST、GET、PATCH、PUT、DELETE等多种请求方法，支持上传下载文件、取消请求、后台下载管理及Raw/Json/Gson响应格式。通过Builder模式优化了参数传递，提供了一套方便的链式调用API。同时，实现了下载管理器，支持断点续传、下载队列管理等功能，还提供了本地持久化存储下载任务的示例代码。

摘要由CSDN通过智能技术生成

对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 如何添加

在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 回调格式

现在回调格式有以下几种:

Raw原生数据 RawResponseHandler

Json JsonResponseHandler

Gson GsonResponseHandler

2.8 调用示例

2.8.1 POST请求 + Json回调示例

String url = "http://192.168.2.135/myokhttp/post.php";

Map 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() {

@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 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 结尾

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);

}

});

weixin_35982673

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
okhttp post php,OkHttp封装进阶-MyOkHttp

对Okhttp3进行二次封装,对外提供了POST请求、GET请求、PATCH请求、PUT请求、DELETE请求、上传文件、下载文件、取消请求、Raw/Json/Gson返回、后台下载管理等功能1 前言之前的一篇文章 Android架构系列-封装自己的okhttp 对okhttp进行了一个简单的封装，具有POST、GET、上传下载功能和JSON、GSON格式返回。升级版MyOkHttp进行了重构并增...
复制链接

扫一扫