MVVM+RxSwift
2019-02-01 本文已影响22人
xqqlv
前言
以前对MVVM的理解和运用觉得很浅薄，在项目中用处只是对ViewController减负
- 没有做数据与View的绑定，没有做到真正的数据驱动视图
- 没有体现出MVVM易于测试的好处
- 对于RxSwift的运用也仅限于网络请求库，RxCocoa的一些优点没有运用到项目
所以是时候在项目中使用真正的MVVM了（整理出套路代码），介于项目中已经引入了RxSwift，所以就用它来实现了，在学习本文前可能会要求读者对RxSwift有一定的了解和使用。
MVVM架构图
*MVVM*架构图.png
在ViewController 里将数据源绑定到对应的View，这里只是单向绑定，在ViewModel进行网络请求等改变数据行为的操作更新Model，再由ViewModel通知View更新。至于怎么实现数据绑定的，下面会详细说明。
### MVVM目录结构
上图是项目中的一个模块，使用MVVM架构后的文件结构，Model被我集中的定义在一个公共的文件夹里了，接下来我会详细介绍。
### ViewModel
查阅了许多资料，不同人对ViewModel的实现有很多种，我这里总结了一下多数人也是我比较赞同的一种实现方法
将ViewModel理解为一个简单的黑盒子，它接受输入以产生输出，这里的输入和输出都是一个个序列。这样就能实现MVVM的最大的好处，使业务逻辑可测试。ViewModel里面主要进行网络请求、业务处理等操作。网络请求的框架我们用的是Moya，因为它可以使我们的请求得到一个序列，然后我们才可以进行数据绑定。
一般的ViewModel大概是长这样的：
```swift
import Foundation
class ViewModel {
// 输入转化输出，这里是真正的业务逻辑代码了
func transform(input: Input) -> Output {
}
}
extension ViewModel {
// 输入，类型是Driver，因为跟UI控件有关
struct Input {
}
// 输出，类型也是Driver
struct Output {
}
}
### Model
对于Model，它主要是定义一些数据模型，当然你也可以封装一些数据转换等公共的业务方法。
### ViewController和View
ViewController的主要作用是管理视图的生命周期，绑定数据和View的关系，数据绑定的实现主要是通过RxDataSources+RxSwift来实现的，所以说你的项目中要引入这两个库。RxCocoa给UI框架提供了[Rx](https://github.com/Reactive-Extensions/Rx.NET)支持，让我们能够使用按钮点击序列，这样我们就可以给ViewModel提供输入了，而[RxDataSources](https://github.com/RxSwiftCommunity/RxDataSources)能够帮助你简化书写 TabelView或 CollectionView的数据源这一过程，并且提供了通过序列更新TableView的方法，这时候我们只要把ViewModel的数据输出序列绑定到TableView的数据源序列就可以了。
### Navigator
Navigator是从ViewController剥离出来用来控制视图跳转
###
### 上代码
下图是上述目录结构中一个页面
先分析下界面上的输入和输出
输入：进入页面时的请求，重命名按钮点击，删除按钮点击，新建分组按钮点击
输出：TableView数据源，页面Loading状态
#### ViewModel核心代码：
```swift
class MenuSubGroupViewModel {
func transform(input: Input) -> Output {
let loadingTracker = ActivityIndicator()
let createNewGroup = input.createNewGroup
.flatMapLatest { _ in
self.navigator.toMenuEditGroupVC()
.saveData
.asDriverOnErrorJustComplete()
}
let renameGroup = input.cellRenameButtonTap
.flatMapLatest...
let getMenusInfo = Driver.merge(createNewGroup, input.viewDidLoad, renameGroup)
.flatMapLatest...
let deleteSubGroups = input.cellDeleteButtonTap
.flatMapLatest...
let dataSource = Driver.merge(getMenusInfo, deleteSubGroups)
let loading = loadingTracker.asDriver()
return Output(dataSource: dataSource, loading: loading)
}
}
extension MenuSubGroupViewModel {
struct Input {
let createNewGroup: Driver<Void>
let viewDidLoad: Driver<Void>
let cellDeleteButtonTap: Driver<IndexPath>
let cellRenameButtonTap: Driver<IndexPath>
}
struct Output {
let dataSource: Driver<[MenuSubGroupViewController.CellSectionModel]>
let loading: Driver<Bool>
}
}
这里可能会有人疑问为什么会保存页面的数据呢，我们的数据不是直接通过网络请求生成一个序列绑定到TableView了吗？因为在某些业务场景下我们需要保存它，比如在网络请求错误的时候，我希望页面还会继续显示之前有数据的状态，这时候我们就可以在网络请求错误的序列中塞入我们之前保存的数据，这样页面还是显示原样，还有你注意没有这个属性是private的。
ActivityIndicator：可以监听网络请求的状态从而改变loading的状态，具体实现在下面代码中已经贴出。
createNewGroup ：当点击页面上的新建分组按钮会发送一个序列作为ViewModel输入，通过flatMapLatest转换操作进入到下一页完成新建分组的操作，并将结果以序列的形式传回来。这里的saveData是一个PublishSubject类型，可接收也可发送序列，因为Driver只能接收而不能发送。如果成功就去刷新页面。
viewDidLoad：当ViewController调用viewDidLoad的方法的时候会发送一个序列作为ViewModel输入，通过transform转化dataSource输出去更新TableView。
cellDeleteButtonTap和cellRenameButtonTap： 点击cell中的按钮，会发出一个序列作为ViewModel输入，然后执行相应的业务代码，最后产生输出。
dataSource：TableView数据源序列，发生改变会去刷新TableView。
loading：控制页面loading状态的序列
ActivityIndicator核心代码
public class ActivityIndicator: SharedSequenceConvertibleType {
fileprivate func trackActivityOfObservable<O: ObservableConvertibleType>(_ source: O) -> Observable<O.E> {
return Observable.using({ () -> ActivityToken<O.E> in
self.increment()
return ActivityToken(source: source.asObservable(), disposeAction: self.decrement)
}) { activity in
return activity.asObservable()
}
}
private func increment() {
lock.lock()
value += 1
subject.onNext(value)
lock.unlock()
}
private func decrement() {
lock.lock()
value -= 1
subject.onNext(value)
lock.unlock()
}
}
ViewController中的核心代码
import UIKit
class MenuSubGroupViewController: UIViewController {
private let cellDeleteButtonTap = PublishSubject<IndexPath>() // 删除分组序列，cell中删除按钮点击时调用onNext方法发送序列
private let cellRenameButtonTap = PublishSubject<IndexPath>() // 分组重命名序列，cell中重命名按钮点击时调用onNext方法发送序列
// 初始化ViewModel的输入序列并进行ViewModel的输出序列绑定到View
func bindViewModel() {
let viewDidLoad = Driver<Void>.just(())
let input = MenuSubGroupViewModel.Input(viewDidLoad: viewDidLoad,...)
let output = viewModel.transform(input: input)
output.loading..
output.dataSource
.drive(tableView.rx.items(dataSource: dataSource))
.disposed(by: disposeBag)
}
private lazy var dataSource: RxTableViewSectionedReloadDataSource<CellSectionModel> = {
return RxTableViewSectionedReloadDataSource<CellSectionModel>(configureCell: { [weak self](_, tableView, indexPath, item) -> UITableViewCell in
let cell: LabelButtonCell = tableView.dequeueReusableCell(LabelButtonCell.self)
...
cell.rightButton1.rx.tap
.subscribe(onNext: { [weak self] (_) in
self?.cellDeleteButtonTap.onNext(indexPath)
})
.disposed(by: cell.disposeBag)
cell.rightButton2.rx.tap...
return cell
})
}()
}
在这里RxDataSources的使用方法我就不再详细叙述了，所以说我们主要关注bindViewModel的方法，里面定义了页面的各种输入，并通过transform方法等得到输出的序列，再对TableView的数据源进行绑定。RxCocoa为我们提供了很多系统基础控件的Rx调用，可以很方便的进行数据绑定。
Navigator中的核心代码
class MenuSubGroupNavigator: BaseNavigator {
func toMenuEditGroupVC(menuUid: String, dishGroupsInfo: DishGroupInfo? = nil) -> MenuEditGroupViewController {
let navigator = MenuEditGroupNavigator(navigationController: navigationController)
let viewModel = MenuEditGroupViewModel(navigator: navigator,
menuUid: menuUid,
dishGroupsInfo: dishGroupsInfo)
let vc = MenuEditGroupViewController()
vc.viewModel = viewModel
navigationController?.pushViewController(vc, animated: true)
return vc
}
}
总结
- 要搭建一个上述的MVVM项目，RxSwift，RxDataSources，Moya是必不可少的，并且你要会用RxDataSource创建UITableView数据源，对RxSwift要有一定的了解。
- 在项目中对cell中的点击事件的处理方式是在ViewController里创建一个PublishSubject的序列，然后在事件回调或监听处主动调用onNext方法。
- 对于页面loading，无数据，无网等状态可以分别封装ViewController的Rx属性，然后通过ActivityIndicator可以监听网络请求的状态，发送序列从而改变页面状态。
- 上述的MVVM项目的很多操作都是通过序列来完成的，发生错误时可能不好定位。
源码地址，不过大家可以参考下GitHub上的CleanArchitectureRxSwift。
