自定义UICollectionViewLayout实现瀑布流

在移动开发中,瀑布流应该非常普及了.我一直没有完整的写过一个瀑布流,今天搜集了一些资料,看了下系统的文档,大概实现了功能.中间也碰到了一些问题,现在记录下来,一方面方便自己以后回忆,另一反面也希望能帮到大家.

要用UICollectionView实现瀑布流,自定义UICollectionViewLayout和UICollectionViewFlowLayout都可以实现.

UICollectionViewLayout是一个抽象类,是UICollectionViewFlowLayout的父类.用来配置UICollectionView的布局.

UICollectionViewFlowLayout其实是一个系统为我们写好的流水布局.通过自定义UICollectionViewFlowLayout来实现瀑布流,更方便.比如说,系统已经帮我们实现了补充视图和装饰视图.

在这里,我选择的是自定义UICollectionViewLayout来实现瀑布流.根据文档,如果要使用它,需要继承它,并且重写以下几个方法.
  • collectionViewContentSize
    • 返回collectionView的滚动范围
  • layoutAttributesForElementsInRect:
    • 返回可视范围内所有cell的布局属性
  • layoutAttributesForItemAtIndexPath:
    • 返回指定indexPath处的cell的布局属性
  • layoutAttributesForSupplementaryViewOfKind:atIndexPath:
    • 返回补充视图的布局属性(如果有补充视图)
  • layoutAttributesForDecorationViewOfKind:atIndexPath:
    • 返回装饰视图的布局属性(如果有装饰视图)
  • shouldInvalidateLayoutForBoundsChange:
    • 当视图滚动时(可视范围变化时),是否更新视图
在实际应用中,我重写了以下四个方法.调用顺序从上到下
  • prepareLayout 该方法在每次布局需要更新(当collectionView第一次显示或者当布局失效)时调用.一般在里面做一些初始化的工作,进行基本的布局.
  • collectionViewContentSize
  • layoutAttributesForElementsInRect:(CGRect)rect
  • shouldInvalidateLayoutForBoundsChange:(CGRect)newBounds
这个我有一个疑问,因为文档中提示需要重写layoutAttributesForItemAtIndexPath:方法,但是coding中,我发现这个方法从来没有调用过.我猜在UICollectionViewFlowLayout中是系统在layoutAttributesForElementsInRect:方法中调用了layoutAttributesForItemAtIndexPath:方法.而在我自定义的UICollectionViewLayout中,我并没有调用layoutAttributesForItemAtIndexPath:,因此不重写这个方法也可以实现功能.
具体思路如下:
首先一个前提就是各个cell宽度一致.根据总列数来计算cell的宽度.然后根据图片长宽比来检出cell的高度.然后,创建一个数组来保存各列cell的总高度,每次添加cell时,将cell添加到总高度最短的一列.以此类推,就可以计算出各个cell的x,y坐标.然后将各个cell的布局参数缓存起来,在需要时直接调用就行.
具体代码如下:

1.自定义UICollectionViewLayout,并开放接口,设置参数

/** 内边距 */
@property (nonatomic, assign) UIEdgeInsets sectionInsets;

/** 总列数 */
@property (nonatomic, assign) NSInteger numberOfColumns;

/** item之间的行间距 */
@property (nonatomic, assign) CGFloat minimumInteritemSpacing;

/** item之间的列间距 */
@property (nonatomic, assign) CGFloat minimumLineSpacing;

/** 代理属性 */
@property (nonatomic, weak) id<MLWaterflowLayoutDelegate> delegate;

2.定义代理属性,让代理实现获得每个cell的高度

@protocol MLWaterflowLayoutDelegate <NSObject>

/**
 计算indexPath位置上的item的高度
 @param width       item的宽度
 @param indexPath   item的位置
 @return            item的高度
 */
- (CGFloat)heightForItemWithWidth:(CGFloat) width AtIndexPath:(NSIndexPath *)indexPath;

@end

3.定义私人成员变量,用于计算

/** 存放所有item的布局属性 */
@property (nonatomic, strong) NSMutableArray *itemAttributesArray;

/** 存放所有列的高度 */
@property (nonatomic, strong) NSMutableArray *columnsHeightArray;

/** item的总数 */
@property (nonatomic, assign) NSInteger numberOfItems;

4.在prepareLayout中计算每个cell的布局,并保存

#pragma mark - 重写父类的布局方法
- (void)prepareLayout {
    NSLog(@"%s", __func__);
    [self initialColumnsHeightsArray];
    [self calculateAttributesForitems];
}

#pragma mark - 自定义方法
/** 初始化self.columnsHeightArray */
- (void)initialColumnsHeightsArray {
    //1.避免出错,先清空self.columnsHeightArray
    [self.columnsHeightArray removeAllObjects];
    //2.根据self.numberOfColumns来初始化self.columnsHeightArray
    for (NSInteger i = 0; i < self.numberOfColumns; i ++) {
        //为每一个item设置初始高度
        [self.columnsHeightArray addObject:@(self.sectionInsets.top)];
    }
}

/** 计算所有item的布局属性 */
- (void)calculateAttributesForitems {
    for (NSInteger i = 0; i < self.numberOfItems; i ++) {
        //根据总列数算出每一个item的宽度
        CGFloat itemWidth = ([UIScreen mainScreen].bounds.size.width - self.sectionInsets.left - (self.numberOfColumns - 1) * self.minimumInteritemSpacing - self.sectionInsets.right) / self.numberOfColumns;
        //拿到当前高度最小的列的索引
        NSInteger shortestIndex = [self getShortestColumnsIndex];
        //计算当前item的X坐标
        CGFloat itemX = self.sectionInsets.left + (itemWidth + self.minimumInteritemSpacing) * shortestIndex;
        //通过代理获得当前item的高度
        CGFloat itemHeight = 0;
        if ([self.delegate respondsToSelector:@selector(heightForItemWithWidth:AtIndexPath:)]) {
            itemHeight = [self.delegate heightForItemWithWidth:itemWidth AtIndexPath:[NSIndexPath indexPathForRow:i inSection:0]];
        }
        //计算当前item的Y坐标
        CGFloat itemY = [self.columnsHeightArray[shortestIndex] floatValue] + self.minimumLineSpacing;
        //将item的布局属性保存到数组
        UICollectionViewLayoutAttributes *attributes = [UICollectionViewLayoutAttributes layoutAttributesForCellWithIndexPath:[NSIndexPath indexPathForRow:i inSection:0]];
        attributes.frame = CGRectMake(itemX, itemY, itemWidth, itemHeight);
        [self.itemAttributesArray addObject:attributes];
        //将高度保存到columnsHeightArray数组中
        [self.columnsHeightArray replaceObjectAtIndex:shortestIndex withObject:@(itemY + itemHeight)];
    }
}

5.在layoutAttributesForElementsInRect中返回可见视图中的cell的布局属性

- (NSArray<UICollectionViewLayoutAttributes *> *)layoutAttributesForElementsInRect:(CGRect)rect {
    NSLog(@"%s", __func__);
    //创建一个数组来存放显示在屏幕中的item的attributes
    NSMutableArray *tempArr = [NSMutableArray array];
    //遍历self.itemAttributesArray
    for (UICollectionViewLayoutAttributes *attributes in self.itemAttributesArray) {
        //判断item是否显示在屏幕中
        if (CGRectIntersectsRect(rect, attributes.frame)) {
            //如果是,保存到tempArr
            [tempArr addObject:attributes];
        }
    }
    return tempArr;
}

6.在collectionViewContentSize中返回UICollectionView的contentSize

- (CGSize)collectionViewContentSize {
    NSLog(@"%s", __func__);
    return CGSizeMake([UIScreen mainScreen].bounds.size.width, self.sectionInsets.bottom + [self.columnsHeightArray[[self getHighestColumnsIndex]] floatValue]);
}

7.在shouldInvalidateLayoutForBoundsChange中判断在滚动时,是否需要刷新布局属性.如果需要,那么会调用prepareLayout方法,重新布局

- (BOOL)shouldInvalidateLayoutForBoundsChange:(CGRect)newBounds {
    NSLog(@"%s", __func__);
    return NO;
}

Github上demo地址

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容