网络框架的封装(一):第一层参数组装层的API设计

什么是分层

app的架构,不管是MVC,MVP,MVVM,架构演变中,贯穿始终的概念都是分层和解耦.那么这个分层和解耦怎么体现出来?
简单地说就是,我这一层接收上一层的输入,上一层的你别管我怎么处理,我最终会给你一个输出/返回值,你完全不用理会我是怎么处理的,只要有输入,就会有输出,而且一般是通过一个简单的方法的调用来实现.

那么,对于app中常用的网络层来说,怎么样的封装才是最合理的?

我们的口号是:一行代码完成网络请求!

其实非常简单,看接口文档你就知道了怎么做了:就传那些个参数,返回就是那个json之类的.把接口文档转化为我们调用的一个方法,这网络层与上层的接口就可以说是设计好了.

最常见的字符流请求:

接口文档写了什么:(百度图片随便找的一个)

所以,我们网络层应该封装成这样一个方法:

传入:

请求方式,url路径,请求的参数key和值
注: 对于多个POST请求参数key-value,有的接口会定义成Map形式,有的会定义成Json形式.其实本质上都是一样的,都是在requestBody上POST一个字符串(字符流)出去,只不过前者的形式是a=4&t=5的形式,而后者是一个json形式.
总体上来讲,还是前者比较多见,毕竟参数拼接形式与GET请求一致,服务器端处理比较方便.

输出/返回:

对于返回字符流数据的情况,可以归纳为返回一个String对象,怎么处理就看具体情况了.

app中常见的是返回json格式的字符串.当然,一般app里需要的是解析好的javabean,那么网络框架接口应该能直接返回一个解析好的javabean.

当然,更进一步来看,大多数规范的api(看看各大api市场,比如聚合api之类的)返回的json格式都具备以下特点:

一般为三个字段,分别表示状态码,相关提示信息,以及一个用于携带数据的字段.(比如:{"code":0,"msg":"登录成功","data":{...}}).携带数据的字段可以携带任何类型的数据,null,数字,字符串,jsonObject,JsonArray都可以.
在这里,我把这种三个字段的json称为"标准格式的json"

封装好的方法:

getString(String url, Map map, MyNetListener listener)//get请求,返回一个string,拿到这个string
postString( String url,  Map map,  MyNetListener listener)

getCommonJson(String url, Map map, Class clazz, MyNetListener listener)//get请求,返回一个json,将整个json解析成javabean
postCommonJson(String url, Map map, Class clazz, MyNetListener listener)

getStandardJson(String url, Map map, Class clazz, MyNetListener listener)//get请求,返回一个标准格式的json
postStandardJson(String url, Map map, Class clazz, MyNetListener listener) //post请求,返回一个标准格式的json,通过传入的clazz,直接解析返回data字段的javabean

//如果参数以json形式发出,那么再调用方法setParamsAsJson()即可.

上传和下载

下载:

一般是GET请求,传入url.请求参数可有可无.最终下载得到一个文件(路径可预先指定),并且在下载的过程中有进度的回调.
注意: 我上面一层不需要知道你的什么网络流啊,断点下载啊,分片多线程下载之类的细节.

download(String url, String savedpath, MyNetListener callback)

上传

POST请求,传入url,请求参数,文件相关的key名,文件的地址,最终返回一个结果(成功或失败),并且在上传的过程中有进度回调.
同样的,上一层不需要知道里面具体的header设置啊,断点续传啊,分片上传之类的细节.
注意: http是支持多文件上传的.

upLoad(String url, Map<String,String> params,Map<String,String> files, MyNetListener callback)

你说还有很常见的拉取网络图片并显示在imageview中?
那就是图片加载框架的事儿了,不应该交给网络框架处理.推荐fresco,以及我的这个FrescoUtils.

以上api的思维导图概览

基本api.jpg

返回的数据:统一的回调

回调采用抽象类的形式,而不是接口的形式

public void onPreExecute() {}//统一的开始
public void onFinish(){}//统一的结束

public  void onEmpty(){}//内容为空时--一般用在返回空的jsonArray时([]).


//成功的几种情况:
public abstract void onSuccess(T response,String resonseStr);//主回调

public  void onSuccessArr(List<T> response,String resonseStr){}//主回调,需要时复写

public  void onSuccessObj(T response,String responseStr,String data,int code,String msg){
        onSuccess(response,responseStr);
}

public  void onSuccessArr(List<T> response, String responseStr, String data, int code, String msg){
    onSuccessArr(response,responseStr);
}

//失败的回调

public void onError(String msgCanShow) {}//主回调

 public void onUnFound() {
    onError("没有找到该内容");
}
public    void onUnlogin(){
    onError("您还没有登录");
}


 public void onCodeError(String msgCanShow,String hiddenMsg,int code) {
    if (TextUtils.isEmpty(msgCanShow)){
        onError("错误码为:"+code);
    }else {
        onError(msgCanShow);
    }
}

//进度回调
public void onProgressChange(long fileSize, long downloadedSize) {}

自定义请求时的一些参数

没什么好说的,直接看图,清晰明了

自定义设置的api.jpg

一个请求示例

            Map map8 = new HashMap<>();
            map8.put("versionName","1.0.0");
            map8.put("appType",0);
            MyNetApi.postStandardJson("http://app.xxtt.com:9090/app/appVersion/getLatestVersion",
                    map8, VersionInfo.class, new MyNetListener<VersionInfo>() {
                        @Override
                        public void onSuccess(VersionInfo response, String resonseStr) {
                            Logger.e(resonseStr);
                        }

                        @Override
                        public void onError(String msgCanShow) {
                            super.onError(msgCanShow);
                            Logger.e(msgCanShow);
                        }
                    })
                    .setParamsAsJson()
                    .setIsAppendToken(false)
                    .setCustomCodeValue(1,2,3)
                    .start();

代码

https://github.com/hss01248/NetWrapper

附图:整体层次图

ps.是的,我没有用逼格比较高的Rxjava,主要是因为比较习惯回调模式,这种模式下,代码的聚合度比较高.

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

推荐阅读更多精彩内容

  • AFHTTPRequestOperationManager 网络传输协议UDP、TCP、Http、Socket、X...
    Carden阅读 4,261评论 0 12
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,050评论 18 139
  • 点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 13,234评论 0 15
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,413评论 6 13
  • 今天中午陪孩子们一起看《龙猫》,感受什么是“富强、民主、和谐”。当看到小梅得知妈妈的病情恶化便抱着玉米棒向连大人都...
    枧文阅读 325评论 0 0