一.什么是LPDMvvmKit

LPDMvvmKit是对MVVM框架的封装，提供了一些常用的工具类以及很轻巧的控件，对MVVM各个层的分类定义以及封装性都相对良好。这篇文章，我们从该框架对TableView的封装来解读该框架的思想。

二.UITableView的弊端

1.枚举的滥用

讲到TableView，最常见的就是它众多的枚举，包含UITableViewStyle，UITableViewCellStyle以及UITableViewCellSeparatorStyle等等众多枚举。众所周知，枚举是为了扩展而存在的。但是在整个TableView的设计中，完全与该点违背。我们详细看一下UITableViewCellStyle的枚举使用。以下为UITableViewCellStyle的枚举定义：

typedef NS_ENUM(NSInteger, UITableViewCellStyle) {
  UITableViewCellStyleDefault,    // Simple cell with text label and optional image view (behavior of UITableViewCell in iPhoneOS 2.x)
  UITableViewCellStyleValue1,     // Left aligned label on left and right aligned label on right with blue text (Used in Settings)
  UITableViewCellStyleValue2,     // Right aligned label on left with blue text and left aligned label on right (Used in Phone/Contacts)
  UITableViewCellStyleSubtitle    // Left aligned label on top and left aligned label on bottom with gray text (Used in iPod).
};             // available in iPhone OS 3.0

在该枚举中，列举了四种不同类型的CellStyle。最为关键的是，在UITableViewCell的初始化方法中居然也携带了UITableViewCellStyle参数，先看一下初始化代码：

// Designated initializer.  If the cell can be reused, you must pass in a reuse identifier.  You should use the same reuse identifier for all cells of the same form.  
- (instancetype)initWithStyle:(UITableViewCellStyle)style reuseIdentifier:(nullable NSString *)reuseIdentifier NS_AVAILABLE_IOS(3_0) NS_DESIGNATED_INITIALIZER;

UITableViewCell作为Cell的基类，在该基类的基础上实行扩展是必须的，根据各自的业务不同，枚举中的UITableViewCellStyle根本满足不了实际的需求，但是在初始方法中居然要求携带该参数，这样以来就破坏了初始化函数，限制了扩展性，以此来看，这种设计弊端很大。并且从枚举的命名中，不看具体注释根本不知所云。

2.委托的乱用

使用UITableView最常见的除了枚举，剩下的就是各种代理了，包含UITableViewDelegate，UITableViewDataSource，以及UITableViewDataSourcePrefetching。整体看这些协议的设计都缺少系统的架构，仅仅是为了解决问题强行暴露的协议方法。也可能作为系统基础框架，初期并没有考虑那么多，随着时间延续，不断的解决新问题造成了这种情况（这波洗白显然对于Apple这种巨型公司无效）。比如在UITableViewDelegate声明中，该协议担任的角色或者说处理的问题太多了。

@protocol UITableViewDelegate<NSObject, UIScrollViewDelegate>
@optional

// Display customization

- (void)tableView:(UITableView *)tableView willDisplayCell:(UITableViewCell *)cell forRowAtIndexPath:(NSIndexPath *)indexPath;
- (void)tableView:(UITableView *)tableView willDisplayHeaderView:(UIView *)view forSection:(NSInteger)section NS_AVAILABLE_IOS(6_0);
- (void)tableView:(UITableView *)tableView willDisplayFooterView:(UIView *)view forSection:(NSInteger)section NS_AVAILABLE_IOS(6_0);
- (void)tableView:(UITableView *)tableView didEndDisplayingCell:(UITableViewCell *)cell forRowAtIndexPath:(NSIndexPath*)indexPath NS_AVAILABLE_IOS(6_0);
- (void)tableView:(UITableView *)tableView didEndDisplayingHeaderView:(UIView *)view forSection:(NSInteger)section NS_AVAILABLE_IOS(6_0);
- (void)tableView:(UITableView *)tableView didEndDisplayingFooterView:(UIView *)view forSection:(NSInteger)section NS_AVAILABLE_IOS(6_0);
...

就像上面的代理方法，都是跟cell、页眉或者页脚相关的，但是没有任何划分的全部写在了UITableViewDelegate，并且很不负责任的写了个@optional就草草了事。该协议的代理方法太多也太杂，不符合职责单一原则，针对这种情况我们应该进行细分处理，比如可以设计一个新的协议跟UIView基类(类似UICollectionView的UICollectionReusableView)，由该基类遵守新协议，进而进行划分。

并且在UITableViewDelegate中还存在很多类似UITableViewDataSource的数据源方法，就算做不到细分，至少相同功能的代理方法要整合到一起，这样使用者才会更加方便快捷的进行编码。比如页眉、页脚的数据源跟cell的数据源应该是平等的存在，却放到UITableViewDelegate中，这就使开发者产生迷惑。如同以下的代理方法同样是对数据的处理，却放在了UITableViewDelegate中：

// Variable height support

- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath;
- (CGFloat)tableView:(UITableView *)tableView heightForHeaderInSection:(NSInteger)section;
- (CGFloat)tableView:(UITableView *)tableView heightForFooterInSection:(NSInteger)section;

// Use the estimatedHeight methods to quickly calcuate guessed values which will allow for fast load times of the table.
// If these methods are implemented, the above -tableView:heightForXXX calls will be deferred until views are ready to be displayed, so more expensive logic can be placed there.
- (CGFloat)tableView:(UITableView *)tableView estimatedHeightForRowAtIndexPath:(NSIndexPath *)indexPath NS_AVAILABLE_IOS(7_0);
- (CGFloat)tableView:(UITableView *)tableView estimatedHeightForHeaderInSection:(NSInteger)section NS_AVAILABLE_IOS(7_0);
- (CGFloat)tableView:(UITableView *)tableView estimatedHeightForFooterInSection:(NSInteger)section NS_AVAILABLE_IOS(7_0);

// Section header & footer information. Views are preferred over title should you decide to provide both

- (nullable UIView *)tableView:(UITableView *)tableView viewForHeaderInSection:(NSInteger)section;   // custom view for header. will be adjusted to default or specified header height
- (nullable UIView *)tableView:(UITableView *)tableView viewForFooterInSection:(NSInteger)section;   // custom view for footer. will be adjusted to default or specified footer height

三.解决方案

LPDMvvmKit对于TableView的封装主要是引入了MVVM设计思想，为UITableView添加对应的ViewModel，有了ViewModel，则可以引入数据驱动的方式，当我们需要为Cell、页眉、页脚提供DataSource时，只需要调用LPDTableViewModelProtocl中的方法就可以，接口的粒度比较细。在Cell、页眉、页脚也存在相应的ViewModel，当我们关心DataSource或者Delegate时，我们只需要跟对应的ViewModel交互即可，将Cell、页眉、页脚解耦合。
其次就是引入了ReactiveCocoa框架，将UITableView中的代理方法转化成RACSignal信号，当我们需要实现某一个委托函数，只需要订阅对应的RACSignal即可，不订阅没有任何副作用。在后续的分析中，我们会有对应的截图说明。
到此，我们简单的陈述了LPDMvvmKit对于TableView封装的基本思想，接下来我们主要看一下协议以及ViewModel的主要设计部分。

协议类

LPDTableViewModelProtocol
该协议是 TableView的ViewModel遵守的协议，在该协议中将系统UITableView的数据源以及代理方法统一整合到一起，以下为部分代码截图:

@required

#pragma mark - read data methods   数据源方法封装

- (nullable NSIndexPath *)indexPathForCellViewModel:(__kindof id<LPDTableItemViewModelProtocol>)cellViewModel;

- (nullable __kindof id<LPDTableItemViewModelProtocol>)cellViewModelFromIndexPath:(NSIndexPath *)indexPath;

- (NSInteger)sectionIndexForHeaderViewModel:(__kindof id<LPDTableItemViewModelProtocol>)headerViewModel;

- (nullable __kindof id<LPDTableItemViewModelProtocol>)headerViewModelFromSection:(NSInteger)sectionIndex;

- (NSInteger)sectionIndexForFooterViewModel:(__kindof id<LPDTableItemViewModelProtocol>)footerViewModel;
...

#pragma mark - scrollToRow methods  滚动事件方法封装

- (void)scrollToCellAtIndexPath:(NSIndexPath *)indexPath atScrollPosition:(UITableViewScrollPosition)scrollPosition animated:(BOOL)animated;

- (void)scrollToNearestSelectedCellAtScrollPosition:(UITableViewScrollPosition)scrollPosition animated:(BOOL)animated;

#pragma mark - add cells methods 各种姿势的添加cell方法封装

/**
 *  @brief 添加cellViewModel到最后一个section，如果不存在section默认添加一个section
 *
 *  @param cellViewModel 同一个cellViewModel不可添加多次
 */
- (void)addCellViewModel:(__kindof id<LPDTableItemViewModelProtocol>)cellViewModel;

/**
 *  @brief 添加cellViewModel到最后一个section，如果不存在section默认添加一个section
 *
 *  @param cellViewModel 同一个cellViewModel不可添加多次
 *  @param animation      animation
 */
- (void)addCellViewModel:(__kindof id<LPDTableItemViewModelProtocol>)cellViewModel
        withRowAnimation:(UITableViewRowAnimation)animation;
...
#pragma mark - reload cells methods  各种姿势的刷新cell方法封装
...
#pragma mark - remove cells methods   各种姿势的删除cell方法封装
...
#pragma mark - replace cells methods  各种姿势的替换cell方法封装
...
#pragma mark - add section methods  各种姿势的添加section方法封装
...
#pragma mark - reload section methods 各种姿势的刷新section方法封装
...
#pragma mark - remove section methods 各种姿势的删除section方法封装
...
#pragma mark - replace section methods 各种姿势的替换section方法封装
...
#pragma mark - action signals 封装的各种动作信号

@property (nonatomic, strong, readonly) RACSignal *willDisplayCellSignal;
@property (nonatomic, strong, readonly) RACSignal *willDisplayHeaderViewSignal;
@property (nonatomic, strong, readonly) RACSignal *willDisplayFooterViewSignal;
@property (nonatomic, strong, readonly) RACSignal *didEndDisplayingCellSignal;
@property (nonatomic, strong, readonly) RACSignal *didEndDisplayingHeaderViewSignal;
...

LPDTableViewProtocol
然后是TableView的协议，该协议的主要作用就是绑定ViewModel，不再做赘述。

@protocol LPDTableViewProtocol <NSObject>
@required

@property (nullable, nonatomic, weak, readonly) __kindof id<LPDTableViewModelProtocol> viewModel;

- (void)bindingTo:(__kindof id<LPDTableViewModelProtocol>)viewModel;

@end

LPDTableItemViewModelProtocol、LPDTableViewItemProtocol以及LPDTableSectionViewModelProtocol
然后剩下的三个协议是为cell、sectionHeaderView以及sectionFooterView服务。简单看一下LPDTableItemViewModelProtocol的声明：

@protocol LPDTableViewModelProtocol;

@protocol LPDTableItemViewModelProtocol<NSObject>

@required

- (instancetype)initWithViewModel:(__kindof id<LPDTableViewModelProtocol>)viewModel;

@property (nullable, nonatomic, weak, readonly) __kindof id<LPDTableViewModelProtocol> viewModel;

@property (nonatomic, copy, readonly) NSString *reuseIdentifier;

@property (nonatomic, copy, readonly) NSString *reuseViewClass;

@optional

@property (nonatomic, assign) CGFloat height;

@end

具体类

LPDTableViewModel

table中的ViewModel，也是核心部分。首先看一下声明文件。LPDTableViewModel是遵守<LPDTableViewModelProtocol>协议的NSObject的子类，在其内部持有tableViewModelSections数组。

@interface LPDTableViewModel : NSObject <LPDTableViewModelProtocol>

@property (readonly, nonatomic, getter = getSections) NSArray *tableViewModelSections;

+ (instancetype) new NS_UNAVAILABLE;

@end

接下来，看一下具体的实现内容。先是在实现文件中，声明了两个类，对应绑定viewModel。

@interface LPDTableViewDelegate : NSObject <UITableViewDelegate>

+ (instancetype) new NS_UNAVAILABLE;
- (instancetype)init NS_UNAVAILABLE;

- (instancetype)initWithViewModel:(__kindof LPDTableViewModel *)viewModel;

@property (nullable, nonatomic, weak, readonly) __kindof LPDTableViewModel *viewModel;

@end


@interface LPDTableViewDataSource : NSObject <UITableViewDataSource>

+ (instancetype) new NS_UNAVAILABLE;
- (instancetype)init NS_UNAVAILABLE;

- (instancetype)initWithViewModel:(__kindof LPDTableViewModel *)viewModel;

@property (nullable, nonatomic, weak, readonly) __kindof LPDTableViewModel *viewModel;

@end

然后在LPDTableViewModel类的实现中，进行绑定。

@implementation LPDTableViewModel {

  id<UITableViewDelegate> _delegate;
  id<UITableViewDataSource> _dataSource;
}

- (NSArray *)getSections {
    return [NSArray arrayWithArray:_sections];
}

- (instancetype)init {
  if (self = [super init]) {
    _delegate = [[LPDTableViewDelegate alloc] initWithViewModel:self];
    _dataSource = [[LPDTableViewDataSource alloc] initWithViewModel:self];
    self.tableViewFactory = [[LPDTableViewFactory alloc] init];
  }
  return self;
}

在该类的实现中，同时声明了众多RACSubject信号，这些信号将tableView的数据源以及代理进行封装，以供后续使用。

@property (nonatomic, strong) RACSubject *reloadDataSubject;
@property (nonatomic, strong) RACSubject *scrollToRowAtIndexPathSubject;
@property (nonatomic, strong) RACSubject *scrollToNearestSelectedRowSubject;

@property (nonatomic, strong) RACSubject *insertSectionsSubject;
@property (nonatomic, strong) RACSubject *deleteSectionsSubject;
@property (nonatomic, strong) RACSubject *replaceSectionsSubject;
@property (nonatomic, strong) RACSubject *reloadSectionsSubject;
...
...
...

接下来，就是实现LPDTableViewModelProtocol协议的众多代理方法。具体实现请直接参阅源码，在此不做赘述。

#pragma mark - read data methods

- (nullable NSIndexPath *)indexPathForCellViewModel:(__kindof id<LPDTableItemViewModelProtocol>)cellViewModel;

- (nullable __kindof id<LPDTableItemViewModelProtocol>)cellViewModelFromIndexPath:(NSIndexPath *)indexPath;

- (NSInteger)sectionIndexForHeaderViewModel:(__kindof id<LPDTableItemViewModelProtocol>)headerViewModel;

- (nullable __kindof id<LPDTableItemViewModelProtocol>)headerViewModelFromSection:(NSInteger)sectionIndex;

- (NSInteger)sectionIndexForFooterViewModel:(__kindof id<LPDTableItemViewModelProtocol>)footerViewModel;

- (nullable __kindof id<LPDTableItemViewModelProtocol>)footerViewModelFromSection:(NSInteger)sectionIndex;

#pragma mark - scrollToRow methods

- (void)scrollToCellAtIndexPath:(NSIndexPath *)indexPath atScrollPosition:(UITableViewScrollPosition)scrollPosition animated:(BOOL)animated;

- (void)scrollToNearestSelectedCellAtScrollPosition:(UITableViewScrollPosition)scrollPosition animated:(BOOL)animated;

#pragma mark - add cells methods
...
...
...

最后，该类的工作是对信号的getting实现，请看如下代码。

- (RACSignal *)reloadDataSignal {
  return _reloadDataSubject ?: (_reloadDataSubject = [[RACSubject subject] setNameWithFormat:@"reloadDataSignal"]);
}

- (RACSignal *)scrollToRowAtIndexPathSignal {
    return _scrollToRowAtIndexPathSubject
           ?: (_scrollToRowAtIndexPathSubject = [[RACSubject subject] setNameWithFormat:@"scrollToRowAtIndexPathSignal"]);
}

- (RACSignal *)scrollToNearestSelectedRowSignal {
    return _scrollToNearestSelectedRowSubject
    ?: (_scrollToNearestSelectedRowSubject = [[RACSubject subject] setNameWithFormat:@"scrollToNearestSelectedRowSignal"]);
}

- (RACSignal *)insertSectionsSignal {
  return _insertSectionsSubject
           ?: (_insertSectionsSubject = [[RACSubject subject] setNameWithFormat:@"insertSectionsSignal"]);
}

- (RACSignal *)deleteSectionsSignal {
  return _deleteSectionsSubject
           ?: (_deleteSectionsSubject = [[RACSubject subject] setNameWithFormat:@"deleteSectionsSignal"]);
}

- (RACSignal *)replaceSectionsSignal {
  return _replaceSectionsSubject
           ?: (_replaceSectionsSubject = [[RACSubject subject] setNameWithFormat:@"replaceSectionsSignal"]);
}
...
...
...

截止到此，该类的工作基本完成。后续是对LPDTableViewDataSource以及LPDTableViewDelegate两个类的实现，即对tableViewDataSource以及TableViewDelegate的二次封装。我们看一下LPDTableViewDataSource的具体代码。

@interface LPDTableViewDataSource ()

@property (nullable, nonatomic, weak, readwrite) __kindof LPDTableViewModel *viewModel;

@end

@implementation LPDTableViewDataSource

- (instancetype)initWithViewModel:(__kindof LPDTableViewModel *)viewModel {
  if (self = [super init]) {
    self.viewModel = viewModel;
  }
  return self;
}

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView {
  return self.viewModel.sections.count;
}

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
  //  NSParameterAssert((NSUInteger)section < self.viewModel.sections.count || 0 == self.viewModel.sections.count);
  if ((NSUInteger)section < self.viewModel.sections.count) {
    return [self.viewModel.sections objectAtIndex:section].rows.count;
  } else {
    return 0;
  }
}

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
  UITableViewCell *cell = (UITableViewCell *)[self.viewModel.tableViewFactory tableViewModel:self.viewModel
                                                                            cellForTableView:tableView
                                                                                 atIndexPath:indexPath];
  return cell;
}

@end

LPDTableView

首先，看一下声明文件，是一个遵守<LPDTableViewProtocol>协议的UITableView

@interface LPDTableView : UITableView <LPDTableViewProtocol>

+ (instancetype) new NS_UNAVAILABLE;
- (instancetype)init NS_UNAVAILABLE;

@end

接着，看一下LPDTableView的实现文件。

@interface LPDTableView ()

@property (nullable, nonatomic, weak, readwrite) __kindof id<LPDTableViewModelProtocol> viewModel;

@end

@implementation LPDTableView

- (void)bindingTo:(__kindof id<LPDTableViewModelProtocol>)viewModel {
    NSParameterAssert(viewModel);
    
    self.sectionHeaderHeight = 0.1;
    self.sectionFooterHeight = 0.1;
    
    self.viewModel = viewModel;
    
    LPDTableViewModel *tableViewModel = (LPDTableViewModel*)self.viewModel;
    super.delegate = tableViewModel.delegate;
    super.dataSource = tableViewModel.dataSource;
    
    @weakify(self);
    [[[tableViewModel.reloadDataSignal takeUntil:[self rac_signalForSelector:@selector(removeFromSuperview)]]
      deliverOnMainThread] subscribeNext:^(RACTuple *tuple) {
        @strongify(self);
        [self reloadData];
    }];
    
    [[[tableViewModel.scrollToRowAtIndexPathSignal takeUntil:[self rac_signalForSelector:@selector(removeFromSuperview)]]
      deliverOnMainThread] subscribeNext:^(RACTuple *tuple) {
        @strongify(self);
        [self scrollToRowAtIndexPath:tuple.first atScrollPosition:[tuple.second integerValue] animated:[tuple.third boolValue]];
    }];

    [[[tableViewModel.scrollToNearestSelectedRowSignal takeUntil:[self rac_signalForSelector:@selector(removeFromSuperview)]]
      deliverOnMainThread] subscribeNext:^(RACTuple *tuple) {
        @strongify(self);
        [self scrollToNearestSelectedRowAtScrollPosition:[tuple.first integerValue] animated:[tuple.second boolValue]];
    }];
    ...
    ...
    ...

好的，关于LPDMvvmKit对TableView的封装解析到此。具体请下载lpd-mvvm-kit，看看其中的tableview相关的demo，当然目前只能在lpd-mvvm-kit这个框架下去用。