什么是分层
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的思维导图概览
返回的数据:统一的回调
回调采用抽象类的形式,而不是接口的形式
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) {}
自定义请求时的一些参数
没什么好说的,直接看图,清晰明了
一个请求示例
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,主要是因为比较习惯回调模式,这种模式下,代码的聚合度比较高.
