RxSwift + MVVM: 怎样搞定 ViewModels

简介

我们开始使用RxSwift和Model-View-ViewModel(MVVM)架构开发BlaBlaCar将近一年了。我们对于结果非常激动。我们用这个方式写的代码非常容易看懂,维护,测试以及衡量。然而,开始的几周却不是一件轻松的事情:我们不得不重复搞MVVM+RxSwift架构的某些方面让事情弄对。其中一件事就是就是给ViewModel提供输入的方式。
让我们看看两种为ViewModel提供输入(RxEvents)的不同的方法。
首先让我们过一遍ViewModel。

ViewModel

ViewModel的公共约束非常重要。你必须正确理解它(不止一个理由):

  • 它应该是可以插入到任何View上的。比如,不是先造一个View再去定义一个ViewModel的公共约束。提示一下,是View拥有ViewModel。换句话说,View知道ViewModel,而不是反过来。
  • 它应该是可测试的。最终,MVVM架构最大的好处就是让业务逻辑可测。
  • MVVM使用绑定机制更加牛逼,所以让我们利用好RxSwift。

根据经验的办法,当设计一个ViewModel约束的时候,常常把ViewModel当做一个黑盒子,接收输入,产生输出。

对于Rx,意味着ViewModel从某些流(大部分时候是View提供的)消费Events(inputs),然后产出流(给View)。
这样,可以写一个简单的协议表达任何ViewModel应该有输入和输出。

protocol ViewModelType {
  associatedtype Input
  associatedtype Output
}

于是就有了这个协议2种不同的实现。各有优缺点。

提供输入给ViewModels

Erik Meijer,Rx的作者,喜欢以纯函数式的方式思考。从这个角度,认为Subject是Rx的可变部分, E. Meijer引用资料说这样用是错误的,一点也不奇怪。大部分情况下也应该避免这么用。
这就是为什么我们初次设计ViewModel的时候避免使用Subjects。

第一种方法–不用Subject

像我说的,ViewModel是输入输出的转换。那么,我们就把转换加入到协议中:

protocol ViewModelType {
  associatedtype Input
  associatedtype Output
  
  func transform(input: Input) -> Output
}

这样就让某些点很清晰。View必须提供所有的输入(同时)给ViewModel用来计算输出。
采用这种模式的话,让我们构建一个简单的view,让用户输入名字,然后点击按钮展示一些欢迎文本。

那么,让我们思考一下这个ViewModel的输入输出。这个ViewModel,我们称它为SayHelloViewModel,需要知道用户什么时候点击了“Validate”按钮,以及用户在文本框中输入了什么文本。这两个东西作为输入。
输出只有一个,就是要展示的欢迎玩家的欢迎语。
实现如下:

final class SayHelloViewModel: ViewModelType {
  struct Input {
    let name: Observable<String>
    let validate: Observable<Void>
  }

  struct Output {
    let greeting: Driver<String>
  }

  func transform(input: Input) -> Output {
    let greeting = input.validate
      .withLatestFrom(input.name)
      .map { name in
        return "Hello \(name)!"
      }
      .startWith("")
      .asDriver(onErrorJustReturn: ":-(")

    return Output(greeting: greeting)
  }
}

欢迎语的输出计算方法如下:当“Validate”点击的时候,我们取最后一个输入框中的文本,构造一个Hello (name) 字符串。
好让我们看看View(此处是个ViewController主要为了描述简单)怎么处理ViewModel。

final class SayHelloViewController: UIViewController {
  
  @IBOutlet weak var nameTextField: UITextField!
  @IBOutlet weak var validateButton: UIButton!
  @IBOutlet weak var greetingLabel: UILabel!
  
  private let viewModel = SayHelloViewModel()
  private let bag = DisposeBag()
  
  override func viewDidLoad() {
    super.viewDidLoad()
    bindViewModel()
  }
  
  private func bindViewModel() {
    let inputs = SayHelloViewModel.Input(name: nameTextField.rx.text.orEmpty.asObservable(),
                                         validate: validateButton.rx.tap.asObservable())
    let outputs = viewModel.transform(input: inputs)
    outputs.greeting
      .drive(greetingLabel.rx.text)
      .disposed(by: bag)
  }
}

我们使用RxCocoa来获取输入在UITextFiled的名字以及获取何时按钮被点击这两个流。用这两个流很容易创建一个SayHelloViewModel.Input的实例,再把它传给ViewModel,从而得到输出。至此,View工作的很好。
之前我们提到过,ViewModel应该是可以插入到任何View的。让我们看看我们是否可以把SayHelloViewModel到另一个view上。这次我们将使用UITableView构造一个view。
同样的基于UITableView的view像这个样子:

/// TableViewCells
final class TextFieldCell: UITableViewCell {
  @IBOutlet weak var nameTextField: UITextField!
}

final class ButtonCell: UITableViewCell {
  @IBOutlet weak var validateButton: UIButton!
}

final class GreetingCell: UITableViewCell {
  @IBOutlet weak var greetingLabel: UILabel!
}

/// ViewController
final class SayHelloViewController: UIViewController, UITableViewDataSource {
    static let cellIdentifiers = [
      "TextFieldCell",
      "ButtonCell",
      "GreetingCell"
    ]

    func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
      return TableViewController.cellIdentifiers.count
    }

    func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
      // Classic dequeue work
    }

    private let viewModel = SayHelloViewModel()
    private let bag = DisposeBag()

    override func viewDidLoad() {
      super.viewDidLoad()
      bindViewModel()
    }

    private func bindViewModel() {
      // Let's discuss about this
      let inputs = SayHelloViewModel.Input(name: 😱😱, validate: 😱😱)
    }
}

现在,基于UITableView的view,有三个定制的cell。一个用于文本输入,一个用于校验按钮,一个用于Label展示。
此时,在配置好了UITableViewDataSource之后,应该可以花几分钟写bindViewModel(),应该和以前的版本一样。
等等!我们现在用的是UITableView,view的内容是懒加载和展示的,并没有方式同步获取textFiled和button的引用。换句话说,我们没法创建SayHelloViewModel.Input的实例。
使用func transform(input: Input) -> Output 函数简单,清晰。没必要会用Subject,但是依然有限制。一个带有这种接口的ViewModel只能在那些能同步获取所有资源的View上使用。因为需要用这些资源创建ViewModel的输入。
那就是当时在我看来,开始使用Subjects设计ViewModel完全可以被接受。因为这样可以适应任何view。

第二种方法–使用Subjects

现在我们知道在特定时候,不可能一次提供所有的ViewModel的输入。我们需要修改ViewModelType协议,让它更加灵活。让我们只是导出两个属性。一个是输入,一个是输出。

protocol ViewModelType {
    associatedtype Input
    associatedtype Output

    var input: Input { get }
    var output: Output { get }
}

用这种方式,View完全自由的选择何时提供Input,何时订阅输出。
在文章的前半段,我们使用transform函数创建输入输出的连接。我们现在依然需要创建一个连接,那是Subjects展示的地方。
一个Subject是一个桥,同时扮演者观察者和被观察者的角色。这是一个从命令式编程到函数式编程Rx的好的解决方案。
已知我们的ViewModel有两个输入(名字文本和校验按钮),我们需要两个Subject。从这里,很容易把上一章的ViewModel的实现移到这里从而遵循新的ViewModelType的协议。

final class SayHelloViewModel: ViewModelType {
    let input: Input
    let output: Output

    struct Input {
        let name: AnyObserver<String>
        let validate: AnyObserver<Void>
    }

    struct Output {
        let greeting: Driver<String>
    }

    private let nameSubject = ReplaySubject<String>.create(bufferSize: 1)
    private let validateSubject = PublishSubject<Void>()

    init() {
        let greeting = validateSubject
            .withLatestFrom(nameSubject)
            .map { name in
                return "Hello \(name)!"
            }
            .asDriver(onErrorJustReturn: ":-(")

        self.output = Output(greeting: greeting)
        self.input = Input(name: nameSubject.asObserver(), validate: validateSubject.asObserver())
    }
}

这里有些有趣的事情记录一下:

  • ViewModel的复杂部分(计算输出)并没有改变
  • Subject是私有的。没有非法侵入ViewModel的方式,只能通过公共的Input和output属性。
  • 这种实现满足了文章开头列出的所有需求:可以插入到任何view,容易单元测试和Rx绑定。

你可以用这个ViewModel检查最后基于UITableView的实现。

结束语

文中描述的两种方法互相兼容,可以在同一个工程中使用。然而,有时候第一种方式明显在某些view的时候不能使用。这种限制在熟悉MVVM和响应式编程的过程中不是总是清晰的。我希望这篇文章在你将来的工程中能有所帮助。

你也可以看看Kickstarter是怎样设计他们的ViewModel的。他们用ReactiveSwift的一个属性来创建输入输出的桥梁。这和我在BlaBlaCar中用Subjects的方式很像。他们是让这个属性私有然后在ViewModel初始化的时候创建所有的输出。