所有文章

RxSwift 探索之旅 · 08

Error Handling Operators

用 catchError、catchErrorJustReturn、retry 與 retryWhen 處理序列中的錯誤。

調整API

為了展示Error handling operators,我們把 API 調整一下

  1. 從原本的只return Void跟error,變成return String跟error
  2. 增加了invalid error
  3. 回傳條件隨機產生數字 -109,09 回傳animals元素,-1~-4回傳invalid錯誤,-10~-5回傳unknown錯誤
class API {
enum APIError: Error {
case unknown
case invalid
}
func request() -> Single<String> {
return Single.create { (single) -> Disposable in
DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
let animals = ["Dog", "Cat", "Lion", "Tiger", "Koala", "Monkey", "Pig", "Chicken", "Penguin", "Wolf"]
let number = Int.random(in: -10..<animals.count)
if number > 0 {
single(.success(animals[number]))
} else if number > -5 {
single(.error(APIError.invalid))
} else {
single(.error(APIError.unknown))
}
}
return Disposables.create()
}
}
}

接著加入一個按鈕,讓button tap事件去跟subject綁定,這樣點下按鈕就會把 Void 元素傳給 subject了,萬事俱備後我們來看第一個operators。

let subject = PublishSubject<Void>()
button.rx.tap.bind(to: subject).disposed(by: disposeBag)

CatchError

很像Rx版的try catch,定義我們在進行operator時,當catch到.error事件時,要做出怎樣個反應。像以下範例是透過switch了解是哪種錯誤,再把對應的.error轉變成!或是?元素。

let result = subject
.flatMapLatest { _ in
API().request().asObservable()
.catchError {
let error = $0 as! API.APIError
switch error {
case .unknown:
return .just("?")
case .invalid:
return .just("!")
}
}
.materialize()
}
.share()
result.elements().debug("A").subscribe().disposed(by: disposeBag)
result.errors().debug("B").subscribe().disposed(by: disposeBag)

執行結果

A -> Event next(Chicken)
A -> Event next(Lion)
A -> Event next(Pig)
A -> Event next(?)
A -> Event next(Penguin)
A -> Event next(!)

因為在錯誤後有進行catchError將錯誤轉換元素,所以B不會收到.error事件囉!

CatchErrorJustReturn

如果不管什麼錯誤,都直接給個預設值,那就可以選擇catchErrorJustReturn,範例如下

let result = subject
.flatMapLatest { _ in
API().request().asObservable()
.catchErrorJustReturn("!?")
.materialize()
}
.share()

執行結果

A -> Event next(!?)
A -> Event next(Chicken)

延續前面的範例程式,做以下修改

Retry

如果發生錯誤,想重新嘗試,那就選擇retry,參數需要帶入 maxAttemptCount,值得注意的是,文件中有寫『If you encounter an error and want it to retry once, then you must use retry(2)』,如果要至少 retry 一次的話,是要寫retry(2),而不是retry(1)哦!

let result = subject
.flatMapLatest { _ in
API().request().asObservable().debug("Call")
.retry(3)
.materialize()
}
.share()

執行結果

Call -> Event error(unknown)
Call -> isDisposed
Call -> subscribed
Call -> Event next(Tiger)
A -> Event next(Tiger)
Call -> Event completed
Call -> isDisposed

RetryWhen

如果覺得直接retry不能滿足你的需求,你必須處理更複雜的狀況,也許可以考慮retryWhen,當符合條件下停止retry,或是延遲retry時機,下面程式碼展示延遲retry的範例

let result = subject
.flatMapLatest { _ in
API().request().asObservable().debug("Call")
.retryWhen { error -> Observable<Int> in
// 1
let maxAttempt = 3
// 2
return error.enumerated().flatMap { attempt, err -> Observable<Int> in
//3
if attempt >= maxAttempt {
return Observable.error(err)
}
print(" === #\(attempt): Retry after \(attempt*3) seconds ===")
// 4, 5
return Observable<Int>.timer(.seconds(attempt*3), scheduler: MainScheduler.instance)
}
}
.materialize()
}
.share()
  1. 我們建立maxAttempt作為我們最大retry次數
  2. 這裡的error是Observable<Error>,enumerated則是會將每個元素變成<index, element>,所以我們使用flatMap將Observable<Error>的元素轉成attempt, err,也就是目前是第幾次retry跟目前的error物件。
  3. 當超出我們設定的maxAttempt時,我們就將目前的error物件包成只有一個error事件的Observable,也就是Observable.error(err)
  4. 若還沒超出,我們就回傳一個有timer的 Observable,時間則是設定 attempt*3,藉此來達到 delay 的效果
  5. Observable<Int>.timer(.seconds(attempt*3), scheduler: MainScheduler.instance)表示在n秒後,才會發出第一個元素數字0,然後接著發出.completed結束,若是加了 period,則會在發出第一個元素後,每隔 period 時間發出接下來的元素)

執行結果

2020-09-06 14:35:24.830: Call -> subscribed
2020-09-06 14:35:26.952: Call -> Event error(unknown)
2020-09-06 14:35:26.952: Call -> isDisposed
=== #0: Retry after 0 seconds ===
2020-09-06 14:35:26.952: Call -> subscribed
2020-09-06 14:35:29.128: Call -> Event error(invalid)
2020-09-06 14:35:29.128: Call -> isDisposed
=== #1: Retry after 3 seconds ===
2020-09-06 14:35:32.128: Call -> subscribed
2020-09-06 14:35:34.169: Call -> Event error(unknown)
2020-09-06 14:35:34.169: Call -> isDisposed
=== #2: Retry after 6 seconds ===
2020-09-06 14:35:40.171: Call -> subscribed
2020-09-06 14:35:42.367: Call -> Event error(unknown)
2020-09-06 14:35:42.367: Call -> isDisposed
2020-09-06 14:35:42.367: B -> Event next(unknown)

編按(2026):RxSwift 6.0 將 catchError(_:) 改名為 catch(_:)、catchErrorJustReturn(_:) 改名為 catchAndReturn(_:),本文保留寫作當時 RxSwift 5 的寫法。