可怕！RxHttp2.0重大更新！协程发请求，原来如此简单

Posted 2021-04-18 秦子帅

秦子帅

明确目标，每天进步一点点.....

作者 |  不怕天黑

地址 |  juejin.im/post/5ea04cd9f265da47c15cd752

前言

RxHttp 在v2.0版本中加入对协程的支持，收到了广大kotlin用户的喜爱，他们也不禁感慨，原来协程发请求还能如此优雅，比retrofit强大的不止一点点，然而，这就够了吗？远远不够，为啥，因为还有痛点没解决，为此，我也收集几个目前网络请求遇到的痛点，如下：

• 异步操作，协程已为我们提供了async操作符处理异步问题，但用到时，每次还要包装一次，不能接受

• 超时与重试，这种情况遇到的不多，但几乎每个开发者都会遇到，真遇到时，如果没有对应的API，也着实让人着急

• 请求开始/结束延迟，这种情况也不多，但遇到的人也不少，自己处理着实麻烦

• 在请求并行中，假设有A、B两个请求甚至更多，它们互不依赖，然而在协程中，如果A请求出现异常，那么协程就中止了，此时B也跟着中止了，这是我们不想看到的结果，如何解决？常规的做法是对每个请求都做异常处理，使得出现异常，协程不会结束。但每个请求都需要单独处理，写起来着实会让人抓破头皮，这是很大的痛点

等等，其实还有很多小细节的问题，这里就就不一一列举了。

正因有以上问题，所以RxHttp v2.2.0版本就来了，该版本主要改动如下

• 新增一系列非常好用的操作符，如：asysn、timeout、retry、tryAwait等等

• 完全剔除RxJava，采用外挂方法替代，也正因如此，RxHttp做到同时支持RxJava2与RxJava3

• 将RxLieScope提取为单独的一个库，专门处理协程开启/关闭/异常处理，本文后续会单独介绍

gradle依赖

  
    
    
  

   
     
     
   dependencies {
   //必须
   implementation 'com.ljx.rxhttp:rxhttp:2.2.0'
   kapt 'com.ljx.rxhttp:rxhttp-compiler:2.2.0' //生成RxHttp类

   //以下均为非必须
   //管理协程生命周期，页面销毁，关闭请求
   implementation 'com.ljx.rxlife:rxlife-coroutine:2.0.0'  

   //Converter 根据自己需求选择 RxHttp默认内置了GsonConverter
   implementation 'com.ljx.rxhttp:converter-jackson:2.2.0'
   implementation 'com.ljx.rxhttp:converter-fastjson:2.2.0'
   implementation 'com.ljx.rxhttp:converter-protobuf:2.2.0'
   implementation 'com.ljx.rxhttp:converter-simplexml:2.2.0'
}
  
    
    
  

注：纯Java项目，请使用annotationProcessor替代kapt；依赖完，记得rebuild，才会生成RxHttp类

请求三部曲

相信还有之前没了解过RxHttp的同学，这里贴出RxHttp请求流程图，记住该图，你就掌握了RxHttp的精髓，如下：

代码表示

  
    
    
  

   
     
     
   val str = RxHttp.get("/service/...") //第一步，确定请求方式，可以选择postForm、postJson等方法
    .toStr() //第二步，确认返回类型，这里代表返回String类型
    .await() //第二步，使用await方法拿到返回值
  
    
    
  

怎么样，是不是非常简单？

RxHttp操作符

3.1、Retry失败重试

该操作符非常强大，不仅做到了失败重试，还做到了周期性失败重试，即间隔几秒后重试，来看下完整的方法签名

  
    
    
  

   
     
     
   /**
 * 失败重试，该方法仅在使用协程时才有效
 * @param times 重试次数, 默认Int.MAX_VALUE 代表不断重试
 * @param period 重试周期, 默认为0, 单位: milliseconds
 * @param test 重试条件, 默认为空，即无条件重试
 */
fun retry(
    times: Int = Int.MAX_VALUE,
    period: Long = 0,
    test: ((Throwable) -> Boolean)? = null
)
  
    
    
  

retry() 方法共有3个参数，分别是重试次数、重试周期、重试条件，都有默认值，3个参数可以随意搭配，如：

  
    
    
  

   
     
     
   retry() //无条件、不间断、一直重试
retry(2) //无条件、不间断、重试两次
retry(2, 1000) //无条件 间隔1s 重试2此
retry { it is ConnectException } //有条件、不间断、一直重试
retry(2) { it is ConnectException } //有条件、不间断、重试2次
retry(2, 1000) { it is ConnectException } //有条件、间隔1s、重试2次
retry(period = 1000) { it is ConnectException } //有条件、间断1s、一直重试
  
    
    
  

前两个参数相信大家一看就能明白，这里对第3个参数额外说一下，通过第三个参数，我们可以拿到 Throwable 异常对象，我们可以对异常做判断，如果需要重试，就返回true，不需要就返回false，下面看看具体代码

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .retry(2, 1000) { //重试2次，每次间隔1s
        it is ConnectException //如果是网络异常就重试
    }
    .await()
  
    
    
  

3.2、timeout超时

OkHttp提供了全局的读、写及连接超时，有时我们也需要为某个请求设置不同的超时时长，此时就可以用到RxHttp的 timeout(Long) 方法，如下：

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .timeout(3000) //超时时长为3s
    .await()
  
    
    
  

3.3、async异步操作符

如果我们由两个请求需要并行时，就可以使用该操作符，如下：

  
    
    
  

   
     
     
   //同时获取两个学生信息
suspend void initData() {
  val asyncStudent1 = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .async() //这里会返回Deferred<Student>
    
  val asyncStudent2 = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .async() //这里会返回Deferred<Student>

  //随后调用await方法获取对象
  val student1 = asyncStudent1.await()
  val student2 = asyncStudent2.await()
}
  
    
    
  

3.4、delay，startDelay延迟

delay 操作符是请求结束后，延迟一段时间返回；而 startDelay 操作符则是延迟一段时间后再发送请求，如下：

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .delay(1000) //请求回来后，延迟1s返回
    .await()
    
val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .startDelay(1000) //延迟1s后再发送请求
    .await()
  
    
    
  

3.5、onErrorReturn、onErrorReturnItem异常默认值
有些情况，我们不希望请求出现异常时，直接走异常回调，此时我们就可以通过两个操作符，给出默认的值，如下：

  
    
    
  

   
     
     
   //根据异常给出默认值
val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .timeout(100) //超时时长为100毫秒
    .onErrorReturn {
        //如果时超时异常，就给出默认值，否则，抛出原异常
        return@onErrorReturn if (it is TimeoutCancellationException)
            Student()
        else                                                        
            throw it
    }
    .await()
    
//只要出现异常，就返回默认值
val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .timeout(100) //超时时长为100毫秒
    .onErrorReturnItem(Student())
    .await()
  
    
    
  

3.6、tryAwait 异常返回null

如果你不想在异常时返回默认值，又不想异常是影响程序的执行， tryAwait 就派上用场了，它会在异常出现时，返回null，如下：

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .timeout(100) //超时时长为100毫秒
    .tryAwait() //这里返回 Student? 对象，即有可能为空
  
    
    
  

3.7、map 转换符号

map 操作符很好理解，RxJava即协程的Flow都有该操作符，功能都是一样，用于转换对象，如下：

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toStr()
    .map { it.length } //String转Int
    .tryAwait() //这里返回 Student? 对象，即有可能为空
  
    
    
  

3.8、以上操作符随意搭配

以上操作符，可随意搭配使用，但调用顺序的不同，产生的效果也不一样，这里悄悄告诉大家，以上操作符只会对上游代码产生影响。

如 timeout及retry ：

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .timeout(50)
    .retry(2, 1000) { it is TimeoutCancellationException }
    .await()
  
    
    
  

以上代码，只要出现超时，就会重试，并且最多重试两次。

但如果 timeout 、 retry 互换下位置，就不一样了，如下：

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .retry(2, 1000) { it is TimeoutCancellationException }
    .timeout(50)
    .await()
  
    
    
  

此时，如果50毫秒内请求没有完成，就会触发超时异常，并且直接走异常回调，不会重试。为什么会这样？原因很简单， timeout及retry 操作符，仅对上游代码生效。如retry操作符，下游的异常是捕获不到的，这就是为什么timeout在retry下，超时时，重试机制没有触发的原因。

在看 timeout 和 startDelay 操作符

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .startDelay(2000)
    .timeout(1000)
    .await()
  
    
    
  

以上代码，必定会触发超时异常，因为startDelay，延迟了2000毫秒，而超时时长只有1000毫秒，所以必定触发超时。但互换下位置，又不一样了，如下：

  
    
    
  

   
     
     
   val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .timeout(1000)
    .startDelay(2000)
    .await()
  
    
    
  

以上代码正常情况下，都能正确拿到返回值，为什么？原因很简单，上面说过，操作符只会对上游产生影响，下游的 startDelay 延迟，它是不管的，也管不到。

协程开启/关闭/异常处理

在以上示例中，我们统一用到await/tryAwait操作符获取请求返回值，它们都是suspend挂起函数，需要在另一个suspend挂起函数或者协程中才能被调用，故我们提供了RxLifeScope库来处理协程开启、关闭及异常处理，用法如下：

在FragemntActivity/Fragment/ViewModel环境下

在该环境下，直接调用 rxLifeScope 对象的 lanuch 方法开启协程即可，如下：

  
    
    
  

   
     
     
   rxLifeScope.lanuch({
    //协程代码块，运行在UI线程
    val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .await()
    //可直接更新UI
}, {
    //异常回调，这里可以拿到Throwable对象
})
  
    
    
  

以上代码，会在页面销毁时，自动关闭协程，同时自动关闭请求，无需担心内存泄露问题

非FragemntActivity/Fragment/ViewModel环境下

该环境下，我们需要手动创建 RxLifeScope 对象，随后调用 lanuch 方法开启协程

  
    
    
  

   
     
     
   val job = RxLifeScope().lanuch({
    //协程代码块，运行在UI线程
    val student = RxHttp.postForm("/service/...")
    .toClass<Student>()
    .await()
    //可直接更新UI
}, {
    //异常回调，这里可以拿到Throwable对象
})

//在合适的时机关闭协程
job.cancel()
  
    
    
  

以上代码，由于未与生命周期绑定，故我们需要在合适的时机，手动关闭协程，协程关闭，请求也会跟着关闭

监听协程开启/结束回调

以上我们在 lanuch 方法，传入协程运行回调及异常回调，我们也可以传入协程开启及结束回调，如下：

  
    
    
  

   
     
     
   rxLifeScope.launch({
    //协程代码块
    val student = RxHttp.postForm("/service/...")
        .toClass<Student>()
        .await()
    //可直接更新UI
}, {
    //异常回调，这里可以拿到Throwable对象，运行在UI线程
}, {
    //开始回调，可以开启等待弹窗，运行在UI线程
}, {
    //结束回调，可以销毁等待弹窗，运行在UI线程
})
  
    
    
  

以上回调，均运行在UI线程

小结

可以看到，前面文章开头提到超时/重试问题，就用 timeout/retry ，延迟就用 delay/startDelay ，出现异常不想中断协程的运行，就用 onErrorReturn/onErrorReturnItem 或者 tryAwait ，总之，一切都是那么的优雅。

RxHttp的优雅远不止这些，BaseUrl的处理，文件上传/下载/进度监听，缓存处理、业务code统一判断等等，处理的都令人叹为观止
地址：

https://github.com/liujingxing/okhttp-RxHttp

附加：
大家都知道我的微信已达上限，想微信交流的朋友可以加我的另外一个号，名额不多了，感兴趣的一起来搞事情哦：

---END---

转发至朋友圈，是绝对的真爱

觉得小编菜的，点个在看哈