所有文章

RxSwift 探索之旅 · 02

Observable 的生命週期與建立方式

Observable 的 next、error、completed 生命週期、訂閱與 DisposeBag,以及 just、from、never、empty、error、create 等建立方式。

本篇目錄 · 12 個章節

什麼是Observable?

Rx的一個核心觀念就是observable(或叫sequence ),口訣就是,Everything is a SEQUENCE,大意就是在Rx的世界,都是由observable構成。

Observable的生命週期

在Rx各種教學文件上,都能看到下方的這種示意圖,所以先從看懂這張圖開始。順便也會帶一下常見的英文名詞,往後看到比較不會理解錯誤。 Completed示意圖

圖一、Completed示意圖

Error示意圖

圖二、Error示意圖

  • 橫的直線:代表時間軸(Time),往右邊箭頭代表時間前進方向
  • 圓圈:代表元素(Element),程式中稱為.next event,observable會向訂閱者發送(emit)元素,元素可以是Int、Void或是自定義的Class。
  • 豎得直線:代表完成(Completed),程式中稱為.completed event,表示對訂閱者說『元素都已經發送完畢了,不在發送任何的事件』。
  • 紅色叉叉:表示錯誤(Error),程式中稱為.error event,表示對訂閱者說『發生錯誤了』,此時,也會停止發送任何的事件。

回過頭來解釋上面第一張圖,我們可以解釋成『向訂閱者發送一個數字1,然後間隔了一下,再發送數字3跟7,然後結束了這個Observable』,第二張圖則是,『 向訂閱者發送數字1、3、7後發生錯誤』。

可以發現到,當發送.completed跟.error後,Observable就會結束(Terminated),此時任務已完成,資源就會被回收了。所以,光有Observable是沒有任何作用,需要被訂閱(Subscribe),才會開始發送元素!下面我們談談怎麼建立Observable和如何被訂閱。

怎麼建立Observable?

建立一個Observable有許多方式,這裡先用最簡單的方式,使用of建立一個有限序列,of可將多個相同型態的元素,建立成一個Observable

let observable = Observable.of(1, 3, 7)

如何訂閱Observable?

使用.subscribe來訂閱Observable,藉此來接收值得變化

let disposeBag = DisposeBag()
observable
.subscribe(onNext: { element in
print(element)
}, onError: { error in
print(error)
}, onCompleted: {
print("onCompleted")
}, onDisposed: {
print("onDisposed")
})
.disposed(by: disposeBag)

從程式碼可以對應到我們上面的描述,當訂閱者收到Observable發出的.next、.error、.completed事件時,會依據我們定義好的程式執行。執行結果如下,

1
3
7
onCompleted
onDisposed

Dispose

上個範例有提到Dispose,這是跟Observable銷毀機制有關,上個範例使用的是有限序列,所以元素發送完畢,自然接著發送.completed,但大多是專案開發時,都不是有限序列這麼簡單。

實際狀況可能是『在ViewModel有一個名為Observable<[Order]>來存訂單資料,是藉由呼叫API來取得的,另外在View以TableView呈現,所以,Observable<[Order]>要與TableView DataSource Binding一起,這樣若是重新呼叫API,資料更新,畫面也會更新』,以上的情境下,Observable某種程度算是無限的,所以就不得不考慮何時需要把Observable銷毀,下面我們來談談,Observable的銷毀機制。

想像我們有一個袋子,裡面放著球,當你把這個袋子丟掉,球也一起被丟掉了,從上個例子來看,disposeBag就是那個袋子,訂閱者就是那顆球,我們將訂閱者裝進去,當ViewController deinit時,disposeBag會跟著被銷毀,隨之訂閱者的資源也會一同銷毀,概念就是這麼簡單~

2020.11.02補充,當初在寫本篇,把Dispose跟Observer做了等號,這是不正確的,確切來說裝入袋子的是Disposable,當我們subscribe()時,就會產生一個Disposable,當今天deinit時,Observable卻還沒結束,這時裝在DisposeBag中的所有Disposable就會執行dispose(),藉此來釋放資源,感謝t19960804大大提點

如果你撰寫程式時,進行了.subscribe()卻忘記寫.disposed(),這很有可能會造成Memory leak,這時Swift compiler也會提醒你,在Xcode上會看到黃色的提醒,這時記得加上.disposed(),很貼心吧!

補充: 若想要做實驗,可以使用interval來建立一個『固定間隔時間,發送元素』的Observable

let observable = Observable<Int>.interval(.milliseconds(500), scheduler: MainScheduler.instance)

接著步驟如下:

  1. 在A ViewController畫面做一個按鈕,按下去present到 B ViewController
  2. 在B ViewController建立interval observable,並且訂閱它,列印出.next, .completed, .disposed的變化
  3. 當你按下按鈕時,應該會看到每間隔0.5秒就跑出一個數字
  4. 如果你有寫.disposed(by: disposeBag),當你關閉B ViewController會註銷Observable,應該會觸發onDisposed
  5. 如果你沒寫.disposed(by: disposeBag),當你關閉B ViewController後,仍然會繼續列印出數字,這時恭喜你Memory leak了!

其他建立Observable的方式

前面建立Observable時,用到了.of跟.interval,其實建立一個Observable有很多方式,以下介紹幾個我常用的,沒介紹到的就再請自己到ReactiveX - Operators看囉。

just

單一物件的Observable(像是String, [String]或是自訂的Student都可以),當要把一個pure value轉成Observable時就可以用,像是bool

let observable = Observable.just(true)
// — - true — - | ->

from

.from有兩個功能,

  1. .from(array: [_]),可以把陣列轉成Observable,注意一點,結果是把陣列逐一發送每個元素
let observable = Observable.from([1, 3, 7])
// - - 1 - - 3 - - 7 — - | ->
  1. .from(optional: _?),如果optional types變數不為nil,就發送
let number: Int? = 5
let observable = Observable.from(optional: number)
// - - 5 - - | -> number為5的情況
// - - | -> number為nil的情況

never

不會發送也不會結束的Observable,在一些情境可能會用到,像我自己公司是用MVVMC架構,在root coordinator的func start(),因為不會結束,所以return了一個.never()。

let observable: Observable<Int> = .never()

empty

只會發送.completed的Observable,在測試的時候會用到,或是一些情境你想快點結束Observable,可以用到。

let observable: Observable<Int> = .empty()

error

只會發送.error的Observable,在測試的時候比較常用到。

let error = NSError.init(domain: "測試", code: -1, userInfo: nil)
let observable: Observable<Int> = .error(error)

create

.create提供你客製化Observable方式,我通常會寫成function,在需要自訂成功、失敗條件時很好用,舉個例子,.isEven(number: Int)給定一個數字,判別是不是偶數,若是,就把該數字以Observable形式發送回來;若不是,就發送.error。

func isEven(number: Int) -> Observable<Int> {
// 1
return Observable.create { observer in
if number % 2 == 0 {
// 2
observer.onNext(number)
observer.onCompleted()
} else {
// 3
observer.onError(NSError.init(domain: "不是偶數", code: 401, userInfo: nil))
}
// 4
return Disposables.create()
}
}
  1. .create參數中會有一個subscribe closure,這closure有一參數為observer,並且要使用它來表達對訂閱者發送行為
  2. 用.onNext和.onCompleted來發送成功的行為
  3. 用.onError來發送失敗的行為
  4. 最後需要返回一個Disposable對象,使用它來取消訂閱,回收Observable所佔用的資源