Instagram 开源IGListKit学习

一、IGListKit简介

IGListKit.png

IGListKit是Instagram推出的新的UICollectionView框架，使用数据驱动，旨在创造一个更快更灵活的列表控件。这个框架设计的非常好，完美符合高内聚、低耦合。
github地址：https://github.com/Instagram/IGListKit

二、IGListKit Feature

• 不要再调用 performBatchUpdates(_:, completion:) 或者 reloadData() 。
• 具有可重用的单元和组件的更好的体系结构
• 创建具有多个数据类型的集合
• 解耦的差异算法
• 充分的单元测试
• 为你的模块自定义你的差异行为
• 可扩展的API
• 使用Objective-C编写，具有全Swift互操作支持

三、IGListKit应用

我们在使用IGListKit过程中，会发现不用在ViewController中实现UICollectionDataSource和UICollectionViewDelegate协议，取而代之的是SectionController来实现对应的方法:

- (NSInteger)numberOfItems {
    return 3;
}

- (CGSize)sizeForItemAtIndex:(NSInteger)index {
    return CGSizeMake(self.collectionContext.containerSize.width, 55);
}

- (UICollectionViewCell *)cellForItemAtIndex:(NSInteger)index {
    LabelCollectionViewCell *cell = [self.collectionContext dequeueReusableCellOfClass:NSClassFromString(@"LabelCollectionViewCell") forSectionController:self atIndex:index];
    cell.text = [NSString stringWithFormat:@"%@ section:%ld  cell:%ld", self.object.name, self.section, index];
    return cell;
}

IGListAdapter 初始化方法有 3 个参数：

• updater 是一个实现了 IGListUpdatingDelegate 协议的对象, 它负责处理 row 和 section 的刷新。IGListAdapterUpdater 有一个默认实现，刚好给我们用。
• viewController 是一个 UIViewController ，它拥有这个 adapter。 这个 view controller 后面会用于导航到别的 view controllers。
• workingRangeSize 是 warking range 的大小。允许你为那些不在可见范围内的 section 准备内容。
  这是IGListKit结构：

image.png

adapter.collectionView = collectionView
adapter.dataSource = self

这会将 collectionView 和 adapter 联系在一起。还将 self 设置为 adapter 的数据源,即遵守 IGListAdapterDataSource 协议。
UICollectionDataSource和UICollectionViewDelegate在adapter中指定相应的代理：

- (void)setCollectionView:(UICollectionView *)collectionView {
    IGAssertMainThread();
    if (_collectionView != collectionView || _collectionView.dataSource != self) {
        static NSMapTable<UICollectionView *, IGListAdapter *> *globalCollectionViewAdapterMap = nil;
        if (globalCollectionViewAdapterMap == nil) {
            globalCollectionViewAdapterMap = [NSMapTable weakToWeakObjectsMapTable];
        }
        [globalCollectionViewAdapterMap removeObjectForKey:_collectionView];
        [[globalCollectionViewAdapterMap objectForKey:collectionView] setCollectionView:nil];
        [globalCollectionViewAdapterMap setObject:self forKey:collectionView];
        _registeredCellClasses = [NSMutableSet new];
        _registeredNibNames = [NSMutableSet new];
        _registeredSupplementaryViewIdentifiers = [NSMutableSet new];
        _registeredSupplementaryViewNibNames = [NSMutableSet new];
        _collectionView = collectionView;
        _collectionView.dataSource = self;
        [_collectionView.collectionViewLayout invalidateLayout];
        [self updateCollectionViewDelegate];
        [self updateAfterPublicSettingsChange];
    }
}

在IGListAdapter+UICollectionView中我们可以看到SectionController与UICollectionDataSource联系在一起:

- (NSInteger)numberOfSectionsInCollectionView:(UICollectionView *)collectionView {
    return self.sectionMap.objects.count;
}
- (NSInteger)collectionView:(UICollectionView *)collectionView numberOfItemsInSection:(NSInteger)section {
    IGListSectionController * sectionController = [self sectionControllerForSection:section];
    IGAssert(sectionController != nil, @"Nil section controller for section %zi for item %@. Check your -diffIdentifier and -isEqual: implementations.",
            section, [self.sectionMap objectForSection:section]);
    const NSInteger numberOfItems = [sectionController numberOfItems];
    IGAssert(numberOfItems >= 0, @"Cannot return negative number of items %zi for section controller %@.", numberOfItems, sectionController);
    return numberOfItems;
}
- (UICollectionViewCell *)collectionView:(UICollectionView *)collectionView cellForItemAtIndexPath:(NSIndexPath *)indexPath {
    IGListSectionController *sectionController = [self sectionControllerForSection:indexPath.section];
    _isDequeuingCell = YES;
    UICollectionViewCell *cell = [sectionController cellForItemAtIndex:indexPath.item];
    _isDequeuingCell = NO;
    IGAssert(cell != nil, @"Returned a nil cell at indexPath <%@> from section controller: <%@>", indexPath, sectionController);
    [self mapView:cell toSectionController:sectionController];
    return cell;
}

三、IGListDiffable and Equality

IGListDiffable使用的是Paul Heckel 的A technique for isolating differences between files 的算法，简单来说这个算法就是计算collectionView前后数据变化增删改移关系的一个算法，算是IGListKit的特色特点之一 。

实现差异比较需要自定义model遵守IGListDiffable协议并实现
- (nonnull id<NSObject>)diffIdentifier 和- (BOOL)isEqualToDiffableObject:(nullable id<IGListDiffable>)object两个方法。

四、Working Range

Working Range是我们可以指定左右的Working区间，干一些准备工作，比如下载图片。

Working Range 方法：

/**
通知代理Section Controller将要进入Working Range。
 */
- (void)listAdapter:(IGListAdapter *)listAdapter sectionControllerWillEnterWorkingRange:(IGListSectionController *)sectionController;

/**
通知代理Section Controller退出Working Range。
 */
- (void)listAdapter:(IGListAdapter *)listAdapter sectionControllerDidExitWorkingRange:(IGListSectionController *)sectionController;

image.png image.png