RxHttp：新一代Android网络请求神器，一条链发送各种请求

本文由 不怕天黑 授权投稿
原文链接&＃xff1a;https://juejin.im/post/5cbd267fe51d456e2b15f623

简介

RxHttp是基于OkHttp的二次封装&＃xff0c;并于RxJava做到无缝衔接&＃xff0c;一条链就能发送一个完整的请求。主要功能如下&＃xff1a;

gradle依赖

implementation &＃39;com.rxjava.rxhttp:rxhttp:1.0.5&＃39;//注解处理器&＃xff0c;生成RxHttp类&＃xff0c;即可一条链发送请求annotationProcessor &＃39;com.rxjava.rxhttp:rxhttp-compiler:1.0.5&＃39;//管理RxJava及生命周期&＃xff0c;Activity/Fragment 销毁&＃xff0c;自动关闭未完成的请求implementation &＃39;com.rxjava.rxlife:rxlife:1.0.5&＃39;
//注解处理器&＃xff0c;生成RxHttp类&＃xff0c;即可一条链发送请求
annotationProcessor &＃39;com.rxjava.rxhttp:rxhttp-compiler:1.0.5&＃39;
//管理RxJava及生命周期&＃xff0c;Activity/Fragment 销毁&＃xff0c;自动关闭未完成的请求
implementation &＃39;com.rxjava.rxlife:rxlife:1.0.5&＃39;


项目地址
https://github.com/liujingxing/RxHttp

初始化

//设置debug模式&＃xff0c;此模式下有日志打印HttpSender.setDebug(boolean debug)//非必须,只能初始化一次&＃xff0c;第二次将抛出异常HttpSender.init(OkHttpClient okHttpClient)//或者&＃xff0c;调试模式下会有日志输出HttpSender.init(OkHttpClient okHttpClient, boolean debug)
HttpSender.setDebug(boolean debug)
//非必须,只能初始化一次&＃xff0c;第二次将抛出异常
HttpSender.init(OkHttpClient okHttpClient)
//或者&＃xff0c;调试模式下会有日志输出
HttpSender.init(OkHttpClient okHttpClient, boolean debug)


此步骤是非必须的&＃xff0c;不初始化或者传入null即代表使用默认OkHttpClient对象。

疑问&＃xff1a;标题不是说好的是RxHttp&＃xff0c;这么用HttpSender做一些初始化呢&＃xff1f;这里先卖一个关子&＃xff0c;后面会解答

添加公共参数/头部及重新设置url

相信大多数开发者在开发中&＃xff0c;都遇到要为Http请求添加公共参数/请求头&＃xff0c;甚至要为不同类型的请求添加不同的公共参数/请求头&＃xff0c;为此&＃xff0c;RxHttp为大家提供了一个静态接口回调&＃xff0c;如下&＃xff0c;每发起一次请求&＃xff0c;此接口就会被回调一次&＃xff0c;并且此回调在子线程进行(在请求执行线程回调)

HttpSender.setOnParamAssembly(new Function() {    &＃64;Override    public Param apply(Param p) {         if (p instanceof GetRequest) {//根据不同请求添加不同参数        } else if (p instanceof PostRequest) {        } else if (p instanceof PutRequest) {        } else if (p instanceof DeleteRequest) {        }        //可以通过 p.getSimpleUrl() 拿到url更改后&＃xff0c;重新设置        //p.setUrl("");        return p.add("versionName", "1.0.0")//添加公共参数                .addHeader("deviceType", "android"); //添加公共请求头    }});
    &＃64;Override
    public Param apply(Param p) { 
        if (p instanceof GetRequest) {//根据不同请求添加不同参数
        } else if (p instanceof PostRequest) {
        } else if (p instanceof PutRequest) {
        } else if (p instanceof DeleteRequest) {
        }
        //可以通过 p.getSimpleUrl() 拿到url更改后&＃xff0c;重新设置
        //p.setUrl("");
        return p.add("versionName", "1.0.0")//添加公共参数
                .addHeader("deviceType", "android"); //添加公共请求头
    }
});


然后有些请求我们不希望添加公共参数/请求头&＃xff0c;RxHttp又改如何实现呢&＃xff1f;很简单&＃xff0c;发起请求前&＃xff0c;设置不添加公共参数&＃xff0c;如下&＃xff1a;

Param param &＃61; Param.get("http://...")        //设置是否对Param对象修饰&＃xff0c;即是否添加公共参数&＃xff0c;默认为true        .setAssemblyEnabled(false); //设为false&＃xff0c;就不会回调上面的静态接口
        //设置是否对Param对象修饰&＃xff0c;即是否添加公共参数&＃xff0c;默认为true
        .setAssemblyEnabled(false); //设为false&＃xff0c;就不会回调上面的静态接口


到这&＃xff0c;也许你们会有疑问&＃xff0c;Param 是什么东东&＃xff0c;下面就为大家讲解。

Param

首先&＃xff0c;我们来看看如何发送一个请求

Param param &＃61; Param.get("http://...")        .add("key", "value");Disposable disposable &＃61; HttpSender.from(param)        .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果           //成功回调        }, throwable -> {           //失败回调        });
        .add("key", "value");
Disposable disposable &＃61; HttpSender.from(param)
        .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果
           //成功回调
        }, throwable -> {
           //失败回调
        });


疑问&＃xff1a;说好的一条链发送请求呢&＃xff1f;别着急&＃xff0c;还没到放大招的时候

到这&＃xff0c;我可以告诉大家&＃xff0c;Param承担的是一个请求体的一个角色&＃xff0c;我们通过Param可以确定请求方式(如&＃xff1a;Get、Post、Put、Delete等请求方式)、添加请求参数、添加请求头、添加File对象等&＃xff1b;然后通过HttpSender&＃xff0c;传入Param对象&＃xff0c;将请求发送出去。

HttpSender

到这&＃xff0c;有人又有疑问&＃xff0c;前面初始化、设置公共参数都用到了HttpSender&＃xff0c;这里发送请求又用到了HttpSender ,那么它又是承担怎么样的一个角色呢&＃xff1f;看名字&＃xff0c;我们可以理解为它就是一个请求发送者&＃xff0c;通过一个from操作符&＃xff0c;传入一个Param对象&＃xff0c;然后返回一个RxJava的Observable对象&＃xff0c;此时&＃xff0c;我们就可以使用RxJava强大的操作符去处理相关的逻辑(这就是简介说的&＃xff0c;做到了与RxJava的无缝链接)&＃xff0c;在这&＃xff0c;我们只是使用了subscribe操作符去订阅观察者。

RxHttp

现在&＃xff0c;我们正式放大招&＃xff0c;标题说好的一条链发送请求&＃xff0c;既然吹牛了&＃xff0c;就要去实现它。拿上面的例子&＃xff0c;看看我们如何一条链实现&＃xff0c;上代码

  RxHttp.get("http://...")        .add("key", "value")        .from()          .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果           //成功回调        }, throwable -> {           //失败回调        });
        .add("key", "value")
        .from()  
        .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果
           //成功回调
        }, throwable -> {
           //失败回调
        });


我们的主角RxHttp终于登场了&＃xff0c;可以看到使用RxHttp类我们就实现了一条链完成请求的发送&＃xff0c;那它又是承担一个什么角色呢&＃xff1f;我们暂时可以理解为RxHttp&＃61;Param&＃43;HttpSender&＃xff0c;并且还有自己特殊的使命。至于什么使用&＃xff0c;后面会讲解。

我们现在来解疑惑&＃xff0c;为什么我们的库叫RxHttp&＃xff0c;但是初始化、设置公共参数等却用HttpSender&＃xff1f;因为RxHttp这个类不在RxHttp库中&＃xff0c;它是通过注解处理器生成的类。前面我们看到gradle依赖时&＃xff0c;使用了

annotationProcessor &＃39;com.rxjava.rxhttp:rxhttp-compiler:1.0.5&＃39;


该注解处理器的目的就是在项目中生成RxHttp类&＃xff0c;那为何不直接把它写到库里面去呢&＃xff1f;前面讲过&＃xff0c;因为它有自己的使命&＃xff0c;而这个使命&＃xff0c;就是我们可以通过注解&＃xff0c;在RxHttp中生成自定义的api&＃xff0c;我们来看看如何使用注解。

动态设置baseUrl

现实开发中&＃xff0c;大部人开发者都会将baseUrl 单独抽取出来&＃xff0c;RxHttp也考虑到了这一点&＃xff0c;RxHttp通过&＃64;DefaultDomain注解来配置baseUrl&＃xff0c;看代码

public class Url {    &＃64;DefaultDomain() //设置为默认域名    public static String baseUrl &＃61; "http://ip.taobao.com/";}class Url {
    &＃64;DefaultDomain() //设置为默认域名
    public static String baseUrl &＃61; "http://ip.taobao.com/";
}


rebuild一下项目&＃xff0c;此时我们发送请求就可以直接传入path路径&＃xff0c;如下&＃xff1a;

  RxHttp.get("/service/getIpInfo.php")        .add("key", "value")        .from()          .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果           //成功回调        }, throwable -> {           //失败回调        });
        .add("key", "value")
        .from()  
        .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果
           //成功回调
        }, throwable -> {
           //失败回调
        });


RxHttp在发送请求前&＃xff0c;会对url做判断&＃xff0c;如果没有域名&＃xff0c;就会自定加上默认的域名&＃xff0c;也就是baseUrl。然后&＃xff0c;如果我们不想使用默认的域名呢&＃xff1f;RxHttp也考虑到来&＃xff0c;提供了一个&＃64;Domain注解&＃xff0c;我们再来看看用法&＃xff1a;

public class Url {    &＃64;Domain(name &＃61; "Update9158") //设置非默认域名&＃xff0c;name 可不传&＃xff0c;不传默认为变量的名称    public static String update &＃61; "http://update.9158.com";    &＃64;DefaultDomain() //设置为默认域名    public static String baseUrl &＃61; "http://ip.taobao.com/";}class Url {
    &＃64;Domain(name &＃61; "Update9158") //设置非默认域名&＃xff0c;name 可不传&＃xff0c;不传默认为变量的名称
    public static String update &＃61; "http://update.9158.com";

    &＃64;DefaultDomain() //设置为默认域名
    public static String baseUrl &＃61; "http://ip.taobao.com/";
}


此时再rebuild一下项目&＃xff0c;就会在RxHttp类中生成一个setDomainToUpdate9158IfAbsent()方法&＃xff0c;其中的Update9158字符就是name指定的名字&＃xff0c;然后发请求就可以这样&＃xff1a;

  RxHttp.get("/service/getIpInfo.php")        .setDomainToUpdate9158IfAbsent()        .add("key", "value")        .from()          .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果           //成功回调        }, throwable -> {           //失败回调        });
        .setDomainToUpdate9158IfAbsent()
        .add("key", "value")
        .from()  
        .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果
           //成功回调
        }, throwable -> {
           //失败回调
        });


此时&＃xff0c;RxHttp检测到url已经配置了域名&＃xff0c;就不会再去使用默认的域名。同样的&＃xff0c;setDomainToUpdate9158IfAbsent也会检测url 有没有配置域名&＃xff0c;如果配置了&＃xff0c;也不会使用我们指定的域名。

注意&＃xff1a;&＃64;Domain注解可以在多个地方使用&＃xff0c;而&＃64;DefaultDomain()只能在一个地方使用&＃xff0c;否则编译不通过&＃xff0c;很好理解&＃xff0c;默认域名只可能有一个。两个注解都要使用在public static修饰的String类型变量上&＃xff0c;对final关键字没有要求&＃xff0c;可写可不写&＃xff0c;这就表明&＃xff0c;baseUrl 可以动态更改&＃xff0c;RxHttp始终会拿到的最新的baseUrl 。怎么样&＃xff0c;是不是很nice!

更多注解使用请查看&＃xff1a;https://juejin.im/post/5cc484146fb9a032332b35ae

接下来&＃xff0c;我们来看看&＃xff0c;如何发送Post请求、如何在Activity/Fragment销毁时&＃xff0c;自动关闭为完成的请求、如何上传/下载文件及进度的监听、如何把Http返回的结果自动解析成我们想要的对象。

注&＃xff1a;以下讲解均使用RxHttp

Post

  RxHttp.postForm("http://...")        .add("key", "value")        .from()          .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果           //成功回调        }, throwable -> {           //失败回调        });
        .add("key", "value")
        .from()  
        .subscribe(s -> { //这里的s为String类型&＃xff0c;即Http请求的返回结果
           //成功回调
        }, throwable -> {
           //失败回调
        });


可以看到&＃xff0c;跟上面的Get请求只有一点不同&＃xff0c;Get是RxHttp.get&＃xff0c;而Post是RxHttp.postForm&＃xff0c;除此之外&＃xff0c;没有任何区别&＃xff0c;我们在看来来&＃xff0c;RxHttp都有哪些静态方法供我们选择请求方式

可以看到&＃xff0c;默认提供了10个静态方法供我们选择具体的请求方式&＃xff0c;有Get、Post、Put等&＃xff0c;而Post等又分为postForm和postJson&＃xff0c;这个好理解&＃xff0c;前者是发送表单形式的post请求&＃xff0c;后者是发送json字符串的post请求。

现实中&＃xff0c;这些默认的请求方式显然不能满足我们的需求&＃xff0c;如&＃xff1a;我要发送加密的post请求&＃xff0c;这个时候该怎么办呢&＃xff1f;此时就需要我们自定义请求方式。自定义请求方式请查看RxHttp 一条链发送请求之强大的Param类&＃xff08;三&＃xff09;

Activity 销毁&＃xff0c;自动关闭未完成的请求

上面的案例中&＃xff0c;在Activity/Fragment销毁时&＃xff0c;如果请求还未完成&＃xff0c;就会造成Activity/Fragment 无法回收&＃xff0c;导致内存泄漏。这是非常严重的问题&＃xff0c;那么RxHttp是如何解决的呢&＃xff1f;此时&＃xff0c;就要引入我自己写的另一个库RxLife&＃xff0c;直接看看如何使用

  RxHttp.postForm("http://...")        .add("key", "value")        .from()        .as(RxLife.as(this)) //订阅观察者前&＃xff0c;加上这句话即可        .subscribe(s -> {           //成功回调        }, throwable -> {           //失败回调        });  //或者  RxHttp.postForm("http://...")        .add("key", "value")        .from()        .as(RxLife.asOnMain(this)) //asOnMain 可以在主线程回调观察者        .subscribe(s -> {           //成功回调        }, throwable -> {           //失败回调        });
        .add("key", "value")
        .from()
        .as(RxLife.as(this)) //订阅观察者前&＃xff0c;加上这句话即可
        .subscribe(s -> {
           //成功回调
        }, throwable -> {
           //失败回调
        });
  //或者
  RxHttp.postForm("http://...")
        .add("key", "value")
        .from()
        .as(RxLife.asOnMain(this)) //asOnMain 可以在主线程回调观察者
        .subscribe(s -> {
           //成功回调
        }, throwable -> {
           //失败回调
        });


这里的this为LifecycleOwner对象&＃xff0c;它是一个接口&＃xff0c;这里我们传入的是Activity&＃xff0c;因为Activity实现了LifecycleOwner接口。当Activity/Fragment销毁时&＃xff0c;会将RxJava的管道中断&＃xff0c;管道中断时&＃xff0c;又会将未完成的请求自动关闭。

对RxLife不了解的同学请查看Android RxLife 一款轻量级别的RxJava生命周期管理库 (一)&＃xff0c;这里不详细讲解。在下面的讲解中&＃xff0c;我们均会使用RxLife

文件上传/下载及进度监听

使用RxHttp&＃xff0c;可以很优雅的实现文件上传/下载及进度的监听&＃xff0c;如何优雅&＃xff1f;直接上代码

文件上传

  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操作符&＃xff0c;是异步操作        .as(RxLife.asOnMain(this))  //感知生命周期&＃xff0c;并在主线程回调        .subscribe(s -> {             //成功回调        }, throwable -> {            //失败回调        });//发送Form表单形式的Post请求
        .add("key", "value")
        .add("file1", new File("xxx/1.png")) //添加file对象
        .add("file2", new File("xxx/2.png"))
        .from() //from操作符&＃xff0c;是异步操作
        .as(RxLife.asOnMain(this))  //感知生命周期&＃xff0c;并在主线程回调
        .subscribe(s -> { 
            //成功回调
        }, throwable -> {
            //失败回调
        });


可以看到&＃xff0c;文件上传跟普通的post请求其实没啥区别&＃xff0c;无非就是在post请求的基础上&＃xff0c;调用add方法添加要上传的文件对象。

文件下载

  //文件存储路径  String destPath &＃61; getExternalCacheDir() &＃43; "/" &＃43; System.currentTimeMillis() &＃43; ".apk";  RxHttp.get("http://update.9158.com/miaolive/Miaolive.apk")        .download(destPath) //注意这里使用download操作符&＃xff0c;并传入本地路径        .as(RxLife.asOnMain(this))  //感知生命周期&＃xff0c;并在主线程回调        .subscribe(s -> {            //下载成功,回调文件下载路径        }, throwable -> {            //下载失败        });
  String destPath &＃61; getExternalCacheDir() &＃43; "/" &＃43; System.currentTimeMillis() &＃43; ".apk";
  RxHttp.get("http://update.9158.com/miaolive/Miaolive.apk")
        .download(destPath) //注意这里使用download操作符&＃xff0c;并传入本地路径
        .as(RxLife.asOnMain(this))  //感知生命周期&＃xff0c;并在主线程回调
        .subscribe(s -> {
            //下载成功,回调文件下载路径
        }, throwable -> {
            //下载失败
        });


下载跟普通请求不同的是&＃xff0c;下载使用的是download操作符&＃xff0c;其它都一样。

文件下载进度监听

//文件存储路径  String destPath &＃61; getExternalCacheDir() &＃43; "/" &＃43; System.currentTimeMillis() &＃43; ".apk";  RxHttp.get("http://update.9158.com/miaolive/Miaolive.apk")        .downloadProgress(destPath) //注:如果需要监听下载进度&＃xff0c;使用downloadProgress操作符        .observeOn(AndroidSchedulers.mainThread())        .doOnNext(progress -> {            //下载进度回调,0-100&＃xff0c;仅在进度有更新时才会回调&＃xff0c;最多回调101次&＃xff0c;最后一次回调文件存储路径            int currentProgress &＃61; progress.getProgress(); //当前进度 0-100            long currentSize &＃61; progress.getCurrentSize(); //当前已下载的字节大小            long totalSize &＃61; progress.getTotalSize();     //要下载的总字节大小            String filePath &＃61; progress.getResult(); //文件存储路径&＃xff0c;最后一次回调才有内容        })        .filter(Progress::isCompleted)//下载完成&＃xff0c;才继续往下走        .map(Progress::getResult) //到这&＃xff0c;说明下载完成&＃xff0c;返回下载目标路径        .as(RxLife.as(this)) //感知生命周期        .subscribe(s -> {//s为String类型&＃xff0c;这里为文件存储路径            //下载完成&＃xff0c;处理相关逻辑        }, throwable -> {            //下载失败&＃xff0c;处理相关逻辑        });
  String destPath &＃61; getExternalCacheDir() &＃43; "/" &＃43; System.currentTimeMillis() &＃43; ".apk";
  RxHttp.get("http://update.9158.com/miaolive/Miaolive.apk")
        .downloadProgress(destPath) //注:如果需要监听下载进度&＃xff0c;使用downloadProgress操作符
        .observeOn(AndroidSchedulers.mainThread())
        .doOnNext(progress -> {
            //下载进度回调,0-100&＃xff0c;仅在进度有更新时才会回调&＃xff0c;最多回调101次&＃xff0c;最后一次回调文件存储路径
            int currentProgress &＃61; progress.getProgress(); //当前进度 0-100
            long currentSize &＃61; progress.getCurrentSize(); //当前已下载的字节大小
            long totalSize &＃61; progress.getTotalSize();     //要下载的总字节大小
            String filePath &＃61; progress.getResult(); //文件存储路径&＃xff0c;最后一次回调才有内容
        })
        .filter(Progress::isCompleted)//下载完成&＃xff0c;才继续往下走
        .map(Progress::getResult) //到这&＃xff0c;说明下载完成&＃xff0c;返回下载目标路径
        .as(RxLife.as(this)) //感知生命周期
        .subscribe(s -> {//s为String类型&＃xff0c;这里为文件存储路径
            //下载完成&＃xff0c;处理相关逻辑
        }, throwable -> {
            //下载失败&＃xff0c;处理相关逻辑
        });


下载进度的监听我们稍微看一下 &＃xff0c;首先一点&＃xff0c;下载使用download操作符&＃xff0c;而下载进度监听使用downloadProgress操作符&＃xff0c;随后&＃xff0c;我们使用了doOnNext操作符处理进度回调&＃xff0c;注意这里是仅当有进度更新时&＃xff0c;才会回调&＃xff0c;其中的progress变量是一个Progress类型的对象&＃xff0c;我们贴上源码&＃xff1a;

public class Progress {    private int  progress; //当前进度 0-100    private long currentSize;//当前已完成的字节大小    private long totalSize; //总字节大小    private T mResult; //http返回结果,上传/下载完成时调用    //省略get/set方法}class Progress<T> {
    private int  progress; //当前进度 0-100
    private long currentSize;//当前已完成的字节大小
    private long totalSize; //总字节大小
    private T mResult; //http返回结果,上传/下载完成时调用
    //省略get/set方法
}


由于进度回调会执行101次(上面注释有解释)&＃xff0c;而最下面观察者其实是不需要关心这么多事件的&＃xff0c;只需要关心最后下载完成的事件&＃xff0c;所以使用了filter操作符过滤事件&＃xff0c;只要还未下载完成&＃xff0c;就将事件过滤调&＃xff0c;不让往下走。最终下载完成后&＃xff0c;拿到本地下载路径。

文件上传进度监听

  RxHttp.postForm("http://www.......") //发送Form表单形式的Post请求        .add("file1", new File("xxx/1.png"))        .add("file2", new File("xxx/2.png"))        .add("key1", "value1")//添加参数&＃xff0c;非必须        .add("key2", "value2")//添加参数&＃xff0c;非必须        .addHeader("versionCode", "100") //添加请求头,非必须        .uploadProgress() //注:如果需要监听上传进度&＃xff0c;使用uploadProgress操作符        .observeOn(AndroidSchedulers.mainThread()) //主线程回调        .doOnNext(progress -> {            //上传进度回调,0-100&＃xff0c;仅在进度有更新时才会回调,最多回调101次&＃xff0c;最后一次回调Http执行结果            int currentProgress &＃61; progress.getProgress(); //当前进度 0-100            long currentSize &＃61; progress.getCurrentSize(); //当前已上传的字节大小            long totalSize &＃61; progress.getTotalSize();     //要上传的总字节大小            String result &＃61; progress.getResult(); //Http执行结果&＃xff0c;最后一次回调才有内容        })        .filter(Progress::isCompleted)//过滤事件&＃xff0c;上传完成&＃xff0c;才继续往下走        .map(Progress::getResult) //到这&＃xff0c;说明上传完成&＃xff0c;拿到Http返回结果并继续往下走        .as(RxLife.as(this))  //感知生命周期        .subscribe(s -> { //s为String类型&＃xff0c;由SimpleParser类里面的泛型决定的            //上传成功&＃xff0c;处理相关逻辑        }, throwable -> {            //上传失败&＃xff0c;处理相关逻辑        });//发送Form表单形式的Post请求
        .add("file1", new File("xxx/1.png"))
        .add("file2", new File("xxx/2.png"))
        .add("key1", "value1")//添加参数&＃xff0c;非必须
        .add("key2", "value2")//添加参数&＃xff0c;非必须
        .addHeader("versionCode", "100") //添加请求头,非必须
        .uploadProgress() //注:如果需要监听上传进度&＃xff0c;使用uploadProgress操作符
        .observeOn(AndroidSchedulers.mainThread()) //主线程回调
        .doOnNext(progress -> {
            //上传进度回调,0-100&＃xff0c;仅在进度有更新时才会回调,最多回调101次&＃xff0c;最后一次回调Http执行结果
            int currentProgress &＃61; progress.getProgress(); //当前进度 0-100
            long currentSize &＃61; progress.getCurrentSize(); //当前已上传的字节大小
            long totalSize &＃61; progress.getTotalSize();     //要上传的总字节大小
            String result &＃61; progress.getResult(); //Http执行结果&＃xff0c;最后一次回调才有内容
        })
        .filter(Progress::isCompleted)//过滤事件&＃xff0c;上传完成&＃xff0c;才继续往下走
        .map(Progress::getResult) //到这&＃xff0c;说明上传完成&＃xff0c;拿到Http返回结果并继续往下走
        .as(RxLife.as(this))  //感知生命周期
        .subscribe(s -> { //s为String类型&＃xff0c;由SimpleParser类里面的泛型决定的
            //上传成功&＃xff0c;处理相关逻辑
        }, throwable -> {
            //上传失败&＃xff0c;处理相关逻辑
        });


上传进度监听使用downloadProgress操作符&＃xff0c;剩下的操作跟下载进度监听的操作都一样&＃xff0c;通过doOnNext监听上传进度&＃xff0c;然后过滤事件&＃xff0c;最终拿到Http的返回结果。

数据解析器Parser

在上面的案例中&＃xff0c;观察者拿到数据类型都是String类型&＃xff0c;然后现实开发中&＃xff0c;我们经常需要对数据解析成我们想要的对象&＃xff0c;RxHttp考虑到了这一点&＃xff0c;现在我们就来看看如何的到我们想要的对象

我们拿淘宝获取IP的接口作为测试接口http://ip.taobao.com/service/getIpInfo.php?ip&＃61;63.223.108.42
对应的数据结构如下

public class Response {    private int     code;    private Address data;    //省略set、get方法    class Address {        //为简单起见&＃xff0c;省略了部分字段        private String country; //国家        private String region; //地区        private String city; //城市        //省略set、get方法    }}class Response {
    private int     code;
    private Address data;
    //省略set、get方法

    class Address {
        //为简单起见&＃xff0c;省略了部分字段
        private String country; //国家
        private String region; //地区
        private String city; //城市
        //省略set、get方法
    }
}


开始发送请求

  RxHttp.get("http://ip.taobao.com/service/getIpInfo.php") //Get请求        .add("ip", "63.223.108.42")//添加参数        .addHeader("accept", "*/*") //添加请求头        .addHeader("connection", "Keep-Alive")        .addHeader("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)")        .fromSimpleParser(Response.class)  //这里返回Observable 对象        .as(RxLife.asOnMain(this))  //感知生命周期&＃xff0c;并在主线程回调        .subscribe(response -> {            //成功回调        }, throwable -> {            //失败回调        });//Get请求
        .add("ip", "63.223.108.42")//添加参数
        .addHeader("accept", "*/*") //添加请求头
        .addHeader("connection", "Keep-Alive")
        .addHeader("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)")
        .fromSimpleParser(Response.class)  //这里返回Observable 对象
        .as(RxLife.asOnMain(this))  //感知生命周期&＃xff0c;并在主线程回调
        .subscribe(response -> {
            //成功回调
        }, throwable -> {
            //失败回调
        });


可以看到&＃xff0c;这里我们没有用from操作符&＃xff0c;而是用了fromSimpleParser操作符&＃xff0c;并且传入Response.class&＃xff0c;最后观察者拿到的response变量就是Response类型的对象。怎么样&＃xff0c;是不是很简单。RxHttp为我们提供了一系列的fromXXX方法&＃xff0c;我们来看一下:

我们可以看到&＃xff0c;一些基本类型的封装对象RxHttp都为我们封装好了&＃xff0c;还有一个fromListParser方法&＃xff0c;此方法是用来解析集合对象的&＃xff0c;一些常见的数据结构&＃xff0c;RxHttp都为我们考虑到了&＃xff0c;并封装好了&＃xff0c;然后&＃xff0c;一些不常见的数据呢&＃xff1f;眼尖的你也许发现了&＃xff0c;上图中还有一个 Observable from(Parser parser)方法&＃xff0c;它允许我们传入一个自定义的解析器&＃xff0c;更多解析器的介绍&＃xff0c;请查看RxHttp 之强大的数据解析功能&＃xff08;二&＃xff09;

最后&＃xff0c;附上RxHttp一些常用的用法&＃xff0c;如下&＃xff1a;

  RxHttp.postForm("/service/getIpInfo.php")       //发送Form表单形式的Post请求        .setDomainToUpdate9158IfAbsent()  //手动设置域名&＃xff0c;此方法是通过&＃64;Domain注解生成的        .tag("RxHttp.get")          //为单个请求设置tag        .setUrl("http://...")       //重新设置url        .setAssemblyEnabled(false)  //设置是否添加公共参数&＃xff0c;默认为true        .cacheControl(CacheControl.FORCE_NETWORK)  //缓存控制        .setParam(Param.postForm("http://..."))    //重新设置一个Param对象        .add(new HashMap<>())   //通过Map添加参数        .add("int", 1)          //添加int类型参数        .add("float", 1.28838F) //添加float类型参数        .add("double", 1.28838) //添加double类型参数        .add("key1", "value1")  //添加String类型参数        .add("key2", "value2", false) //根据最后的boolean字段判断是否添加参数         .add("file1", new File("xxx/1.png"))            //添加文件对象        .addHeader("headerKey1", "headerValue1")        //添加头部信息        .addHeader("headerKey2", "headerValue2", false)//根据最后的boolean字段判断是否添加头部信息         .fromSimpleParser(String.class)  //这里返回Observable 对象  fromXXX都是异步操作符        //感知生命周期&＃xff0c;并在主线程回调&＃xff0c;当Activity/Fragment销毁时&＃xff0c;自动关闭未完成的请求        .as(RxLife.asOnMain(this))          .subscribe(s -> {    //订阅观察者            //成功回调        }, throwable -> {            //失败回调        });//发送Form表单形式的Post请求
        .setDomainToUpdate9158IfAbsent()  //手动设置域名&＃xff0c;此方法是通过&＃64;Domain注解生成的
        .tag("RxHttp.get")          //为单个请求设置tag
        .setUrl("http://...")       //重新设置url
        .setAssemblyEnabled(false)  //设置是否添加公共参数&＃xff0c;默认为true
        .cacheControl(CacheControl.FORCE_NETWORK)  //缓存控制
        .setParam(Param.postForm("http://..."))    //重新设置一个Param对象
        .add(new HashMap<>())   //通过Map添加参数
        .add("int", 1)          //添加int类型参数
        .add("float", 1.28838F) //添加float类型参数
        .add("double", 1.28838) //添加double类型参数
        .add("key1", "value1")  //添加String类型参数
        .add("key2", "value2", false) //根据最后的boolean字段判断是否添加参数 
        .add("file1", new File("xxx/1.png"))            //添加文件对象
        .addHeader("headerKey1", "headerValue1")        //添加头部信息
        .addHeader("headerKey2", "headerValue2", false)//根据最后的boolean字段判断是否添加头部信息 
        .fromSimpleParser(String.class)  //这里返回Observable 对象  fromXXX都是异步操作符
        //感知生命周期&＃xff0c;并在主线程回调&＃xff0c;当Activity/Fragment销毁时&＃xff0c;自动关闭未完成的请求
        .as(RxLife.asOnMain(this))  
        .subscribe(s -> {    //订阅观察者
            //成功回调
        }, throwable -> {
            //失败回调
        });


小结

到这&＃xff0c;RxHttp的基本用法我们就讲解完毕了&＃xff0c;可以看到&＃xff0c;使用RxHttp类一条链就能完成一个完整的Http请求&＃xff0c;简单一点&＃xff0c;就是请求三部曲&＃xff1a;

以上所有的案例都离不开这3个步骤。最后&＃xff0c;你会发现&＃xff0c;RxHttp除了提供的一系列强大的功能外&＃xff0c;在写法上&＃xff0c;不管什么请求&＃xff0c;都极其的相似&＃xff0c;只要通过RxHttp类&＃xff0c;就能一条链&＃xff0c;完成所有的请求&＃xff0c;极大的降低了学习成本。

注:要想在项目中生成RxHttp类&＃xff0c;至少需要使用一次注解类&＃xff0c;否则检测不到注解&＃xff0c;就无法生成。

如果你觉得RxHttp&＃43;RxLife好用&＃xff0c;请记得给我star
如果有好的idea&＃xff0c;请留言或者联系我。

更过详情请查看RxHttp系列其它文章&＃xff1a;

RxHttp 一条链发送请求之强大的数据解析功能&＃xff08;二&＃xff09;
https://juejin.im/post/5cc095b7f265da0379417be0

RxHttp 一条链发送请求之强大的Param类&＃xff08;三&＃xff09;
https://juejin.im/post/5cc47e575188252da72219ca

RxHttp 一条链发送请求之注解处理器 Generated API&＃xff08;四&＃xff09;
https://juejin.im/post/5cc484146fb9a032332b35ae

推荐阅读
探索 Android 平台的 CameraX
Lottie 实现炫酷动画背后的原理

编程·思维·职场
欢迎扫码关注

  在看也是一种认可