ReactorKit原始碼閱讀

darrenzheng發表於2019-03-03

1. 前言

ReactorKit是建立在RxSwift生態下的一個狀態管理框架,說是框架,其實它的封裝非常輕量。本文是閱讀原始碼的一些收穫。

2. 協議和執行時

為了讓Swift的protocol extension具有 給實現協議的人動態新增一個屬性(依賴) 這個能力,它採用了runtime的實現方式。

例如給Reactor協議新增一個disposeBag變數:

protocol Reactor { ... }
extension Reactor {
    fileprivate var disposeBag: DisposeBag {
        get { return self.associatedObject(forKey: &disposeBagKey, default: DisposeBag()) }
    }
}
複製程式碼

最終呼叫的是:

objc_setAssociatedObject(self, key, object, .OBJC_ASSOCIATION_RETAIN_NONATOMIC)
複製程式碼

3. 誰來處理副作用

對於一個函式式框架來說,這點至關重要。比如Flux是通過ActionCreatorRedux是由Middlewares來真正處理這些對外界環境的不純函式(髒活累活)。

ReactorKit這邊是由Reactor裡的mutate()函式來處理副作用的。

func mutate(action: Action) -> Observable<Mutation>
複製程式碼

需要注意的是,由於他的返回值是Observable,這意味著在Action轉換到Mutation的過程中,可以非同步執行副作用來獲取結果(比如網路請求,資料庫操作)。

4. 如何修改內部狀態(State)

Reactor的核心方法(也是最長的)就是:

func createStateStream() -> Observable<State> 
複製程式碼

Reactor內宣告的大多數函式都在此方法被呼叫,狀態就是在這個方法內最終被改變的。

具體看一下他是怎麼做到的:

public func createStateStream() -> Observable<State> {
    let action = self._action.asObservable()
    let transformedAction = self.transform(action: action)
    let mutation = transformedAction
      .flatMap { [weak self] action -> Observable<Mutation> in
        guard let `self` = self else { return .empty() }
        return self.mutate(action: action).catchError { _ in .empty() }
      }
    let transformedMutation = self.transform(mutation: mutation)
    let state = transformedMutation
      .scan(self.initialState) { [weak self] state, mutation -> State in
        guard let `self` = self else { return state }
        return self.reduce(state: state, mutation: mutation)
      }
      .catchError { _ in .empty() }
      .startWith(self.initialState)
      .observeOn(MainScheduler.instance)
    let transformedState = self.transform(state: state)
      .do(onNext: { [weak self] state in
        self?.currentState = state
      })
      .replay(1)
    transformedState.connect().disposed(by: self.disposeBag)
    return transformedState
  }
複製程式碼
  • 【Action】Observable<Action>
  • 【Action】 放到transform()函式中,給使用者時機改變其序列型別
  • 【Action】 於是得到了轉換過的Observable<Action>,記作transformedAction
  • 【Action 繫結 (Action) -> Mutation】transformedAction繫結(flatMap)到mutate()函式上,mutate()的簽名是(Action) -> Observable<Mutation>,使用者的副作用在繫結過程中執行。
  • 【Mutation】 於是得到新的序列,型別為Observable<Mutation>,意味著使用者已經把資料拿到,一切就位。
  • 【Mutation】 放到transform()函式中,給使用者時機改變其序列型別
  • 【Mutation】 於是得到了轉換過的Observable<Mutation>,記作transformedMutation
  • 【(State, Mutation) -> State】 即執行reduce()方法,通過scan函式讓mutation可以不斷作用到state
  • 【State】 得到結果Observable<State>
  • 【State】 放到transform()函式中,給使用者時機改變其序列型別
  • 【State】 於是得到了轉換過的Observable<State>,記作transformedState
  • 【State】 順便修改內部的currentState
  • 【State】 返回最終結果
ReactorKit原始碼閱讀

這個過程結合這個圖看就更加清晰,這個函式(也是整個Reactor)的作用就是要做這麼一件事: Action->Mutation->State

相關文章