关于二次封装Volley以及OkHttp的一点想法

近期我完成了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肯定对此一脸懵逼,十分繁琐,那么从这个角度我就在想,这个过程是否可以精简省略?

  1. 首先,我们可以定义一个全局的请求队列;
  2. 然后,POST、GET请求提供不同的方法而不需要每次都传入标记参数来进行设置;
  3. 能否不再使用不支持流水线写法的Map来进行参数和Header头设置?
  4. 最好能不用重写的办法,更轻松的设置参数
  5. 我经常在发起请求前在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);
                        }
                    }
                });

具体变更如下:

  1. 单例化的HttpRequest创建请求,其中包含了全局的请求队列;
  2. 使用Parameter代替Map,但其本质上是TreeMap,支持了流水线写法;
  3. postRequest()与getRequest() 分别对应POST请求和GET请求,再也不需要传请求类型的参数了;
  4. 统一的返回方法,直接一个if判断Exception是否为空即可知道请求是否成功,同时可以做无论成功与否的请求结束的都需要执行的事情,减少代码重复量;
  5. 返回数据默认已转为JSONObject 方便使用,至于为什么不使用JsonObjectRequest做底层,其原因是部分服务端不支持Json格式的请求参数类型以及JsonObjectRequest在请求Body为空时会出现请求参数也丢失的问题;
  6. 可选setHeaders添加请求头;
  7. 支持创建HTTPS请求方法:HttpRequest.getInstance(me,"ssl.crt");
  8. 方便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的主要原因如下:

  1. Volley更适合于多并发但本身请求不大的情况,但遇到多文件表单提交、下载等事务时并不合适,那么就应该交给更合适的OkHttp来做这样的事情;
  2. 封装的接口基本保持与BaseVolley统一,但OkHttp本身采用了流水线式代码设计,要修改兼容我们的表层接口就需要剥离其关键类Builder;
  3. 使用异步请求时,OkHttp返回数据在异步线程中,需要转到主线程处理UI,封装时最好在请求结束时自动回到主线程以方便后续处理;

基于以上问题和原因,我对OkHttp进行了二次封装,除了请求方法、方式以及处理结果基本和BaseVolley保持一致外,还提供了额外的图片下载工具ImageRequest以及多文件上传MultiFileRequest工具类来处理相应事务,之后我还会继续添加更多的新工具方便使用。

结尾

以上就是目前二次封装Volley以及OkHttp的一点想法,如果本文对您有所帮助麻烦点个赞,如有疑问欢迎在评论区留言交流。
另外,觉得不错劳烦Star或Fork下BaseVolley或BaseOkHttp的Github,感激不尽!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,589评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,615评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,933评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,976评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,999评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,775评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,474评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,359评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,854评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,007评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,146评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,826评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,484评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,029评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,153评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,420评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,107评论 2 356

推荐阅读更多精彩内容