近期我完成了Volley以及OkHttp的二次封装，对于为什么要二次封装，以及这个过程中遇到的一些问题，在这里谈谈我的想法，与大家交流。
首先贴出我二次封装好的两个框架的地址：
@简书：
BaseVolley： https://www.jianshu.com/p/5697b25bba32
BaseOkHttp： https://www.jianshu.com/p/20d5ba4aeecb
@Github：
BaseVolley： https://github.com/kongzue/BaseVolley
BaseOkHttp： https://github.com/kongzue/BaseOkHttp
Volley的二次封装
最早我封装的是Volley框架，封装的原因也很简单，原始的Volley在设置请求参数以及Header请求头的时候很麻烦，需要重写以下两个方法来实现：
@Override
protected Map<String, String> getParams() throws AuthFailureError {
return params;
}
@Override
public Map<String, String> getHeaders() throws AuthFailureError {
return headers;
}
一个标准的Volley请求大概也是这个样子的：
public RequestQueue mQueue;
...
mQueue = Volley.newRequestQueue(this); //创建请求队列
...
StringRequest stringRequest = new StringRequest(Request.Method.POST,
"http://www.xxx.com/",
new Response.Listener<String>() {
@Override
public void onResponse(String response) {
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
}
}){
@Override
protected Map<String, String> getParams() throws AuthFailureError {
Map<String, String> map = new HashMap<String, String>();
map.put("key1", value1);
map.put("key2", value2);
return map;
}
};
mQueue.add(stringRequest);
也就意味着，一个标准的Volley请求需要先预设好请求队列，然后设置请求类型（Request.Method.GET/Request.Method.POST），然后写请求成功监听器、请求失败监听器以及可选重写请求参数及Header头，最后还要把。相信如果初步接触Volley肯定对此一脸懵逼，十分繁琐，那么从这个角度我就在想，这个过程是否可以精简省略？
- 首先，我们可以定义一个全局的请求队列；
- 然后，POST、GET请求提供不同的方法而不需要每次都传入标记参数来进行设置；
- 能否不再使用不支持流水线写法的Map来进行参数和Header头设置？
- 最好能不用重写的办法，更轻松的设置参数
- 我经常在发起请求前在UI界面上创建一个ProgressDialog之类的提示请求正在进行并阻止用户操作，那么我能否不需要重复地在Response.Listener和onErrorResponse都设置让ProgressDialog.dismiss();操作的代码，以简化代码？
基于上述原因，我对Volley进行了二次封装，具体效果如下所示：
HttpRequest.getInstance(me)
//自定义请求Header头部信息（选用）
.setHeaders(new Parameter()
.add("Charset", "UTF-8")
.add("Content-Type", "application/json")
.add("Accept-Encoding", "gzip,deflate")
)
//发送请求
.postRequest("http://www.xxx.com/test", new Parameter()
.add("key1", "value1")
.add("key2", "value3")
.add("key4", "value4"),
new ResponseListener() {
@Override
public void onResponse(JSONObject main, Exception error) {
//关闭进度对话框
progressbarDialog.dismiss();
//处理返回数据逻辑
if (error == null) {
//请求成功处理
} else {
//请求失败处理
Toast.makeText(me, "网络错误，请重试", Toast.LENGTH_SHORT);
}
}
});
具体变更如下：
- 单例化的HttpRequest创建请求，其中包含了全局的请求队列；
- 使用Parameter代替Map，但其本质上是TreeMap，支持了流水线写法；
- postRequest()与getRequest() 分别对应POST请求和GET请求，再也不需要传请求类型的参数了；
- 统一的返回方法，直接一个if判断Exception是否为空即可知道请求是否成功，同时可以做无论成功与否的请求结束的都需要执行的事情，减少代码重复量；
- 返回数据默认已转为JSONObject 方便使用，至于为什么不使用JsonObjectRequest做底层，其原因是部分服务端不支持Json格式的请求参数类型以及JsonObjectRequest在请求Body为空时会出现请求参数也丢失的问题；
- 可选setHeaders添加请求头；
- 支持创建HTTPS请求方法：HttpRequest.getInstance(me,"ssl.crt")；
- 方便Debug，在项目的BuildConfig.DEBUG为true时，请求url、参数、返回等数据会十分规范地打印在Logcat中，具体效果如下：
request:http://www.xxx.com
parameter:custom=1&id=b5866dbad8c46282&open=0
response:{"status":1,"msg":"这是测试返回消息","data":""}
由此，就完成了Volley的基本封装完成，极大程度上精简了操作逻辑，满足日常开发需要。
OkHttp的二次封装
因项目需要，我又对OkHttp进行了二次封装，此次封装基本保持思想与BaseVolley完全一致，但提供了更多的工具类，例如图片下载以及多文件表单提交上传的方法。
制作OkHttp的主要原因如下：
- Volley更适合于多并发但本身请求不大的情况，但遇到多文件表单提交、下载等事务时并不合适，那么就应该交给更合适的OkHttp来做这样的事情；
- 封装的接口基本保持与BaseVolley统一，但OkHttp本身采用了流水线式代码设计，要修改兼容我们的表层接口就需要剥离其关键类Builder；
- 使用异步请求时，OkHttp返回数据在异步线程中，需要转到主线程处理UI，封装时最好在请求结束时自动回到主线程以方便后续处理；
基于以上问题和原因，我对OkHttp进行了二次封装，除了请求方法、方式以及处理结果基本和BaseVolley保持一致外，还提供了额外的图片下载工具ImageRequest以及多文件上传MultiFileRequest工具类来处理相应事务，之后我还会继续添加更多的新工具方便使用。
结尾
以上就是目前二次封装Volley以及OkHttp的一点想法，如果本文对您有所帮助麻烦点个赞，如有疑问欢迎在评论区留言交流。
另外，觉得不错劳烦Star或Fork下BaseVolley或BaseOkHttp的Github，感激不尽！
网友评论