FDTemplateLayoutCell解析 - 哈喽比特 - https://www.hellobit.com.cn

499次阅读 | 发布于4年以前

FDTemplateLayoutCell

原理

给控件设置了约束后，要在cell里面重写sizeThatFits:方法，根据每个控件size的height计算总高度，即cell的height。这个框架重点是缓存cell height，使用的方法是runtime中的关联对象方法，做到缓存的效果。

代码解析

先来讲讲用key缓存cell height

UITableView+FDKeyedHeightCache

这是一个UITableView的分类，里面还定义了一个类，FDKeyedHeightCache，继承自NSObjct

mutableHeightsByKeyForCurrentOrientation是当前方向的缓存，类型是字典，包含一个对象（id）和数字（NSNumber，即height）

接下来看方法

根据key判断是否已经缓存了height

- (BOOL)existsHeightForKey:(id<NSCopying>)key {
    NSNumber *number = self.mutableHeightsByKeyForCurrentOrientation[key];
    return number && ![number isEqualToNumber:@-1];
}

self.mutableHeightsByKeyForCurrentOrientation是当前方向的高度数组，考虑了竖屏和横屏两种情况，currentOrientation是已经判断了，当前方向。如果number存在并且不等于-1就是已经缓存了

传入key，缓存高度

- ()void)cacheHeight:(CGFloat)height byKey:(id<NSCopying>)key {
    self.mutableHeightsByKeyForCurrentOrientation[key] = @(height);
}

直接是根据key存height

根据key取出height

- (CGFloat)heightForKey:(id<NSCopying>)key {
#if CGFLOAT_IS_DOUBLE
    return [self.mutableHeightsByKeyForCurrentOrientation[key] doubleValue];
#else
    return [self.mutableHeightsByKeyForCurrentOrientation[key] floatValue];
#endif
}

如果是double就返回double类型，float就返回float类型，这点细节都考虑到了

这两个是失效方法

- (void)invalidateHeightForKey:(id<NSCopying>)key {
    [self.mutableHeightsByKeyForPortrait removeObjectForKey:key];
    [self.mutableHeightsByKeyForLandscape removeObjectForKey:key];
}

- (void)invalidateAllHeightCache {
    [self.mutableHeightsByKeyForPortrait removeAllObjects];
    [self.mutableHeightsByKeyForLandscape removeAllObjects];
}

让缓存失效，在例如删除的时候调用

然后是分类中的方法

- (FDKeyedHeightCache *)fd_keyedHeightCache {
    FDKeyedHeightCache *cache = objc_getAssociatedObject(self, _cmd);
    if (!cache) {
        cache = [FDKeyedHeightCache new];
        objc_setAssociatedObject(self, _cmd, cache, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }
    return cache;
}

使用到了runtime中的关联对象方法，我在前面的SDWebImage中也有讲到过，很多框架都用到了。

这两个方法用的是OC中runtime方法，原理是两个文件关联方法，和上层的存储方法> 差不多，传入value和key对应，取出也是根据key取出value object传入self即可

1.设置关联方法

//传入object和key和value，policy //policy即存储方式，和声明使用几种属性大致相同，有copy,retain,copy,retain_nonatomic,assign 五种）

void objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy)

2.取出方法

//传入object和key返回value id objc_getAssociatedObject(id object, const void *key)

这里是先获得缓存对象，如果为空的还就新创建一个，再进行关联。这里用到了_cmd

_cmd是隐藏的参数，代表当前方法的selector，他和self一样都是每个方法调用时都会传入的参数，动态运行时会提及如何传的这两个参数。

经常和关联方法搭配一起用

UITableView+FDIndexPathHeightCache

一个UITableView的分类在分类里面定义了 FDIndexPathHeightCache 继承自NSObject 先来说一下这个类

typedef NSMutableArray<NSMutableArray<NSNumber *> *> FDIndexPathHeightsBySection;

FDIndexPathHeightsBySection是一个可变数组，这个可变数组里面还装着一个可变数组，里面的可变数组装着一个数字(NSNumber *)

//是否已经缓存了高度，如果是则返回YES，没有就返回NO

- (BOOL)existsHeightAtIndexPath:(NSIndexPath *)indexPath;

这个方法的判断逻辑非常非常复杂，看了很久还是很难理清。但是大概和key的差不多，只是要存的类型变了。 cacheHeight:byIndexPath:和heightForIndexPath:都和key的差不多，但是逻辑也是非常复杂，这里就不说了。然后FDIndexPathHeightCache的第一个方法，利用关联对象缓存的方法和key的一模一样，这里也不说了，说下里面的其他内容。

前面key说到失效方法，indexPath也有失效方法，而且调用更需要注意。刚开始我想，如果用indexPath缓存，中间删除了一个cell，那后面的cell height不是要全部重新计算了吗。后来我看到了作者的博客文章里面有说到。

无须担心你数据源的变化引起的缓存失效，当调用如-reloadData，-deleteRowsAtIndexPaths:withRowAnimation:等任何一个触发 UITableView 刷新机制的方法时，已有的高度缓存将以最小的代价执行失效。如删除一个 indexPath 为 [0:5] 的 cell 时，[0:0] ~ [0:4] 的高度缓存不受影响，而 [0:5] 后面所有的缓存值都向前移动一个位置。自动缓存失效机制对 UITableView > 的 9 个公有 API 都进行了分别的处理，以保证没有一次多余的高度计算。

接下来我们看看9个公有API的处理

+ (void)load {
    // All methods that trigger height cache's invalidation
    SEL selectors[] = {
        @selector(reloadData),
        @selector(insertSections:withRowAnimation:),
        @selector(deleteSections:withRowAnimation:),
        @selector(reloadSections:withRowAnimation:),
        @selector(moveSection:toSection:),
        @selector(insertRowsAtIndexPaths:withRowAnimation:),
        @selector(deleteRowsAtIndexPaths:withRowAnimation:),
        @selector(reloadRowsAtIndexPaths:withRowAnimation:),
        @selector(moveRowAtIndexPath:toIndexPath:)
    };

    for (NSUInteger index = 0; index < sizeof(selectors) / sizeof(SEL); ++index) {
        SEL originalSelector = selectors[index];
        SEL swizzledSelector = NSSelectorFromString([@"fd_" stringByAppendingString:NSStringFromSelector(originalSelector)]);
        Method originalMethod = class_getInstanceMethod(self, originalSelector);
        Method swizzledMethod = class_getInstanceMethod(self, swizzledSelector);

        method_exchangeImplementations(originalMethod, swizzledMethod);
    }
}

这是一个非常精妙的方法

定义了一个SEL类型的数组，里面放了很多方法 for循环中循环条件是 index小于方法个数，方法个数=整个数组的size/单个方法的size，然后得到数组中的每一个方法 Method是runtime中的一个结构体指针，展现的是一个方法，可以直接理解成方法类型。

class_getInstanceMethod(self,originalSelector);

是runtime中的一个方法，根据传入的类，返回一个执行的实例方法，cls传入一个类（self即为当前类），name传入一个方法

method_exchangeImplementations(Method m1,Method m2);

是runtime中的一个交换方法实现的函数，传入两个方法，交换两个方法的实现内容

这个load方法目的是数组里面的方法都会让高度换成失效，则让自己写的方法（fd头的方法）和本身的方法交换实现，即让自己写的方法实现系统对应的方法。

然后就是自己写的9个方法，这里就不放代码了。

UITableView+FDTemplateLayoutCell

这个是外部直接导入的类，我说下key对应的方法用key缓存cell height的原理是，每个model都设置一个identifier，根据这个identifer就可以知道这个model对应的cell有没被缓存过height

- (CGFloat)fd_heightForCellWithIdentifier:(NSString *)identifier cacheByKey:(id<NSCopying>)key configuration:(void (^)(id cell))configuration {
    if (!identifier || !key) {
        return 0;
    }

    // Hit cache
    if ([self.fd_keyedHeightCache existsHeightForKey:key]) {
        CGFloat cachedHeight = [self.fd_keyedHeightCache heightForKey:key];
        [self fd_debugLog:[NSString stringWithFormat:@"hit cache by key[%@] - %@", key, @(cachedHeight)]];
        return cachedHeight;
    }

    CGFloat height = [self fd_heightForCellWithIdentifier:identifier configuration:configuration];
    [self.fd_keyedHeightCache cacheHeight:height byKey:key];
    [self fd_debugLog:[NSString stringWithFormat:@"cached by key[%@] - %@", key, @(height)]];

    return height;
}

如果identifier和key都为空就返回0 然后就是调用UITableView+FDKeyedHeightCache里面的方法， existsHeightForKey: 如果已经缓存了height则用heightForKey:取出来，返回如果没有缓存过，则计算cell height，再用cacheHeight:byKey:进行缓存。

用indexPath也是这样调用。

总结

这个框架还是挺深奥的，毕竟接近5000stars，特别是indexPath的逻辑很复杂，很难理解，但是缓存cell height做的很好，我在项目中也参照了这种方法。