OkHttpUtils - 封装了okhttp的网络框架

注意

整合了Gson，提供了自定Callback，可以按照泛型，自行解析返回结果：

compile ‘com.android.support:support-annotations:23.1.1’

compile ‘com.zhy:okhttputils:2.0.0’

compile ‘com.google.code.gson:gson:2.5’

目前支持

---

• 一般的get请求

• 一般的post请求

• 基于Http Post的文件上传（类似表单）

• 多文件和多参数同时上传

• 大文件下载和下载进度回调

• 大文件上传和上传进度回调

• 支持session的保持

• 支持自签名网站https的访问，提供方法设置下证书就行

• 支持根据Tag取消请求

• 支持自定义泛型Callback，自动根据泛型返回对象

即将实现

---

• 统一的文件上传管理

• 统一的文件下载管理

• 采用线程池或者volley对普通请求进行管理

用法实现

---

1.普通的GET请求，根据泛型Bean返回值也是Bean

private void getJson() {

OkHttpUtils.get(“http://192.168.1.111:8080/UploadServer/ResponseJson”)//

.tag(this)//

.params(“ppppppp”, “ppp”)//

.headers(“hhhhhhh”, “hhh”)//

.execute(new MyBeanCallBack() {

@Override

public void onResponse(Bean bean) {

System.out.println(“onResponse:” + bean);

}

});

}

2.普通的POST请求，根据泛型Bean返回值也是Bean

private void responseJson() {

OkHttpUtils.post(“http://192.168.1.111:8080/UploadServer/ResponseJson”)//

.tag(this)//

.params(“ppppppp”, “ppp”)//

.headers(“hhhhhhh”, “hhh”)//

.execute(new MyBeanCallBack() {

@Override

public void onResponse(Bean bean) {

System.out.println(“onResponse:” + bean);

}

});

}

3.普通Post，直接上传String类型的文本

不建议这么用，该方法上传字符串会清空实体中其他所有的参数，但头信息不清除，例如本例中的 params 参数不会上传

private void postString() {

OkHttpUtils.post(“http://192.168.1.111:8080/UploadServer/UploadString”)//

.tag(this)//

.params(“ppppppp”, “ppp”)//

.headers(“hhhhhhh”, “hhh”)//

.content(“asdfasdfad这是文本这是文本aasfesr”)//

.mediaType(PostRequest.MEDIA_TYPE_PLAIN)//

.execute(new MyBeanCallBack() {

@Override

public void onResponse(String s) {

System.out.println(“onResponse:” + s);

}

});

}

如果要上传Json，把上面的 mediaType 改为 .mediaType(PostRequest.MEDIA_TYPE_JSON)

4.表单Post，同时上传多文件和多参数（推荐使用）

private void uploadFile() {

OkHttpUtils.post(“http://192.168.1.111:8080/UploadServer/UploadFile”)//

.tag(this)//

.headers(“aaa”, “111”)

.headers(“bbb”, “222”)

.params(“ccc”, “333”)

.params(“ddd”, “444”)

.params(“file1”, new File(Environment.getExternalStorageDirectory() + “/DCIM/Camera/IMG_20151225_155549.jpg”))//

.params(“file2”, new File(Environment.getExternalStorageDirectory() + “/DCIM/Camera/IMG_20160109_010308.jpg”))//

.params(“file3”, new File(Environment.getExternalStorageDirectory() + “/video/splash.avi”))//

.execute(new MyBeanCallBack() {

@Override

public void onResponse(String s) {

System.out.println(“onResponse:” + s);

}

});

}

其中文件的key，相当于表单中input type=“file” name="File1"的name属性。

5.下载文件，get和post都可以，这里使用post演示

OkHttpUtils.post(“http://192.168.1.111:8080/UploadServer/DownloadFile”)//

.tag(this)//

.params(“ppppppp”, “ppp”)//

.headers(“hhhhhhh”, “hhh”)//

.execute(new MyFileCallBack(Environment.getExternalStorageDirectory() + “/video”, “bbb.avi”) {

@Override

public void onResponse(File response) {

System.out.println(“onResponse:” + response);

}

});

6.根据tag取消请求

目前对于支持的方法都添加了最后一个参数Object tag，取消则通过OkHttpUtils.cancel(tag)执行。

例如：在Activity中，当Activity销毁取消请求，可以在onDestory里面统一取消。

@Override

protected void onDestroy() {

super.onDestroy();

OkHttpUtils.getInstance().cancelTag(this);

}

7.自定义CallBack

目前内部提供的包含BeanCallBack, StringCallBack, FileCallBack, BitmapCallback，可以根据自己的需求去自定义Callback。

其中BeanCallBack使用比较多，它支持传递一个泛型，将返回的Response对象解析成需要的类型并且返回，目前支持：

• 一般的 JavaBean

• 字符串 String

• 集合泛型 List< Bean >

• 集合泛型 Map< Bean >

以下是实现代码：

public abstract class BeanCallBack extends AbsCallback {

@Override

public T parseNetworkResponse(Response response) throws Exception {

Type type = this.getClass().getGenericSuperclass();

if (type instanceof ParameterizedType) {

//如果用户写了泛型，就会进入这里，否者不会执行

ParameterizedType parameterizedType = (ParameterizedType) type;

Type beanType = parameterizedType.getActualTypeArguments()[0];

if (beanType == String.class) {

//如果是String类型，直接返回字符串

return (T) response.body().string();

} else {

//如果是 Bean List Map ，则解析完后返回

return new Gson().fromJson(response.body().string(), beanType);

}

} else {

//如果没有写泛型，直接返回Response对象

return (T) response;

}

}

}

通过parseNetworkResponse回调的response进行解析，该方法运行在子线程，所以可以进行任何耗时操作。

8.上传下载的进度显示

public abstract class AbsCallback {

/** Post执行上传过程中的进度回调，get请求不回调，UI线程 */

public void upProgress(long currentSize, long totalSize, float progress) {

}

/** 执行下载过程中的进度回调，UI线程 */

public void downloadProgress(long currentSize, long totalSize, float progress) {

}

}

callback回调中有upProgress 和 downloadProgress 方法，直接复写即可，在 get 请求中， upProgress 方法不会执行。

9.同步的请求

Response response = OkHttpUtils.get(“http://www.baidu.com”)//

.tag(this)//

.headers(“aaa”, “111”)//

.params(“bbb”, “222”).execute();

execute方法不传入callback即为同步的请求，返回Response对象，需要自己解析。

10.全局配置

可以在Application中，通过：

try {

OkHttpUtils.debug(true, “MyOkHttp”);

OkHttpUtils.getInstance()//

.setConnectTimeout(OkHttpUtils.DEFAULT_MILLISECONDS)//

.setReadTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS)//

.setCertificates(new Buffer().writeUtf8(CER_12306).inputStream())//

.setWriteTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS);

} catch (Exception e) {

e.printStackTrace();

}

然后调用 OkHttpUtils 的各种set方法。

11.为单个请求设置超时

比如涉及到文件的需要设置读写等待时间多一点。

private void responseJsonArray() {

OkHttpUtils.post(“http://192.168.1.111:8080/UploadServer/ResponseJsonArray”)//

.tag(this)//

.connTimeOut(2000)

.writeTimeOut(3000)

.readTimeOut(4000)

.params(“ppppppp”, “ppp”)//

.headers(“hhhhhhh”, “hhh”)//

.execute(new MyBeanCallBack<List>() {

@Override

public void onResponse(List beans) {

System.out.println(“onResponse:” + beans);

}

});

}

12.自签名网站https的访问

非常简单，拿到xxx.cert的证书，然后调用：

OkHttpUtils.getInstance().setCertificates(inputstream);

建议使用方式，例如我的证书放在assets目录：

try {

OkHttpUtils.getInstance()

.setCertificates(getAssets().open(“srca.cer”), getAssets().open(“aaa.cer”))//

} catch (Exception e) {

e.printStackTrace();

}

本文参考：

https://my.oschina.net/u/2547914/blog/805033

https://github.com/jeasonlzy0216/OkHttpUtils

https://github.com/hongyangAndroid/okhttputils

https://github.com/pengjianbo/OkHttpFinal

详细用法：

public class MainActivity extends AppCompatActivity {

private Map<String,String> params;

private final static String URL = “”;

private File file = new File(“”);

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

Toolbar toolbar = (Toolbar) findViewById(R.id.toolbar);

setSupportActionBar(toolbar);

getJson();

}

private void getJson() {

if (params == null){

params = new HashMap<>();

}

/**

• get请求

*/

OkHttpUtils

.get()

.url(URL)

.addParams(“”,“”)

.addParams(“”,“”)

.build()

.execute(new StringCallback() {

@Override

public void onError(Request request, Exception e) {

}

@Override

public void onResponse(String response) {

}

});

/**

• post请求方式

*/

OkHttpUtils

.post()

.url(URL)

.addParams(“”, “”)

.addParams(“”, “”)

.build()

.execute(new StringCallback() {

@Override

public void onError(Request request, Exception e) {

}

@Override

public void onResponse(String response) {

}

});

/**

• 提交数据到服务器

*/

OkHttpUtils

.postString()

.url(URL)

.content(“”)

.build()

.execute(new StringCallback() {

@Override

public void onError(Request request, Exception e) {

}

@Override

public void onResponse(String response) {

}

});

/**

• 提交文件到服务器

*/

OkHttpUtils

.postFile()

.url(URL)

.file(file)

.build()

.execute(new StringCallback() {

@Override

最后

小编这些年深知大多数初中级Android工程师，想要提升自己，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、电子书籍、讲解视频，并且后续会持续更新

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人

都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

如果你需要这些资料， ⬅ 专栏获取
equest, Exception e) {

}

@Override

public void onResponse(String response) {

}

});

/**

• 提交文件到服务器

*/

OkHttpUtils

.postFile()

.url(URL)

.file(file)

.build()

.execute(new StringCallback() {

@Override

最后

小编这些年深知大多数初中级Android工程师，想要提升自己，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

[外链图片转存中…(img-QRFly5sR-1719249642459)]

[外链图片转存中…(img-zkT90iru-1719249642460)]

[外链图片转存中…(img-j66CKGbr-1719249642460)]

[外链图片转存中…(img-rHXhoJ2J-1719249642461)]

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、电子书籍、讲解视频，并且后续会持续更新

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人

都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

如果你需要这些资料， ⬅ 专栏获取