
本文為投稿文章,作者:聽榆大叔(博客)。
開車不需要知道離合器如何運作,但了解原理後,車往往能開得更平穩。ReactiveCocoa 是一個功能強大的重型 FRP 框架,它大量使用內建的 block,功能強大的同時內部源碼也相當複雜。本文研究版本為 2.4.4,小版本間差異不大,無需擔憂。這裡只聚焦核心的 RACSignal 及其相關部分,重點不在逐行解釋代碼,而在探討這些核心代碼「是怎麼來的」。文中難免有疏漏,歡迎不吝指正。
信號(Signal)是一個異步數據流,即以時間為序、即將發生的事件序列,它能發射出三種東西:value、error、completed。我們可以異步地捕獲這些事件——監聽信號並針對其發出的內容做出響應。這種「監聽」行為被稱為訂閱(subscriber),我們定義的操作就是觀察者,被監聽的信號則是被觀察的主體。這正是經典的「觀察者」設計模式。
RAC 為這一訂閱行為定義了 RACSubscriber 協議,它是與 RACSignal 打交道的唯一方式。先看它的定義:
// 用於從 RACSignal 中直接接收 values 的對象 @protocol RACSubscriber @required /// 發送下一個 value 給 subscribers。value 可以為 nil。 - (void)sendNext:(id)value; /// 發送 error 給 subscribers。error 可以為 nil。 - (void)sendError:(NSError *)error; /// 發送 completed 給 subscribers。 - (void)sendCompleted; /// 先忽略這個 - (void)didSubscribeWithDisposable:(RACCompoundDisposable *)disposable; @end
我們自己來實現這個協議(本文自定義類均以「NL」開頭以示區別):
// NLSubscriber.m @implementation NLSubscriber - (void)sendNext:(id)value { NSLog(@"%s value:%@", sel_getName(_cmd), value); } - (void)sendCompleted { NSLog(@"%s", sel_getName(_cmd)); } - (void)sendError:(NSError *)error { NSLog(@"%s error:%@", sel_getName(_cmd), error); } - (void)didSubscribeWithDisposable:(RACCompoundDisposable *)disposable { // to nothing } @end這個類只關心 sendNext:、sendError: 和 sendCompleted,實現也只是簡單打印。RACSignal 提供了讓訂閱者訂閱信號的接口:
@interface RACSignal (Subscription) /* subscriber 訂閱 receiver 的變化。由 receiver 決定怎麼給 subscriber 發送事件。 */ - (RACDisposable *)subscribe:(id)subscriber; @end
用定時器信號試試:創建一個每 3 秒發出一次當前日期、共發 5 次的信號,再用 NLSubscriber 訂閱它,控制台便會依次打印出 5 個日期值與一個 completed 事件。
現在的 NLSubscriber 除了打印什麼也做不了,更談不上復用。若為每個信號都寫一個訂閱者,簡直是噩夢。改進目標有兩點:實現 RACSubscriber 協議;提供與之對應、可選、可配的接口。這正是一個「適配器」。借助 OC 的 block,我們可以把協議裡的三個方法轉為三個 block:
- (void)sendNext:(id)value; --> void (^next)(id value); - (void)sendError:(NSError *)error; --> void (^error)(NSError *error); - (void)sendCompleted; --> void (^completed)(void);
改進後的 NLSubscriber 通過 subscriberWithNext:error:completed: 暴露出三個 block 屬性,sendNext: 等方法在 @synchronized 保護下取出對應 block 並執行(為 nil 則跳過)。這樣,只要拿出這個適配器再加上自定義行為即可,對不感興趣的事件傳 nil 就行,大大解放了生產力。
能否把 NLSubscriber 徹底隱藏起來?答案是肯定的。通過 OC 的類別(Category),給 RACSignal 增加一個 nl_Subscription 類別,把訂閱操作封裝進去。這樣使用者甚至感知不到訂閱者的存在。該類別把 next、error、completed 及其各種組成都以 block 形式封裝,最終都彙聚到那個帶三個 block 參數的方法上,而它內部封裝的正是 NLSubscriber。
封裝之後,客戶使用起來極其順手,只需一行 [signalInterval nl_subscribeNext:... error:... completed:...] 即可。看到這裡是不是有點眼熟?沒錯,這正是我們平時最常用的 subscribeNext: 的由來。
不過此時仍有兩個遺留問題:一是無法隨時中斷訂閱(比如訂閱了一個無限定時器信號就永不停歇);二是訂閱完成或出錯時,沒有統一的地方做清理掃尾(比如斷開網絡連接、清空內存數據)。這就引出了下面的 Disposable。
RACDisposable 應運而生,它有兩個作用:中斷對某信號的訂閱;在訂閱結束後執行收尾任務。二者的關係是:當某個 Disposable 被「清理」後,對應訂閱者就不再接收該信號的任何事件;而當訂閱者收到任何一個信號的 error 或 completed 後,就不會再接收任何事件了。可以說,Disposable 代表「發生了一次訂閱行為」。
我們實現的 NLDisposable 提供了三要素:封裝清理任務的 block、執行清理的 -dispose 方法,以及標示是否已清理的只讀布爾屬性 disposed。它內部用 void * volatile _disposeBlock 承載清理邏輯,初始值指向 self,清理後置為 NULL,以此判斷狀態。
RACCompoundDisposable
但 NLDisposable 只面向單一訂閱關係,無法勝任「一個訂閱者訂閱多個信號並能單獨中斷其一」的場景。用數組硬維護又會陷入加鎖、遍歷、增刪的泥潭。這時 GoF 的「組合模式」提供了優雅解法:
組合模式允許你將對象組合成樹形結構來表現「整體/部分」層次結構,讓客戶以一致的方式處理個別對象與對象組合。
RAC 中的組合類叫 RACCompoundDisposable,它本質是一個「disposable 的 disposable」,dispose 時會一併清理內部所有 disposable;若它已 dispose 後再來 addDisposable:,新加入者會被立即 dispose。它內部用 OSSpinLock 保護 NSMutableArray *_disposables 與 BOOL _disposed,addDisposable:、removeDisposable: 等操作都是線程安全的。
調度器(RACScheduler)負責 RACSignal 中所有事件的傳遞,它是一個類簇,目的是簡化同步/異步/延遲事件傳遞,以及取消預定任務這兩類常見操作。幾種具體調度器:
+[NSThread sleepUntilDate:] 阻塞當前線程實現,無法取消。其調度方法返回 RACDisposable,可通過 [disposable dispose] 取消尚未執行的調度 block。
回過頭看 - (RACDisposable *)subscribe:(id)subscriber;。自定義信號對應的類是 RACDynamicSignal,RACSignal 採用類簇模式(與 NSNumber 類似,把眾多私有子類組織在公共抽象超類之下)。訂閱的難點在於「一個訂閱者訂閱多個信號並可單獨拆除」。由於 subscriber 只是一個協議而非具體類,我們無法直接給它掛屬性,於是 RAC 用「裝飾模式」破局。
裝飾模式:在不改變原類文件、不使用繼承的前提下,動態擴展對象的功能。
RACPassthroughSubscriber 正是這樣一個訂閱者裝飾器:它包裝真正的訂閱者、充當其替身,並把真實訂閱者與本次訂閱產生的 Disposable 關聯起來。在 dispose 之前,它把收到的事件原樣轉發給內部真實訂閱者;一旦 dispose,便不再轉發。它的初始化方法裡會調用 [self.innerSubscriber didSubscribeWithDisposable:self.disposable],告知對方發生了訂閱行為。
在 RACDynamicSignal 的 subscribe: 中,先創建一個代表本次訂閱的 RACCompoundDisposable,再用 RACPassthroughSubscriber 把傳入的 subscriber 包裝起來,然後在 subscriptionScheduler 上調度 self.didSubscribe(即 +createSignal 傳入的 block),把返回的 innerDisposable 加入 compoundDisposable,最後把 compoundDisposable 作為返回值拋給外部——這樣外部就能取消訂閱了。若在異步環境下 schedule block 尚未執行時就 dispose,schedulingDisposable 會被清理,block 不再執行;若在執行中或之後 dispose,則 innerDisposable 與 schedulingDisposable 都會被清理,行為完全符合預期。
a. didSubscribeWithDisposable
這個最初被刻意忽略的方法,現在正視它。當訂閱者收到 error 或 completed 後便不能再接收任何事件,此時它需要解除所有訂閱——而代表一次訂閱的正是 disposable,所以要把它傳給訂閱者。參數用 RACCompoundDisposable,是因為有些訂閱者需要動態追加清理操作。
b. NLSubscriber 結合 RACDisposable
這次改進讓 NLSubscriber 具備「終結自身訂閱能力」的本領:內部維護一個代表整體訂閱的 compoundDisposable,其 dispose 時把 next、error、completed 三個 block 置 nil;在 sendError: 與 sendCompleted 中主動 dispose 它;在 didSubscribeWithDisposable: 中把外部傳入的 otherDisposable 加入自身,並在 otherDisposable 被清理時從自身移除。如此一來,訂閱者一旦收到 error 或 completed,就能解除自身所有訂閱。
c. 改進 nl_Subscription 類別
由於之前的訂閱方法一旦訂閱就無法停止,只需讓這些方法返回 RACDisposable 即可徹底解決——內部創建 NLSubscriber 後 return [self subscribe:subscriber];。
信號的各種操作(flattenMap:、map:、filter: 等)大多輾轉調用同一個核心方法 -bind:。研究它之前,先認識兩個特殊子類:
+[RACSignal empty] 的內部實現,一旦被訂閱就立即 sendCompleted。+[RACSignal return:] 的實現,被訂閱時同步發送一個 value,接著 sendCompleted。concat: 源碼較簡單、使用頻率高,適合練手。它先訂閱 self,把 next 與 error 轉發給 subscriber,待 self 完成後再讓 subscriber 去訂閱參數 signal,並用 RACSerialDisposable 在運行時切換所持有的 disposable。這裡有個小技巧:這類操作幾乎都會訂閱 self,找到 self subscribe...` 那一行就能快速抓住主線。
zipWith: 比 concat: 稍複雜,它把 self 與 signal 兩個信號各自發出的值配對合併。實現上用兩個數組緩存各自的值,當兩邊都有值時取出各自最早的值組成 RACTuple 發給 subscriber,任一邊完成且緩存清空時發送 completed。
bind: 是眾多操作的共同底座。其 RACStreamBindBlock 從流中接收一個值並返回一個同類型的流,把 stop 置 YES 可提前終結,返回 nil 則立即終結。bind: 會把原信號的每個值都放進這個 block 裡跑一遍。其內部流程可概括為:訂閱 self,對每個值 x 執行 bindingBlock 得到 signal;若 signal 非 nil 則訂閱它並轉發其值,若為 nil 或要求 stop 則結束 self;所有信號都完成後給 subscriber 發 completed;任一信號出錯則把 error 傳給 subscriber。
基於 bind: 可以玩出很多花樣:與 RACReturnSignal 結合能原樣返回值,稍作變化把 NSDate 轉成時間戳就等於一個 map:;與 RACEmptySignal 結合,隔一個丟一個就等於 filter:。而 flattenMap: 本質就是 bind: 的簡化封裝(block 返回 nil 時用 empty 兜底),map: 則是 flattenMap: 與 RACReturnSignal 的組合。至於 flatten,當信號發出的是 RACSignal 類型(signal of signals,類似 disposable of disposables)時,直接在 flattenMap: 裡把 value 返回即可攤平。
RACSignal 的操作琳瑯滿目,無需在這裡全列。讀懂前面的解析後,再去看其他任意一個 operation 的源碼,相信你都不會再有太大障礙。
RAC 最大的魅力之一就是綁定:RAC(self, text) = signal;。它展開後大致是:
[[RACSubscriptingAssignmentTrampoline alloc] initWithTarget:(self) nilValue:nil][@"text"] = signal;
這裡的關鍵是 RACSubscriptingAssignmentTrampoline 類借助 clang 特性支持了下標 [] 語法,因此 assignment[@"text"] = signal; 等同於 [assignment setObject:signal forKeyedSubscript:@"text"]。而該方法內部其實就是調用了 signal 的 -setKeyPath:onObject:nilValue::它訂閱 signal,把發出的每個值(為 nil 時用 nilValue 兜底)通過 setValue:forKeyPath: 賦給目標對象的屬性。說穿了,RAC() 宏不過是「訂閱信號並把值綁定到某個 keyPath」的語法糖而已。
本文只研究了 RAC 的一些基礎組件,未涉及更深入的高級內容,故名「淺析」。但這些正是深入研究的基石——有了「漁」,又何愁沒有「魚」?後續還可繼續探索的主題包括:Subjects(眾多操作的基礎,難度系數 2)、RACMulticastConnection(常用,難度系數 3),以及 Foundation / UIKit / KVO 的 rac_ 擴展(能深入理解 runtime,還會接觸 NSProxy 等少用知識,難度系數 5)。難度系數僅為筆者主觀評估,僅供參考。