您的位置：首页 > 编程语言 > Java开发

Novate：Retrofit2.0和RxJava的又一次完美改进加强(Tamic博客 -CSDN)

2016-08-12 21:15 573 查看

作者/Tamic

http://blog.csdn.net/sk719887916/article/details/52195428

前言

用过RxJava和Retrofit的朋友，用久了就会发现Retrofit说难不难，说简不简，对于实际项目中，单纯的用Retrofit做请求库，开发起来还是很多不便，必须请求头和参数处理，API接口数目众多时的处理， Https证书验签，cookie持久，错误结果处理，统一操作加载过渡UI等，因此我对Retrofit再次进行了封装，一直关注我的朋友以前看我封装的《基于Retrofit2.0 封装的超好用的RetrofitClient工具类》的一文，已对Retrofit结合RxJava时遇到上面的问题进行了完整封装，但是不是Builder模式，因此感觉还是有点土，特此我进行了长达两个月Novate 框架的开发，

为何起名为Novate？

Novate的英文原意是用新事物代替，我开发目的是用新的东西来代替Retrofit的有些不易操作的地方，因此起名新奇的东西，所以结合了原来的Http用法习惯，又加入了Retrofit和RxJava的特性，因此起名：Novate

进行下文前请先了解Retrofit和Rxjava，不懂请移步：

系列导读：

Retrofit 2.0

超能实践(一)，完美支持Https传输-

Retrofit2.0，okHttp3

完美同步Cookie实现免登录(二)

Retrofit 2.0 超能实践（三），轻松实现文件/图片上传

Retrofit 2.0 超能实践（四），完成大文件断点下载

基于Retrofit2.0 +RxJava封装的超好用的RetrofitClient工具类

玩转IOC，教你徒手实现自定义的Retrofit框架

Novate 网络库：Retrofit2.0遇上RxJava和okhttp3

介绍

Novate的改进

优化设计：加入基础API，减少Api冗余

强大的缓存模式：支持离线缓存，无网络智能加载缓存，可配置是否需要缓存

cookie管理：自带cookie管理机制

全方位请求模式：支持多种方式访问网络（get,put, post ,delete）

轻送调用：支持表单,图文一起，json上传。

文件传输：支持文件下载和上传，支持进度

动态添加：支持请求头和参数统一添加，分别添加。

结果处理：支持对返回结果的统一处理，自动帮你序列化复杂的数据。

扩展性强：支持自定义的Retrofit的API，默认Api无法满足时可自定义自己的Service

悠雅方便：支持统一请求网络的过程的流程控制，以方便帮你完美加入Processbar进度。

RxJava结合：结合RxJava，线程智能控制。

效果

用法

基本构建:

Novate novate = new Novate.Builder(this)
.baseUrl(baseUrl)
.build();

除了基本的构建还提供更了其他API

构建你的header头和参数
Map<String, String> headers = new HashMap<>();
headers.put("apikey", "4545sdsddfd7sds");

Map<String, String> parameters = new HashMap<>();
parameters.put("uid", "878787878sdsd");

实例化：

Novate novate = new Novate.Builder(this)
.addParameters(parameters)
.connectTimeout(8)
.baseUrl("you api url")
.addHeader(headers)
.addLog(true)
.build();

novate = new Novate.Builder(this)
.addHeader(headers) //添加公共请求头
.addParameters(parameters)//公共参数
.connectTimeout(10)  //连接时间 可以忽略
.readTimeout(10)  //读取 可以忽略
.addCookie(false)  //是否同步cooike 默认不同步
.addCache(true)  //是否缓存 默认缓存
.addCache(cache, cacheTime)   //自定义缓存
.baseUrl("Url") //base URL
.addLog(true) //是否开启log
.cookieManager(new NovateCookieManager()) // 自定义cooike，可以忽略
.addInterceptor() // 自定义Interceptor
.addNetworkInterceptor() // 自定义NetworkInterceptor
.proxy(proxy) // 设置代理
.client(client)  //clent 默认不需要
.build();

如果你支持https需要接入证书：

novate.addSSL(hosts,  certificates)

怎么用？

准备证书文件数组和host 白名单；

int[] certificates = {R.raw.myssl1, R.raw.myssl2,......}

int[] hosts = {"https:// you hosturl2", "https:// you hosturl2",......}

还要说明？

certificates

是你的ssl证书文件的id，项目中请放到raw资源文件下,

myssl.cer

怎么生成, 请用pc浏览器自动导出证书，保存, 还不清楚的话，我会醉醉。

想对某个api不想缓存:

novate.addCache(false)

想对某个api不想cookie持久 :

novate.addCookie(false)

同样很多人想问我想对novate进行扩展，咋办？别担心，Novate也提供了以下方法：

novate.addInterceptor()
.addCallAdapterFactory()
.callFactory()
.proxy()
.client()

上面只是列举了几个简单的api，更多的还是沿用的Retrofit的方法名，Retrofit怎么使用，Novate就怎么用.

RxJava怎么处理？

observable.subscribeOn(Schedulers.io())
.unsubscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread());

内部统一已进行线程控制，所有请求都采用以上线程形式，无需你手动添加。

RxApi

主要处理请求的API,

包含RxGet, RxPost, RxDelete,RxPut, RxBody,RxFrom, RxUpLoad,RxDownLoad.

使用基本APi之前请阅读对RxCallBack的介绍。

RxGet

进行get方式的请求调用，多种返回结果的方式供你选择，返回不同的数据类型参考请看RxCallBack的介绍。

基础使用：

返回String

new Novate.Builder(this)
.baseUrl("http://ip.taobao.com/")
.build()
.rxGet("service/getIpInfo.php", parameters, new RxStringCallback() {

@Override
public void onStart(Object tag) {
super.onStart(tag);
}

@Override
public void onNext(Object tag, String response) {
}

@Override
public void onError(Object tag, Throwable e) {
}

@Override
public void onCancel(Object tag, Throwable e) {
}
});

返回Bean

novate.rxGet("path or url", parameters, new RxResultCallback<ResultModel>() {

});

返回List

new Novate.Builder(this)
.baseUrl("http://xxx.com/")
.build()
.rxGet("service/getList", parameters, new RxListCallback<List<MusicBookCategory>>() {
@Override
public void onNext(Object tag, int code, String message, List<MusicBookCategory> response) {

}

@Override
public void onError(Object tag, Throwable e) {

}

@Override
public void onCancel(Object tag, Throwable e) {

}
});

返回File

novate.rxGet("path or url", null, new RxFileCallBack(filePath, "name.jpg") {

});

RxPost：

进行Post方式的请求调用

返回String

novate.rxPost("path or url", parameters, new RxStringCallback() {

});

返回Bean

novate.rxPost("path or url", parameters, new RxResultCallback<ResultModel>() {

});

返回List

novate.rxPost("path or url", parameters, new RxListCallback<List<ResultModel>>() {

....

});

返回File

novate.rxPost("path or url", null, new RxFileCallBack(filePath, "name.jpg") {

});

RxUpLoad

以Body方式post数据，可以上报载文件，图片，多媒体文件等。

Novate提供了2种方式上传文件。body和part模式，Body不包含key值，part包含key值。

RxUploadWithBody

以Body方式post数据，可以上报文件，图片等。

String mPath = uploadPath; //"you File path ";
String url = "http:/xxx.com";

novate.rxUploadWithBody(url, new File(mPath), new RxStringCallback() {

@Override
public void onNext(Object tag, String response) {
}

@Override
public void onError(Object tag, Throwable e) {

}

@Override
public void onCancel(Object tag, Throwable e) {

}
});

}

RxUploadWithPart

上传文件，默认的key是 *image *

String mPath = uploadPath; //"you File path ";
String url = "http:/xxx.com";
File file = new File(mPath);
novate.rxUploadWithPart(url, file, new RxStringCallback() {

@Override
public void onError(Object tag, Throwable e) {
}

@Override
public void onCancel(Object tag, Throwable e) {

}

@Override
public void onNext(Object tag, String response) {
}

});

如果自定义key 请看下面

String mPath = uploadPath; //"you File path ";
String url = "http:/xxx.com";

File file = new File(mPath);
RequestBody requestFile = RequestBody.create(MediaType.parse("multipart/form-data; charset=utf-8"), file);

final NovateRequestBody requestBody = Utils.createNovateRequestBody(requestFile, new UpLoadCallback() {

@Override
public void onProgress(Object tag, int progress, long speed, boolean done) {

updateProgressDialog(progress);
}
});

MultipartBody.Part body2 =
MultipartBody.Part.createFormData("image", file.getName(), requestBody);
//请将image改成你和服务器约定好的key

novate.rxUploadWithPart(url, body2, new RxStringCallback() {
@Override
public void onError(Object tag, Throwable e) {
}

@Override
public void onCancel(Object tag, Throwable e) {

}

@Override
public void onNext(Object tag, String response) {
}

});

上传多文件：

rxUploadWithPartListByFile：

List<File> fileList = new ArrayList<>();
fileList.add(file);
fileList.add(file);
fileList.add(file);
novate.rxUploadWithPartListByFile(url, fileList, new RxStringCallback() {

@Override
public void onStart(Object tag) {
super.onStart(tag);
}

@Override
public void onNext(Object tag, String response) {
}

@Override
public void onError(Object tag, Throwable e) {
}

});

RxDownLoad

以get方式下载数据，可以下载文件，图片，多媒体文件。

使用rxGet()实现下载：

String downUrl = "http://wap.dl.pinyin.sogou.com/wapdl/hole/201512/03/SogouInput_android_v7.11_sweb.apk";

novate.rxGet(downUrl, parameters, new RxFileCallBack(FileUtil.getBasePath(this), "test.apk") {

@Override
public void onStart(Object tag) {
super.onStart(tag);
showPressDialog();
}

@Override
public void onNext(Object tag, File file) {
dismissProgressDialog();
}

@Override
public void onProgress(Object tag, float progress, long downloaded, long total) {
updateProgressDialog((int) progress);
}

@Override
public void onError(Object tag, Throwable e) {

}

@Override
public void onCancel(Object tag, Throwable e) {

}

@Override
public void onCompleted(Object tag) {
super.onCompleted(tag);

}
});

RxDown()下载

String downUrl = "http://wap.dl.pinyin.sogou.com/wapdl/hole/201512/03/SogouInput_android_v7.11_sweb.apk";
new Novate.Builder(this)
.baseUrl(baseUrl)
.build()
.rxDownload(downUrl, new RxFileCallBack() {
@Override
public void onStart(Object tag) {
super.onStart(tag);
showPressDialog();
}

@Override
public void onNext(Object tag, File file) {
dismissProgressDialog();
Toast.makeText(ExampleActivity.this, "下载成功!", Toast.LENGTH_SHORT).show();
}

@Override
public void onProgress(Object tag, float progress, long downloaded, long total) {
updateProgressDialog((int) progress);
}

@Override
public void onProgress(Object tag, int progress, long speed, long transfered, long total) {
super.onProgress(tag, progress, speed, transfered, total);
updateProgressDialog((int) progress);
}

@Override
public void onError(Object tag, Throwable e) {

}

@Override
public void onCancel(Object tag, Throwable e) {

}

@Override
public void onCompleted(Object tag) {
super.onCompleted(tag);
dismissProgressDialog();
}
});

Custom Api

以上方法默认会处理Novate自带的

BaseApiService

，如果默认的

BaseApiService

无法满足你的需求时，Novate同样支持你自己的ApiService。

定义一个你自己的API：

MyAPI

public interface MyAPI {

@GET("url")
Observable<MyBean> getdata(@QueryMap Map<String, String> maps);

}

Execute Call

通过novate提供

create()

实例化你的API

MyAPI myAPI = novate.create(MyAPI.class);

通过novate.call()来执行你的接口，你也不用关心，novate内部同样已进行RxJava线程控制。

novate.call(myAPI.getdata(parameters),
new BaseSubscriber<MyBean>(ExempleActivity.this) {

@Override
public void onError(Throwable e) {

}

@Override
public void onNext(MyBean MyBean) {
}
});

}

取消

每执行novate.xxx() 给上层返回了一个Subscription，上层可以调用unsubscribe()来进行取消！

if (!subscription.isUnsubscribed()) {
subscription.unsubscribe();
}

取消

每执行novate.xxx() 给上层返回了一个Subscription，上层可以调用unsubscribe()来进行取消！

注意

本框架自带视后端数据为：

{int code,  String message(msg), T data(result)}

如果你的API返回的数据格式不是上面的默认格式，若想用原生的数据，请用

RxStringCallback

, 或者

RxGenericsCallback

, 这很好的解决了数据格式不兼容问题。

感谢

感谢一直以来提供思路，和测试的朋友，不断提供建议和思路，让我不断完善novate,。有的人看过或者读过后觉得此框架定制化严重，也有的人觉得挺好，所以提供了可配置方案：

如果想改变返回数据走成功回调的流程，实际上也提供了动态化的方案, 上层的callback可以实现需要的rxcallback进行以下方式：

/**
* 子类可以复写 默认不做对后端的数据校验 子类指定自己的校验规则
*/
public boolean isReponseOk(Object tag, ResponseBody responseBody) {
//对原始数据处理 是否视为为成功
......
return 你的判断;
}

如果你觉得此框架的业务码和错误码定的太死，其实框架已提供定制化方案，比如可以在你的项目中Assets中修改config文件：

如果想用默认的成功状态码： 0，不成功为非0的情况，可忽略以下的配置文件。

{

"isFormat": "false",

"sucessCode": [

"1",

"0",

"1001"

],

"error": {

"1001": "网络异常"

}

}

如果不想对结果格式化检查，请将isFormat设置为：false.

如果需要修改sucessCode的成功业务，请将你的成功的业务码加入到sucessCode节点中，参考上面的做法。

错误码

需要对错误码进行自定义翻译，请配置相关error信息，具体可配置成：

`{
"isFormat": "false",
"sucessCode": [
"1",
"0",
"1001"
],
"error": {
"1001": "网络异常"，
"1002": "加入你的异常信息"
}
}

待开发

目前1.X并没有完全运用RxJava2.0的新特性，笔者以开始联合@一叶飘舟做兼容RxJava2.x的APi的工作, 目前Novate很遗憾无法为你提供压栈，背压式服务！

在连续异步多个api时，诸如指定序列请求网络的场景，大白话就是你要根据上一个api的返回值再执行下一个api的情况，Novate1.x只能是靠开发者在上层的成功回调中执行，如果是1.x是对retrofit的强化，那么novate2.x将是对RxJava2的运用强化。

结束

如果你对本框架有无法满足你的需求或有何更好的想法，请及时联系我进行交流！欢迎您的star.

如果第一时间交流请加QQ 1057531664 或者关注本人的微信公众号！

源码

GitHub:https://github.com/Tamicer/Novate/

作者/Tamic

http://blog.csdn.net/sk719887916/article/details/52195428

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签： 博客 api 网络库 retrofit rxjava

相关文章推荐

新的分享

章节导航