Android 一个改善的okHttp封装库

布满荆棘的人生 2024-02-17 17:10 65阅读 0赞

### 一、概述 ###

之前写了篇[Android OkHttp完全解析 是时候来了解OkHttp了][Android OkHttp_ _OkHttp]，其实主要是作为okhttp的普及文章，当然里面也简单封装了工具类，没想到关注和使用的人还挺多的，由于这股热情，该工具类中的方法也是剧增，各种重载方法，以致于使用起来极不方便，实在惭愧。

于是，在这个周末，抽点时间对该工具类，进行了重新的拆解与编写，顺便完善下功能，尽可能的提升其使用起来的方便性和易扩展性。

标题的改善，也是指的是对于我之前的代码进行改善。

如果你对okhttp不了解，可以通过[Android OkHttp完全解析 是时候来了解OkHttp了][Android OkHttp_ _OkHttp]进行了解。

ok，那么目前，该封装库志支持：

*  一般的get请求
 *  一般的post请求
 *  基于Http的文件上传
 *  文件下载
 *  上传下载的进度回调
 *  加载图片
 *  支持请求回调，直接返回对象、对象集合
 *  支持session的保持
 *  支持自签名网站https的访问，提供方法设置下证书就行
 *  支持取消某个请求

源码地址：[https://github.com/hongyangAndroid/okhttp-utils][https_github.com_hongyangAndroid_okhttp-utils]

--------------------

引入：

* Android Studio
 
 使用前，对于Android Studio的用户，可以选择添加:
 
 <code class="hljs scss has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-radius: 0px; word-wrap: normal; background: transparent;">compile project(':okhttputils')</code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li></ul>
 
 或者
 
 <code class="hljs bash has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-radius: 0px; word-wrap: normal; background: transparent;">compile 'com.zhy:okhttputils:2.0.0'</code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li></ul>
 * Eclipse
 
 自行copy源码。

### 二、基本用法 ###

目前基本的用法格式为：

通过链式去根据自己的需要添加各种参数，最后调用execute(callback)进行执行，传入callback则代表是异步。如果单纯的execute()则代表同步的方法调用。

可以看到，取消了之前一堆的get重载方法，参数也可以进行灵活的选择了。

下面简单看一下，全部的用法：

#### （1）GET请求 ####

#### （2）POST请求 ####

#### （3）Post String ####

<code class="hljs avrasm has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-radius: 0px; word-wrap: normal; background: transparent;">OkHttpUtils
 .postString()
 .url(url)
 .content(new Gson().toJson(new User("zhy", "123")))
 .build()
 .execute(new MyStringCallback()); </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li></ul>

将string作为请求体传入到服务端，例如json字符串。

#### （4）Post File ####

<code class="hljs avrasm has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-radius: 0px; word-wrap: normal; background: transparent;">OkHttpUtils
 .postFile()
 .url(url)
 .file(file)
 .build()
 .execute(new MyStringCallback());</code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li></ul>

将file作为请求体传入到服务端.

#### （5）基于POST的文件上传（类似web上的表单） ####

#### （6）下载文件 ####

#### （7）显示图片 ####

哈，目前来看，清晰多了。

### 三、对于上传下载的回调 ###

对于传入的callback有个inProgress方法，需要拿到进度直接复写该方法即可。

### 四、对于自动解析为实体类 ###

目前去除了Gson的依赖，提供了自定义Callback的方式，让用户自己去解析返回的数据，目前提供了`StringCallback`，`FileCallback`,`BitmapCallback` 分别用于返回string，文件下载，加载图片。

当然如果你希望解析为对象，你可以：

自己使用自己喜欢的Json解析库完成即可。

解析成`List<User>`，则如下：

<code class="hljs php has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-radius: 0px; word-wrap: normal; background: transparent;">public abstract class ListUserCallback extends Callback<List<User>>
 {
 @Override
 public List<User> parseNetworkResponse(Response response) throws IOException
 {
 String string = response.body().string();
 List<User> user = new Gson().fromJson(string, List.class);
 return user;
 }
 
 
 }</code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li><li style="box-sizing: border-box; padding: 0px 5px;">7</li><li style="box-sizing: border-box; padding: 0px 5px;">8</li><li style="box-sizing: border-box; padding: 0px 5px;">9</li><li style="box-sizing: border-box; padding: 0px 5px;">10</li><li style="box-sizing: border-box; padding: 0px 5px;">11</li><li style="box-sizing: border-box; padding: 0px 5px;">12</li></ul>

### 五、对于https单向认证 ###

非常简单，拿到xxx.cert的证书。

然后调用

<code class="language-xml hljs has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-radius: 0px; word-wrap: normal; background: transparent;">
 OkHttpUtils.getInstance()
 .setCertificates(inputstream);</code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li></ul>

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

即可。别忘了注册Application。

注意：如果https网站为权威机构颁发的证书，不需要以上设置。自签名的证书才需要。

### 六、配置 ###

#### （1）全局配置 ####

可以在Application中，通过：

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

例如：

#### （2）为单个请求设置超时 ####

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

调用build()之后，可以随即设置各种timeOut.

#### （3）取消单个请求 ####

#### （4）根据tag取消请求 ####

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

例如：在Activity中，当Activity销毁取消请求：

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-radius: 0px; word-wrap: normal; background: transparent;">OkHttpUtils
 .get()//
 .url(url)//
 .tag(this)//
 .build()//
 
 @Override
 protected void onDestroy()
 {
 super.onDestroy();
 //可以取消同一个tag的
 OkHttpUtils.cancelTag(this);//取消以Activity.this作为tag的请求
 }</code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li><li style="box-sizing: border-box; padding: 0px 5px;">7</li><li style="box-sizing: border-box; padding: 0px 5px;">8</li><li style="box-sizing: border-box; padding: 0px 5px;">9</li><li style="box-sizing: border-box; padding: 0px 5px;">10</li><li style="box-sizing: border-box; padding: 0px 5px;">11</li><li style="box-sizing: border-box; padding: 0px 5px;">12</li><li style="box-sizing: border-box; padding: 0px 5px;">13</li></ul>

比如，当前Activity页面所有的请求以Activity对象作为tag，可以在onDestory里面统一取消。

### 七、浅谈封装 ###

其实整个封装的过程比较简单，这里简单描述下，对于okhttp一个请求的流程大致是这样的：

其中主要的差异，其实就是request的构建过程。

我对Request抽象了一个类：`OkHttpRequest`

<code class="language-java hljs has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-radius: 0px; word-wrap: normal; background: transparent;">public abstract class OkHttpRequest
 {
 protected RequestBody requestBody;
 protected Request request;
 
 protected String url;
 protected String tag;
 protected Map<String, String> params;
 protected Map<String, String> headers;
 
 protected OkHttpRequest(String url, String tag,
 Map<String, String> params, Map<String, String> headers)
 {
 this.url = url;
 this.tag = tag;
 this.params = params;
 this.headers = headers;
 }
 
 protected abstract Request buildRequest();
 protected abstract RequestBody buildRequestBody();
 
 protected void prepareInvoked(ResultCallback callback)
 {
 requestBody = buildRequestBody();
 requestBody = wrapRequestBody(requestBody, callback);
 request = buildRequest();
 }
 
 protected RequestBody wrapRequestBody(RequestBody requestBody, final ResultCallback callback)
 {
 return requestBody;
 }
 
 
 public void invokeAsyn(ResultCallback callback)
 {
 prepareInvoked(callback);
 mOkHttpClientManager.execute(request, callback);
 }
 
 
 // other common methods
 } 
 </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li><li style="box-sizing: border-box; padding: 0px 5px;">7</li><li style="box-sizing: border-box; padding: 0px 5px;">8</li><li style="box-sizing: border-box; padding: 0px 5px;">9</li><li style="box-sizing: border-box; padding: 0px 5px;">10</li><li style="box-sizing: border-box; padding: 0px 5px;">11</li><li style="box-sizing: border-box; padding: 0px 5px;">12</li><li style="box-sizing: border-box; padding: 0px 5px;">13</li><li style="box-sizing: border-box; padding: 0px 5px;">14</li><li style="box-sizing: border-box; padding: 0px 5px;">15</li><li style="box-sizing: border-box; padding: 0px 5px;">16</li><li style="box-sizing: border-box; padding: 0px 5px;">17</li><li style="box-sizing: border-box; padding: 0px 5px;">18</li><li style="box-sizing: border-box; padding: 0px 5px;">19</li><li style="box-sizing: border-box; padding: 0px 5px;">20</li><li style="box-sizing: border-box; padding: 0px 5px;">21</li><li style="box-sizing: border-box; padding: 0px 5px;">22</li><li style="box-sizing: border-box; padding: 0px 5px;">23</li><li style="box-sizing: border-box; padding: 0px 5px;">24</li><li style="box-sizing: border-box; padding: 0px 5px;">25</li><li style="box-sizing: border-box; padding: 0px 5px;">26</li><li style="box-sizing: border-box; padding: 0px 5px;">27</li><li style="box-sizing: border-box; padding: 0px 5px;">28</li><li style="box-sizing: border-box; padding: 0px 5px;">29</li><li style="box-sizing: border-box; padding: 0px 5px;">30</li><li style="box-sizing: border-box; padding: 0px 5px;">31</li><li style="box-sizing: border-box; padding: 0px 5px;">32</li><li style="box-sizing: border-box; padding: 0px 5px;">33</li><li style="box-sizing: border-box; padding: 0px 5px;">34</li><li style="box-sizing: border-box; padding: 0px 5px;">35</li><li style="box-sizing: border-box; padding: 0px 5px;">36</li><li style="box-sizing: border-box; padding: 0px 5px;">37</li><li style="box-sizing: border-box; padding: 0px 5px;">38</li><li style="box-sizing: border-box; padding: 0px 5px;">39</li><li style="box-sizing: border-box; padding: 0px 5px;">40</li><li style="box-sizing: border-box; padding: 0px 5px;">41</li><li style="box-sizing: border-box; padding: 0px 5px;">42</li><li style="box-sizing: border-box; padding: 0px 5px;">43</li><li style="box-sizing: border-box; padding: 0px 5px;">44</li><li style="box-sizing: border-box; padding: 0px 5px;">45</li></ul>

一个request的构建呢，我分三个步骤：`buildRequestBody` , `wrapRequestBody` ,`buildRequest`这样的次序，当以上三个方法没有问题时，我们就拿到了request，然后执行即可。

但是对于不同的请求，requestBody以及request的构建过程是不同的，所以大家可以看到`buildRequestBody` ,`buildRequest`为抽象的方法，也就是不同的请求类，比如`OkHttpGetRequest`、`OkHttpPostRequest`等需要自己去构建自己的request。

对于`wrapRequestBody`方法呢，可以看到它默认基本属于空实现，主要是因为并非所有的请求类都需要复写它，只有上传的时候呢，需要回调进度，需要对requestBody进行包装，所以这个方法类似于一个钩子。

其实这个过程有点类似模板方法模式，有兴趣可以看看一个短篇介绍[设计模式 模版方法模式 展现程序员的一天][Link 1] .

对于更加详细的用法，可以查看github上面的readme，以及demo，目前demo包含：

![20151109094247142][]

对于上传文件的两个按钮，需要自己搭建服务器，其他的按钮可以直接测试。

最后，由于本人水平有限，以及时间比较仓促~~发现问题，欢迎提issue，我会抽时间解决。 have a nice day ~

[源码点击下载][https_github.com_hongyangAndroid_okhttp-utils]

[Android OkHttp_ _OkHttp]: http://blog.csdn.net/lmj623565791/article/details/47911083
[https_github.com_hongyangAndroid_okhttp-utils]: https://github.com/hongyangAndroid/okhttp-utils
[Link 1]: http://blog.csdn.net/lmj623565791/article/details/26276093
[20151109094247142]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/ba4aa6a92cdb4b15a60c3620da42eb01.png