Retrofit+RxJava网络请求详解实战
前言
Retrofit是目前主流的网络请求框架,功能强大,操作便捷。
RxJava是实现异步操作的库。可在线程间快速切换,同时提供许多操作符,使一些复杂的操作代码变得清晰有条理。
两者结合使用后,使得网络请求更加简洁,尤其在嵌套请求等特殊场景大有作为。
本文侧重于介绍Retrofit网络请求,以及它是如何结合RxJava使用的。还没了解过RxJava的建议先到上面贴出的参考地址学习,以便更好明白两者结合的过程。
文章篇幅较长,因为希望尽可能涵盖常用、实用的模块。
demo以及文章中的RxJava部分,已从1.x更新到2.x。
介绍
下面通过配置,请求,异常处理,生命周期管理,失败重试,监听进度,封装,混淆这几个部分来介绍。
1. 配置
1.1 添加依赖
1.2 开启Log日志
开启后,则可以在Log日志中看到网络请求相关的信息了,如请求地址,请求状态码,返回的结果等。
Log日志截图
1.3 开启Gson转换
开启后,会自动把请求返回的结果(json字符串)自动转化成与其结构相符的实体。
1.4 采用Rxjava
1.5 设置基础请求路径BaseUrl
1.6 设置请求超时
1.7 设置缓存
1.8 设置header
可统一设置
也可在请求方法中单独设置
1.9 设置https访问
现在不少服务器接口采用了https的形式,所以有时就需要设置https访问。
下面列举“客户端内置证书”时的配置方法,其他方式请参考 http://blog.csdn.net/dd864140130/article/details/52625666
getSSLSocketFactory()方法如下:
1.10 综合前面的配置
配置后得到的retrofit变量用于后面发起请求。
2. 请求
2.1 创建API接口
定义一个接口,在其中添加具体的网络请求方法。
请求方法的格式大致如下:
@其他声明
@请求方式("请求地址")
Observable<请求返回的实体> 请求方法名(请求参数);
或者
@其他声明
@请求方式
Observable<请求返回的实体> 请求方法名(@Url String 请求地址,请求参数);
第一种格式中的请求地址,填写基础请求路径baseUrl后续的部分即可,当然填写完整地址也是可以的。
第二种格式中的请求地址,需填写完整的地址。
下面列举Get请求、Post请求、文件上传、文件下载的接口定义。
其中HttpResult是自定义的、与后台返回的json数据结构相符的实体。
Get请求
请求参数逐个传入
请求参数一次性传入(通过Map来存放key-value)
以上两种方式,请求参数是以“?key=vale%key=value...”方式拼接到地址后面的,假如你需要的是以"/value"的方式拼接到地址后面(restful模式?),那么可以通过@Path注解来实现:
Post请求
请求参数逐个传入
请求参数一次性传入(通过Map来存放参数名和参数值)
上传文本+文件
1)上传单个文本和单个文件
第一个参数用于传文本,
--- @Part("textKey")中的"textKey"为文本参数的参数名。
--- RequestBody textBody为文本参数的参数值,生成方式如下:
RequestBody textBody = RequestBody.create(MediaType.parse("text/plain"), text);第二个参数用于传文件,
--- @Part("fileKey"; filename="test.png")
其中的"fileKey"为文件参数的参数名(由服务器后台提供)
其中的"test.png"一般是指你希望保存在服务器的文件名字,传入File.getName()即可--- RequestBody fileBody为文件参数的参数值,生成方法如下:
RequestBody fileBody = RequestBody.create(MediaType.parse("image/png"), file);
(这里文件类型以png图片为例,所以MediaType为"image/png",
不同文件类型对应不同的type,具体请参考http://tool.oschina.net/commons)
2)上传多个文本和多个文件(通过Map来传入)
第一个参数用于传文本,
Map的key为String,内容请参考上方“上传文本和单个文件”中@Part()里的值。
Map的value值为RequestBody,内容请参考上方“上传文本和单个文件”中RequestBody的生成。第二个参数用于传文件,
Map的key为String,内容请参考上方“上传文本和单个文件”中@Part()里的值。
Map的value值为RequestBody,内容请参考上方“上传文本和单个文件”中RequestBody的生成。
3)另外补充多一种上传方式(2018/07/16),以上传多个文本和多个文件为例
MultipartBody 的生成方式如下:
下载文件
(目前使用@Streaming进行下载的话,需添加Log拦截器(且LEVEL为BODY)才不会报错,但是网上又说添加Log拦截器后进行下载容易OOM,
所以这一块还很懵,具体原因也不清楚,有知道的朋友可以告诉下我)
2.2 发起请求
完成前面说的的配置和请求接口的定义后,就可以发起请求了。
普通请求、上传请求:
下载请求:
3. 异常处理
使用Retrofit+RxJava发起请求后,如果请求失败,会回调observer中的onError方法,该方法的参数为Throwable,并没能反馈更直接清楚的异常信息给我们,所以有必要对Throwable异常进行处理转换。
处理后得到ResponeThrowable,里面包含了异常码code 和 异常描述信息message,这样就可以方便地知道请求失败的原因了。
4. 生命周期管理
4.1 意义
如果页面发起了网络请求并且在请求结果返回前就已经销毁了,那么我们应该在它销毁时把相关的请求终止。一方面是为了停止无意义的请求,另一方面是为了避免可能带来的内存泄漏。
强大的RxJava可以帮助我们实现这一需求。下面通过 takeUntil、PublishSubject、综合两者进行控制 三个部分来讲解如何实现。
4.2 takeUntil
RxJava中提供了许多操作符,这里我们需要使用takeUntil操作符。
ObservableA.takeUntil(ObservableB) 的作用是:
监视ObservableB,当它发射内容时,则停止ObservableA的发射并将其终止。
下面通过示意图和示例代码来加深了解,参考自https://zhuanlan.zhihu.com/p/21966621
示意图:
takeUntil
示例代码:
示例代码大意:
ObservableA每隔300ms发射一个数字(并打印出发射的数字),ObservableB每隔800ms发射一个数字。
由于ObservableB在800ms时发射了内容,终止了ObservableA的发射,所以ObservableA最后只能发射0,1两个数字。
因此,我们可以利用takeUntil这一特性,让ObservableA负责网络请求,让ObservableB负责在页面销毁时发射事件,从而终止ObservableA(网络请求)。
4.3 PublishSubject
上面提到了需要一个ObservableB来负责在页面销毁时发射事件,PublishSubject就能充当这一角色。
阅读PublishSubject的源码可以发现,它既可充当Observable,拥有subscribe()等方法;也可充当Observer(Subscriber),拥有onNext(),onError等方法。
它的特点是进行subscribe()订阅后,并不立即发射事件,而是允许我们在认为合适的时机通过调用onNext(),onError(),onCompleted()来发射事件。
所以,我们需在Activity或Fragment的生命周期onDestroy()中通过PublishSubject来发射事件
4.4 进行控制
了解 takeUntil 和 PublishSubject 后,就可以综合两者来实现生命周期的控制了。
还有其他方式可以实现生命周期的控制,具体实现可到以下地址查看:
http://www.jianshu.com/p/d62962243c33
http://mp.weixin.qq.com/s/eedFDMIQe30rQmryLeif_Q
5.失败重试机制
有时候用户的网络比较不稳定,出现了请求失败的情况。这时我们不一定就要直接反馈用户请求失败,而可以在失败后尝试重新请求,说不定这时网络恢复稳定请求成功了呢?! 这样或许可以提高用户体验。
下面介绍如何设置某个请求在失败后自动进行重试,以及设置重试的次数、延迟重试的时间。
先上代码:
分析:
通过observableNet.retryWhen(new RetryFunction(3,3))加入失败重试机制,其参数RetryFunction中的apply方法会返回一个Observable,后面就称它为ObservableRetry吧。
加入后,当网络请求失败时,并不会直接回调observer中的onError,而是会先将失败异常throwable作为ObservableRetry的事件源。如果ObservableRetry通过onNext发射了事件,则触发重新请求,而如果ObservableRetry发射了onError/onComplete通知,则该请求正式结束。因此可以我们对apply方法中的throwableObservable进行改造,然后返回一个合适的ObservableRetry来实现自己想要的重试效果。代码中对throwableObservable进行了flatMap操作,目的是对其事件throwable的类型进行判断。如果为UnknownHostException类型,则表示无网络DNS解析失败,这时就没必要进行重试(都没网络还重试啥呀),直接通过Observable.error(throwable)结束该次请求。
然后通过全局变量 retryCount 和 retryCountMax 来控制重试的次数。重试retryCountMax次之后如果还是失败,那就通过Observable.error(throwable)放弃重试并结束请求。
代码中还有个方案二,与方案一的区别在于使用zip操作符来控制重试的次数。
了解过zip的应该知道其产生的ObservableZip发射的事件总量,与组合成员中事件量少的一致。所以我们通过Observable.range(start, count)发射有限的事件,如range(1, 3)只发射"1","2","3"三个事件,从而限制了ObservableZip最终发射的事件总量不大于3,即重试的次数不超过3次。当超过3次的时候,它会隐式地调用onComplete来结束该次请求(方案一是通过显式地调用onError来结束请求,而我需要在observer的onError中反馈给用户请求失败,所以选择了方案一)
6.监听进度
这里只讲下实现步骤思路,代码太多就不放上来了,大家可以直接看DevRing/Demo里的代码,基本参考自JessYan的ProgressManager库
6.1 上传进度
自定义请求实体,继承RequestBody重写其几个必要的方法。
其中监听上传进度主要是重写其writeTo(BufferedSink sink)方法,从该方法中获取数据总量以及已写入请求实体的数据量,在这里通过回调传递相关进度。自定义拦截器,实现Interceptor的intercept(Chain chain)方法。
通过该方法将第1步定义的请求实体应用到请求中。添加拦截器到OkHttpClient中。
builder.addNetworkInterceptor(progressInterceptor);
6.2 下载进度
思路和上传进度差不多
自定义响应实体,继承ResponseBody重写其几个必要的方法。
其中监听下载进度主要是重写其source(Source source)方法,从该方法中获取数据总量以及已写入响应实体的数据量,在这里通过回调传递相关进度。自定义拦截器,实现Interceptor的intercept(Chain chain)方法。
通过该方法将第1步定义的响应实体应用到请求中。添加拦截器到OkHttpClient中。
builder.addNetworkInterceptor(progressInterceptor);
7. 封装
(2018.3.27:Demo已对封装这一块做了新的调整,详情请看demo,但封装的思路还是和下文差不多的)
封装分为 初始化配置、统一转换、请求结果封装、请求回调(Observer)封装 四个部分进行。
7.1 初始化配置
7.2 统一转换
由于每次请求都要进行线程切换以及生命周期的控制,频繁地调用以下代码
因此可以使用compose方法对Observable进行统一的转换
7.3 封装请求结果
服务器返回的请求结果,一般分为三个部分:请求结果的状态值,请求结果的描述,返回的数据内容。
其中status和message的类型是固定的,而data的类型不确定,所以data可以采用泛型表示
豆瓣接口返回的结构比较特殊,并不是上面所说的那三部分。实际结构根据服务器后台给的来定
7.4 封装请求回调(Observer)
(DevRing中提供了三种封装好的Observer,分别用于普通请求,上传请求(可监听进度),下载请求(可监听进度))
可对Observer封装一层,作用:
在onError中进行统一的异常处理,得到更直接详细的异常信息
在onNext中进行统一操作,如请求回来后,先判断token是否失效,如果失效则直接跳转登录页面
在onNext中对返回的结果进行处理,得到更直接的数据信息
在onSubscribe中进行请求前的操作,注意,onSubscribe是执行在 subscribe() 被调用时的线程,所以如果在onSubscribe里进行UI操作,就要保证subscribe()也是调用在UI线程里。
到此,封装算是结束了,这样使用起来就会便捷很多,整个的使用流程会在下面的“使用”中介绍,也可以查看demo。
8. 混淆
在proguard-rules.pro文件中添加以下内容进行混淆配置
使用
经过前面的配置和封装后,下面演示一下在实际场景的使用。
1. 一般场景
请求正在上映的电影,然后在View层展示
2. 特殊场景
由于没找到相符的接口,所以demo中没有提供以下代码。就当作提供个思路,请谅解。
2.1 嵌套请求(使用flatMap实现)
场景:先请求token,再根据得到的token请求用户信息,最后在View层展示
2.2 组合请求返回的结果(使用zip实现)
场景:请求今日最佳男歌手,请求今日最佳女歌手,将男歌手和女歌手进行组合,得到“最佳歌手组合”,最后在View层展示
实际开发中肯定还有其他的特殊场景,关键是运用好RxJava的操作符。操作符的学习地址已贴在文章顶部。
更新:
已将demo和文章中关于Rxjava的部分从1.x改为2.x
这里贴一下RxJava2与RxJava1的区别总结(随笔记录,仅供参考):
RxJava2 按是否可以背压处理,分成Observable和Flowable,Observable的订阅者为Observer,Flowable的订阅者为Subscriber。
不了解背压的可以看这个系列的5-9篇。背压处理
1)上游(Flowable)通过emitter.requested()查看事件容器的剩余空间。下游(Subscriber)通过subscription.request(n)从事件容器中请求并消耗事件(消耗一个事件并不代表事件容器立刻多出一个位置)
2)四种策略 BUFFER,ERROR,DROP,LATEST
Buffer:事件容器的空间不限制,非Buffer策略时事件容器大小为128
ERROR:当事件容器溢出时会报MissingBackpressureException。该策略下,当下游累计消耗完96个事件后,才会给事件容器腾出96个位置。
DROP: 事件容器装入128个事件后,剩下的将不会装入,当下游累计消耗完128个事件后,才会给事件容器腾出128个位置,这时再取当前时刻发送的事件装入。
LATEST: 与DROP类似,但它会保证取到最后发射的事件Observable多了几个小伙伴:Single、Completable、Maybe。他们都继承了ObservableSource。
Single/SingleObserver:只发送/接收onNext和onError,且只发送一次
Completable/Completable:只发送/接收onComplete和onError
Maybe:Single与Completable的结合Func1改为Function,Func2..n改为BiFunction。其中的方法call改成了apply。另外对于filter()过滤,其参数为不为Function而是Predicate
Action1改为Consumer,Action2改为BiConsumer。其中的方法call改成了accept。
Observer/Subscriber的抽象方法中多了一个onSubscribe(Disposable/Subscription),类似1.x的onStart方法,它在subscribe()时调用。其中的参数Disposable/Subscription可以用来取消订阅/查询订阅状态,Subscription还可用于背压中请求消耗事件。
不再能发送null事件,Observable<Void> 不再发射任何值,而是正常结束或者抛出空指针。
评论