基于retrofit的网络框架的终极封装(一):第一层参数组装层的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();复制代码

代码

github.com/hss01248/Ne…

#附图:总体层次图

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