Param param = Param.get(“http://…”)
//设置是否对Param对象修饰,即是否添加公共参数,默认为true
.setAssemblyEnabled(false); //设为false,就不会回调上面的静态接口
到这,也许你们会有疑问,Param
是什么东东,下面就为大家讲解。
Param
首先,我们来看看如何发送一个请求
Param param = Param.get(“http://…”)
.add(“key”, “value”);
Disposable disposable = HttpSender.from(param)
.subscribe(s -> { //这里的s为String类型,即Http请求的返回结果
//成功回调
}, throwable -> {
//失败回调
});
疑问:说好的一条链发送请求呢?别着急,还没到放大招的时候
到这,我可以告诉大家,Param
承担的是一个请求体的一个角色,我们通过Param
可以确定请求方式(如:Get、Post、Put、Delete等请求方式)、添加请求参数、添加请求头、添加File对象等;然后通过HttpSender,传入Param
对象,将请求发送出去。
HttpSender
到这,有人又有疑问,前面初始化、设置公共参数都用到了HttpSender,这里发送请求又用到了HttpSender ,那么它又是承担怎么样的一个角色呢?看名字,我们可以理解为它就是一个请求发送者,通过一个from
操作符,传入一个Param
对象,然后返回一个RxJava
的Observable
对象,此时,我们就可以使用RxJava强大的操作符去处理相关的逻辑(这就是简介说的,做到了与RxJava的无缝链接),在这,我们只是使用了subscribe
操作符去订阅观察者。
RxHttp
现在,我们正式放大招,标题说好的一条链发送请求,既然吹牛了,就要去实现它。拿上面的例子,看看我们如何一条链实现,上代码
RxHttp.get(“http://…”)
.add(“key”, “value”)
.from()
.subscribe(s -> { //这里的s为String类型,即Http请求的返回结果
//成功回调
}, throwable -> {
//失败回调
});
我们的主角RxHttp终于登场了,可以看到使用RxHttp类我们就实现了一条链完成请求的发送,那它又是承担一个什么角色呢?我们暂时可以理解为RxHttp=Param+HttpSender
,并且还有自己特殊的使命。至于什么使用,后面会讲解。
我们现在来解疑惑,为什么我们的库叫RxHttp
,但是初始化、设置公共参数等却用HttpSender?因为RxHttp
这个类不在RxHttp库中,它是通过注解处理器生成的类。前面我们看到gradle依赖时,使用了
annotationProcessor ‘com.rxjava.rxhttp:rxhttp-compiler:1.0.1’
该注解处理器的目的就是在项目中生成RxHttp类,那为何不直接把它写到库里面去呢?前面讲过,因为它有自己的使命,而这个使命,在RxHttp库里无法完成。
接下来,我们来看看,如何发送Post请求、如何在Activity/Fragment销毁时,自动关闭为完成的请求、如何上传/下载文件及进度的监听、如何把Http返回的结果自动解析成我们想要的对象。
注:
以下讲解均使用RxHttp
Post
RxHttp.postForm(“http://…”)
.add(“key”, “value”)
.from()
.subscribe(s -> { //这里的s为String类型,即Http请求的返回结果
//成功回调
}, throwable -> {
//失败回调
});
可以看到,跟上面的Get请求只有一点不同,Get是RxHttp.get
,而Post是RxHttp.postForm
,除此之外,没有任何区别,我们在看来来,RxHttp都有哪些静态方法供我们选择请求方式
可以看到,默认提供了10个静态方法供我们选择具体的请求方式,有Get、Post、Put等,而Post等又分为postForm和postJson,这个好理解,前者是发送表单形式的post请求,后者是发送json字符串的post请求。
现实中,这些默认的请求方式显然不能满足我们的需求,如:我要发送加密的post请求,这个时候该怎么办呢?此时就需要我们自定义请求方式。
Activity 销毁,自动关闭未完成的请求
上面的案例中,在Activity/Fragment销毁时,如果请求还未完成,就会造成Activity/Fragment 无法回收,导致内存泄漏。这是非常严重的问题,那么RxHttp
是如何解决的呢?此时,就要引入我自己写的另一个库RxLife
2F%2Fgithub.com%2Fliujingxing%2FRxLife),直接看看如何使用
RxHttp.postForm(“http://…”)
.add(“key”, “value”)
.from()
.as(RxLife.as(this)) //订阅观察者前,加上这句话即可
.subscribe(s -> {
//成功回调
}, throwable -> {
//失败回调
});
//或者
RxHttp.postForm(“http://…”)
.add(“key”, “value”)
.from()
.as(RxLife.asOnMain(this)) //asOnMain 可以在主线程回调观察者
.subscribe(s -> {
//成功回调
}, throwable -> {
//失败回调
});
这里的this
为LifecycleOwner
对象,它是一个接口,这里我们传入的是Activity,因为Activity实现了LifecycleOwner
接口。当Activity/Fragment销毁时,会将RxJava的管道中断,管道中断时,又会将未完成的请求自动关闭。 在下面的讲解中,我们均会使用RxLife
文件上传/下载及进度监听
使用RxHttp
,可以很优雅的实现文件上传/下载及进度的监听,如何优雅?直接上代码
文件上传
RxHttp.postForm(“http://…”) //发送Form表单形式的Post请求
.add(“key”, “value”)
.add(“file1”, new File(“xxx/1.png”)) //添加file对象
.add(“file2”, new File(“xxx/2.png”))
.from() //from操作符,是异步操作
.as(RxLife.asOnMain(this)) //感知生命周期,并在主线程回调
.subscribe(s -> {
//成功回调
}, throwable -> {
//失败回调
});
可以看到,文件上传跟普通的post请求其实没啥区别,无非就是在post请求的基础上,调用add方法添加要上传的文件对象。
文件下载
//文件存储路径
String destPath = getExternalCacheDir() + “/” + System.currentTimeMillis() + “.apk”;
RxHttp.get(“http://update.9158.com/miaolive/Miaolive.apk”)
.download(destPath) //注意这里使用download操作符,并传入本地路径
.as(RxLife.asOnMain(this)) //感知生命周期,并在主线程回调
.subscribe(s -> {
//下载成功,回调文件下载路径
}, throwable -> {
//下载失败
});
下载跟普通请求不同的是,下载使用的是download
操作符,其它都一样。
文件下载进度监听
//文件存储路径
String destPath = getExternalCacheDir() + “/” + System.currentTimeMillis() + “.apk”;
RxHttp.get(“http://update.9158.com/miaolive/Miaolive.apk”)
.downloadProgress(destPath) //注:如果需要监听下载进度,使用downloadProgress操作符
.observeOn(AndroidSchedulers.mainThread())
.doOnNext(progress -> {
//下载进度回调,0-100,仅在进度有更新时才会回调,最多回调101次,最后一次回调文件存储路径
int currentProgress = progress.getProgress(); //当前进度 0-100
long currentSize = progress.getCurrentSize(); //当前已下载的字节大小
long totalSize = progress.getTotalSize(); //要下载的总字节大小
String filePath = progress.getResult(); //文件存储路径,最后一次回调才有内容
})
.filter(Progress::isCompleted)//下载完成,才继续往下走
.map(Progress::getResult) //到这,说明下载完成,返回下载目标路径
.as(RxLife.as(this)) //感知生命周期
.subscribe(s -> {//s为String类型,这里为文件存储路径
//下载完成,处理相关逻辑
}, throwable -> {
//下载失败,处理相关逻辑
});
下载进度的监听我们稍微看一下 ,首先一点,下载使用download
操作符,而下载进度监听使用downloadProgress
操作符,随后,我们使用了doOnNext
操作符处理进度回调,注意这里是仅当有进度更新时,才会回调,其中的progress
变量是一个Progress
类型的对象,我们贴上源码:
public class Progress {
private int progress; //当前进度 0-100
private long currentSize;//当前已完成的字节大小
private long totalSize; //总字节大小
private T mResult; //http返回结果,上传/下载完成时调用
//省略get/set方法
}
由于进度回调会执行101次(上面注释有解释),而最下面观察者其实是不需要关心这么多事件的,只需要关心最后下载完成的事件,所以使用了filter
操作符过滤事件,只要还未下载完成,就将事件过滤调,不让往下走。最终下载完成后,拿到本地下载路径。
文件上传进度监听
RxHttp.postForm(“http://www…”) //发送Form表单形式的Post请求
.add(“file1”, new File(“xxx/1.png”))
.add(“file2”, new File(“xxx/2.png”))
.add(“key1”, “value1”)//添加参数,非必须
.add(“key2”, “value2”)//添加参数,非必须
.addHeader(“versionCode”, “100”) //添加请求头,非必须
.uploadProgress() //注:如果需要监听上传进度,使用uploadProgress操作符
.observeOn(AndroidSchedulers.mainThread()) //主线程回调
.doOnNext(progress -> {
//上传进度回调,0-100,仅在进度有更新时才会回调,最多回调101次,最后一次回调Http执行结果
int currentProgress = progress.getProgress(); //当前进度 0-100
long currentSize = progress.getCurrentSize(); //当前已上传的字节大小
long totalSize = progress.getTotalSize(); //要上传的总字节大小
String result = progress.getResult(); //Http执行结果,最后一次回调才有内容
})
.filter(Progress::isCompleted)//过滤事件,上传完成,才继续往下走
.map(Progress::getResult) //到这,说明上传完成,拿到Http返回结果并继续往下走
.as(RxLife.as(this)) //感知生命周期
.subscribe(s -> { //s为String类型,由SimpleParser类里面的泛型决定的
//上传成功,处理相关逻辑
}, throwable -> {
//上传失败,处理相关逻辑
});
事件,上传完成,才继续往下走
.map(Progress::getResult) //到这,说明上传完成,拿到Http返回结果并继续往下走
.as(RxLife.as(this)) //感知生命周期
.subscribe(s -> { //s为String类型,由SimpleParser类里面的泛型决定的
//上传成功,处理相关逻辑
}, throwable -> {
//上传失败,处理相关逻辑
});