如何處理RxSwift的Error事件
翻譯自:How to handle errors in RxSwift
在最近這些日子裏,MVVM在iOS開發中變得越來約受歡迎,RxSwfit也變得越來越流行。在RxSwift中大多數屬性都是序列(Observable)。
但是,當遇到error
或者completed
時,序列就會終止。
終止代表者序列訂閱將不會接收到任何信息,當我剛開始學習Rx的時候,我並沒有注意到序列的這個規則。
你是否對於錯誤處理有疑問了?你是否遇到序列意外終止或按鈕停止發送點擊事件?這篇文章就是關於這個的。
Errors 例子
移動應用一般會根據用戶操作,進行一些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事件,並且終止掉序列。
RxSwift怎麼捕獲處理Error
有時候,我們希望知道error發生了什麼,就拿登錄來說,如果密碼與登錄的郵箱不一致,你希望服務器返回一個錯誤,是 一個有意義的錯誤(也許你需要提示用戶)。
使用Obeservable<Result<T,Error>>
Result具備傳遞一個元素或者傳遞一個錯誤的功能。所以它可以方便的作爲這種雙狀態傳遞。
你的API調用應該返回 Observable<Result<T,Error>>
.將Result 作爲next事件,不會終止主序列。
/// 模擬網絡請求 使用Result<T,Error> 將錯誤攜帶出來
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()操作符
還有一種更簡單的方法來處理, 使用操作符 materialize
操作符, 它將轉化Observable 爲 Observalbe<Event>,將序列轉爲包含Event事件的序列,即爲其包裹一層Event。
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.可以使用序列的一下兩個來分別處理元素和錯誤,
- Elements() 返回Observable
- Errors() 返回Observable
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也會終止序列喲。
performAPICall()被調用兩次
如願解決了我們的error捕獲問題,但是又有另外一個bug出現了,無論你點擊哪個按鈕,方法 performAPICall
都會被調用兩次,你可能需要在方法內打斷點才能注意到它。
你估計想說,這不是我們要處理的,但是實際情況是,如果點擊一次,進行兩次請求,服務器就會出錯,爲了解決這個問題,我們使用 share()
操作在result序列上(原因是,result在後面被訂閱了兩次)。
從哪裏來,要去哪裏
當你是用RxSwift擴展來驅動UI,捕捉錯誤不是一個簡單的任務, Error
事件終止序列,甚至這個 error事件 可能來自於flatmap內部。
通常,你想通知用戶出錯了。爲了實現這個功能,你必須把他們當做可捕捉的事情,而不像異常,可以不用處理。我推薦使用materialize()。但是不要忘了使用share()你不想請求兩次API吧。
你可以查看項目示例源碼
RxSwift中文文檔:Error Handing錯誤處理