如何处理RxSwift的Error事件
翻译自:How to handle errors in RxSwift
在最近这些日子里,MVVM在iOS开发中变得越来约受欢迎,RxSwfit也变得越来越流行。在RxSwift中大多数属性都是序列(Observable)。
但是,当遇到error
或者completed
时,序列就会终止。
终止代表者序列订阅将不会接收到任何信息,当我刚开始学习Rx的时候,我并没有注意到序列的这个规则。
你是否对于错误处理有疑问了?你是否遇到序列意外终止或按钮停止发送点击事件?这篇文章就是关于这个的。
移动应用一般会根据用户操作,进行一些API网络请求,我们的例子就包含这种情况:
点击成功,调用API成功结果,同样的,点击失败,发出error事件,并且会增加相应的数量。
下面是我想表达的
successTap -s-----s--s-----s---------->
failureTap ----f---f-----f----f------->
buttonTaps<Bool> -T--F--TF-F---F-T--F------->
response --V--E--VE-V---E-V--E------>
(using flatMap)
where:
's' and 'f' - success or failure button tap
'T' and 'F' - true or false
'V' - success response
'E' - failure response (error)
我们开始写代码,你需要 map()
当点击成功按钮的时候,map为ture, 点击失败时map为false。 接下来,你需要合并他们到一个单独序列。
let result = Observable
.of(successButton.rx.tap.map { true }, failureButton.rx.tap.map { false })
.merge() //合并序列
.flatMap { [unowned self] performWithSuccess in
return self.performAPICall(shouldEndWithSuccess: performWithSuccess)
}
模拟网络请求
/// 模拟网络请求, 根据按钮布尔值来决定网络请求成功还是失败, 正常情况,返回的序列应该是一个Model,这里简单用Void代替。
private func performAPICall(shouldEndWithSuccess: Bool) -> Observable<Void> {
if shouldEndWithSuccess {
return .just(())
} else {
return .error(SampleError())
}
}
在这个例子中,如果你是第一次使用 Rx方法的merge()、map()或者flatmap().请阅读[Thinking in RxSwift](http://adamborek.com/thinking-rxswift/, 我已经描述了每个响应式方法的思想和工作方式。
老实来说,点击成功将增加成功次数。然而当你点击失败按钮,序列发出Error,导致result序列将释放自己,从这时候起,点击成功/失败按钮将不会增加相应次数。
为什么了?
当 performAPICall 失败,它将返回一个error事件(就像一个真是的网络回调那样),当我们使用flatmap,所有的next和error将从内部序列传递到主序列(即result)。
结果就是,主序列接收到一个error事件,并且终止掉序列。
有时候,我们希望知道error发生了什么,就拿登录来说,如果密码与登录的邮箱不一致,你希望服务器返回一个错误,是 一个有意义的错误(也许你需要提示用户)。
Result具备传递一个元素或者传递一个错误的功能。所以它可以方便的作为这种双状态传递。
你的API调用应该返回 Observable
.将Result 作为next事件,不会终止主序列。
/// 模拟网络请求 使用Result 将错误携带出来
private func performAPICall(shouldEndWithSuccess: Bool) -> Observable<Result<Model,SampleError>> { // sampleError为实现Error的类型
if shouldEndWithSuccess {
let model = Model()
return .just(Result<Model, SampleError>.success(model))
} else {
return .just(Result<Model, SampleError>.failure(SampleError()))
}
}
还有一种更简单的方法来处理, 使用操作符 materialize
操作符, 它将转化Observable 为 Observalbe
let result = Observable
.of(successButton.rx.tap.map { true }, failureButton.rx.tap.map { false })
.merge()
.flatMap { [unowned self] performWithSuccess in
return self.performAPICall(shouldEndWithSuccess: performWithSuccess)
.materialize() // 使用materialize()来转化为Event
}.share() // 防止多次请求
1.可以使用序列的一下两个来分别处理元素和错误,
result.elements()
.scan(0) { accumulator, _ in
return accumulator + 1
}.map { "\($0)" }
.bind(to: successessCountLabel.rx.text)
.disposed(by: disposeBag)
result.errors()
.scan(0) { accumulator, _ in
return accumulator + 1
}.map { "\($0)" }
.bind(to: failuresCountLabel.rx.text)
.disposed(by: disposeBag)
2.直接订阅Event事件处理元素和错误。
result.subscribe(onNext: { (event) in
switch event {
case .next(_):
print("发出next元素")
case .error(let error):
print(error)
default :
break
}
})
.disposed(by: disposeBag)
Tips: 从语义理解层来说,建议使用Result,更能理解序列会遇到error终止, 当然materialize()使用起来可能更方便简单,不要忘了,completed也会终止序列哟。
如愿解决了我们的error捕获问题,但是又有另外一个bug出现了,无论你点击哪个按钮,方法 performAPICall
都会被调用两次,你可能需要在方法内打断点才能注意到它。
你估计想说,这不是我们要处理的,但是实际情况是,如果点击一次,进行两次请求,服务器就会出错,为了解决这个问题,我们使用 share()
操作在result序列上(原因是,result在后面被订阅了两次)。
当你是用RxSwift扩展来驱动UI,捕捉错误不是一个简单的任务, Error
事件终止序列,甚至这个 error事件 可能来自于flatmap内部。
通常,你想通知用户出错了。为了实现这个功能,你必须把他们当做可捕捉的事情,而不像异常,可以不用处理。我推荐使用materialize()。但是不要忘了使用share()你不想请求两次API吧。
你可以查看项目示例源码
RxSwift中文文档:Error Handing错误处理