基于retrofit的网络框架的终极封装(一):第一层(参数组装层)的API设计

includecmath 发布于2019-06-25 10:55 / 1829人阅读

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

什么是分层

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 params,Map files, MyNetListener callback)

你说还有很常见的拉取网络图片并显示在imageview中?

那就是图片加载框架的事儿了,不应该交给网络框架处理.推荐fresco,以及我的这个FrescoUtils.

以上api的思维导图概览

返回的数据:统一的回调

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

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

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


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

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

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

public  void onSuccessArr(List 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) {}

自定义请求时的一些参数

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

一个请求示例

            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() {
                        @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,主要是因为比较习惯回调模式,这种模式下,代码的聚合度比较高.

混合云 idc机房托管基于防火墙技术的校园网络安全设计与实现基于webrtc的框架有哪些基于php的网站设计基于webrtc的视频会议系统的设计与实现

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/13370.html

基于retrofit的网络框架的终极封装(二)-与retrofit的对接与解耦,以及遇到的坑

摘要：在上一篇基于的网络框架的终极封装一中介绍了顶层的设计这里再沿着代码走向往里说由于这里讲的是的封装性使用所以一些基础性的使用和配置这里就不讲了参数怎么传递到层的所有网络请求相关的参数和配置全部通过第一层的和链式调用封装到了中最后在方法中调用层在上一篇基于retrofit的网络框架的终极封装(一)中介绍了顶层api的设计.这里再沿着代码走向往里说.由于这里讲的是retrofit的封装性使...

isLishude 2019-06-25 10:54 评论0 收藏0
Xutils, OKhttp, Volley, Retrofit对比

摘要：就是使用进行操作。不过设计的初衷本身也就是为频繁的数据量小的网络请求而生。是公司出品的默认基于封装的一套网络请求框架，是目前流行的一套设计的风格，并不是标准。所以这两个库相比，更有优势，在能掌握两个框架的前提下该优先使用。Xutils这个框架非常全面，可以进行网络请求，可以进行图片加载处理，可以数据储存，还可以对view进行注解，使用这个框架非常方便，但是缺点也是非常明显的，使用这个项目，会...

Alliot 2019-04-23 15:32 评论0 收藏0
android优秀文章合集 - 收藏集 - 掘金

摘要：系统的架构实现拖拽排序和侧滑删除掘金在平时开发应用的时候，经常会遇到列表排序滑动删除的需求。基于使用与一致掘金，当你的项目中用到了，同时又有跨界面的响应式需求，而又嫌麻烦不想再添加更多的库，则可以使用这个库，使用方法与相同。 Android 优秀文章和开源库推荐（读值得读的） - Android - 掘金文章： 1. Android AOP之字节码插桩详解文章从AOP的概念出发，介绍...

Terry_Tai 2019-06-25 11:30 评论0 收藏0
Android框架 - 收藏集 - 掘金

摘要：说好的分类集合来啦，采用标签云的方式来展示掘金阅读提示点击下文中返回到顶部有分类不合理的地方请提。反编译这个后发现其使用个优质的开源项目掘金是由的开源的一个库，用于构建可预期的和声明式的用户界面。想不想通过一线互联网公司面试？ - Android - 掘金国内一线互联网公司内部面试题库以下面试题来自于百度、小米、乐视、美团、58、猎豹、360、新浪、搜狐内部题库熟悉本文中列出的知...

zengdongbao 2019-08-14 18:34 评论0 收藏0
Android框架 - 收藏集 - 掘金

摘要：说好的分类集合来啦，采用标签云的方式来展示掘金阅读提示点击下文中返回到顶部有分类不合理的地方请提。反编译这个后发现其使用个优质的开源项目掘金是由的开源的一个库，用于构建可预期的和声明式的用户界面。想不想通过一线互联网公司面试？ - Android - 掘金国内一线互联网公司内部面试题库以下面试题来自于百度、小米、乐视、美团、58、猎豹、360、新浪、搜狐内部题库熟悉本文中列出的知...

awesome23 2019-06-25 11:16 评论0 收藏0