一个实现极为简单的约束框架

<a name="table-content"></a>目录

<a name="reason-for-this"></a> 起因

开发 iOS SDK 经常需要注意引入的开源代码或者定义的类名和方法名,可能会和用户代码冲突。所以一般的做法是类名,类别方法名加前缀。

最近在开发 SDK 的时候需要写一点界面,所以在思考用什么来布局。考虑使用 Masonry。但是引入 Masonry 需要对 Masonry 里面所有类、类别方法加前缀,成本太大,引入错误风险太高。同时 SDK 里面的界面通常比较简单,数量也比较少,引入一个 Masonry 反而会增大编译出来的二进制文件大小,不太值得。所以我就在思考如何设计一个代码精简的,类似 Masonry 的约束框架呢?

↑目录

<a name="result-for-this"></a> 结果

在阅读了 Masonry 的代码之后,我决定仿照它来重新写一个精简的约束框架,这里的精简是代码量极少。所以就有了后面的 DLSimpleAutolayout。这个约束框架代码总量大约只有300行。但是使用方式基本和 Masonry 类似,下面是 DLSimpleAutolayout 写出来的布局代码样式。

UIEdgeInsets padding = UIEdgeInsetsMake(10, 10, 10, 10);
@[
 view1.dl_top.equalTo(superview).offset(padding.top),
 view1.dl_left.equalTo(superview).offset(padding.left),
 view1.dl_bottom.equalTo(superview).offset(-padding.bottom),
 view1.dl_right.equalTo(superview).offset(-padding.right),
].dl_constraint_install();

↑目录


<a name="how-to-encapsulate-autolayout"></a> 如何封装 autolayout

下面我会循序渐进地讲解为什么,以及如何封装 autolayout

<a name="problem-about-original-api"></a> 使用原生约束 API 的问题

在 iOS 上面使用原生约束写代码是极为繁琐的一件事。比如下面这样的原生约束代码(来自 Masonry README.md):

UIView *superview = self.view;

UIView *view1 = [[UIView alloc] init];
view1.translatesAutoresizingMaskIntoConstraints = NO;
view1.backgroundColor = [UIColor greenColor];
[superview addSubview:view1];

UIEdgeInsets padding = UIEdgeInsetsMake(10, 10, 10, 10);

[superview addConstraints:@[

    //view1 constraints
    [NSLayoutConstraint constraintWithItem:view1
                                 attribute:NSLayoutAttributeTop
                                 relatedBy:NSLayoutRelationEqual
                                    toItem:superview
                                 attribute:NSLayoutAttributeTop
                                multiplier:1.0
                                  constant:padding.top],

    [NSLayoutConstraint constraintWithItem:view1
                                 attribute:NSLayoutAttributeLeft
                                 relatedBy:NSLayoutRelationEqual
                                    toItem:superview
                                 attribute:NSLayoutAttributeLeft
                                multiplier:1.0
                                  constant:padding.left],

    [NSLayoutConstraint constraintWithItem:view1
                                 attribute:NSLayoutAttributeBottom
                                 relatedBy:NSLayoutRelationEqual
                                    toItem:superview
                                 attribute:NSLayoutAttributeBottom
                                multiplier:1.0
                                  constant:-padding.bottom],

    [NSLayoutConstraint constraintWithItem:view1
                                 attribute:NSLayoutAttributeRight
                                 relatedBy:NSLayoutRelationEqual
                                    toItem:superview
                                 attribute:NSLayoutAttributeRight
                                multiplier:1
                                  constant:-padding.right],

 ]];

问题出在苹果提供的那个特别长的函数。当你的视图多的时候,像上面这样的代码就会越来越庞大,可读性也越来越低。

↑目录

<a name="using-masonry"></a> 使用 Masonry

那么如何更加优雅的使用 autolayout 呢?绝大多数的 iOS 开发如果使用 autolayout 来布局视图的话,肯定或多或少的听说过 Masonry (如果是 Swift 版本的话,官方推荐 SnapKit)。

利用 Masonry,我们可以将上面约束代码写成下面这样(来自 Masonry README.md):


UIEdgeInsets padding = UIEdgeInsetsMake(10, 10, 10, 10);

[view1 mas_makeConstraints:^(MASConstraintMaker *make) {
    make.top.equalTo(superview.mas_top).with.offset(padding.top); //with is an optional semantic filler
    make.left.equalTo(superview.mas_left).with.offset(padding.left);
    make.bottom.equalTo(superview.mas_bottom).with.offset(-padding.bottom);
    make.right.equalTo(superview.mas_right).with.offset(-padding.right);
}];

Masonry 会帮助我们将约束添加到适当的视图上(比如自身或者和另一个视图的公共祖先),同时也会帮助我们设置相应视图的 translatesAutoresizingMaskIntoConstraintsNO

↑目录

<a name="using-dlsimpleautolayout"></a> 使用 DLSimpleAutolayout

DLSimpleAutolayout 是一个使用方式类似 Masonry 的约束框架,下面是 DLSimpleAutolayout 的约束代码(等价于上面的 Masonry 代码):

UIEdgeInsets padding = UIEdgeInsetsMake(10, 10, 10, 10);
@[
 view1.dl_top.equalTo(superview).offset(padding.top),
 view1.dl_left.equalTo(superview).offset(padding.left),
 view1.dl_bottom.equalTo(superview).offset(-padding.bottom),
 view1.dl_right.equalTo(superview).offset(-padding.right),
].dl_constraint_install();

是不是看起来一摸一样?!!

但是 DLSimpleAutolayout 的实现极为简单,只有一个头文件和一个实现文件,合计代码行数只有300行左右。

↑目录

<a name="how-to-implement-DLSimpleAutolayout"></a> DLSimpleAutolayout 实现原理

<a name="principle-autolayout"></a> 基本原理

首先你需要了解布局的基本原理

简单的说每一个相等关系的约束最后会被 Apple 处理成一条类似下面的等式:

view1.left = 2.0 * view2.left + 8.0

上面这条公式的意思是 view1left 约束等于 view2left 值乘以 2 加 8。这里的 2 叫 multiplier,8 叫 constant,view1 叫 first item,view2 叫 second item,也就是分别对应

+(instancetype)constraintWithItem:(id)view1 attribute:(NSLayoutAttribute)attr1 relatedBy:(NSLayoutRelation)relation toItem:(nullable id)view2 attribute:(NSLayoutAttribute)attr2 multiplier:(CGFloat)multiplier constant:(CGFloat)c;

这个原生 API 的几个参数。无论是 DLSimpleAutolayout 还是 Masonry 的实现,基本上都是对这个 API 的封装,同时添加了一些其他代码,方便使用者使用约束。

↑目录

<a name="principle-DLSimpleViewAttribute"></a> DLSimpleAutolayout 的实现之 DLSimpleViewAttribute

DLSimpleAutolayout 的实现其实参考了 Masonry,比如 DLSimpleViewAttribute 类似与 MASViewAttributeDLSimpleViewAttribute 类型接口如下:


@interface DLSimpleViewAttribute : NSObject

@property (nonatomic, strong, readonly) DLSimpleViewAttribute *(^equalTo)(id view);
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *(^lessThanOrEqualTo)(id view);
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *(^greaterThanOrEqualTo)(id view);
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *(^multipliedBy)(CGFloat multipier);
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *(^offset)(CGFloat offset);
@property (nonatomic, strong, readonly) NSLayoutConstraint *(^install)();

@end

也就是对应约束的3种大小关系,同时可以对 constant 进行 offset 操作(对应设置 constant),对 second item 有 multipliedBy 操作(对应设置 multiplier),最后添加约束的时候需要手动 install() 。比如下面这样:

UIEdgeInsets padding = UIEdgeInsetsMake(10, 10, 10, 10);
view1.dl_top.equalTo(superview).offset(padding.top).install();
view1.dl_left.equalTo(superview).offset(padding.left).install();
view1.dl_bottom.equalTo(superview).offset(-padding.bottom).install();
view1.dl_right.equalTo(superview).offset(-padding.right).install();

当调用 install() 的时候,DLSimpleAutolayout 会根据当前配置的信息,来生成一个约束,同时将约束添加到自身或者是和 second item 的最近的公共视图上。并设置自身的 translatesAutoresizingMaskIntoConstraintsNO。代码如下所示:

- (NSLayoutConstraint * (^)())install {
    return ^id(){
        // 设置为 NO
        ((UIView *)self.firstItem).translatesAutoresizingMaskIntoConstraints = NO;
        NSLayoutConstraint *constaraint = [NSLayoutConstraint constraintWithItem:self.firstItem
                                                                       attribute:self.firstAttribute
                                                                       relatedBy:self.relation
                                                                          toItem:self.secondItem
                                                                       attribute:self.secondAttribute
                                                                      multiplier:self.multiplier
                                                                        constant:self.constant];
        if (self.secondItem == nil) {
            [self.firstItem addConstraint:constaraint];
        } else {
            // 寻找最近的公共祖先
            UIView *closestCommonSuperview = [self dl_ClosestCommonSuperview:self.firstItem view2:self.secondItem];
            [closestCommonSuperview addConstraint:constaraint];
        }
        return constaraint;
    };
}

↑目录

<a name="principle-NSArray-category"></a> DLSimpleAutolayout 的实现之 NSArray 类别

考虑到方便在每个属性后面自动使用 install(),我对 NSArray 添加了一个类别,封装了这个操作。所以无需在每个 DLSimpleViewAttribute 对象后调用 install(),只需要将这些对象放到一个 NSArray 里面,对这个 array 调用 dl_constraint_install() 即可。这种类似语法糖的写法也方便了使用者更好的组织、调整自己的布局代码。

该 NSArray 类别公开接口如下:

@interface NSArray (DLSimpleAutoLayout)

@property (nonatomic, strong, readonly) NSArray<NSLayoutConstraint *> * (^dl_constraint_install)();

@end

写出来的代码类似下面这样:

UIEdgeInsets padding = UIEdgeInsetsMake(10, 10, 10, 10);
@[
 view1.dl_top.equalTo(superview).offset(padding.top),
 view1.dl_left.equalTo(superview).offset(padding.left),
 view1.dl_bottom.equalTo(superview).offset(-padding.bottom),
 view1.dl_right.equalTo(superview).offset(-padding.right),
].dl_constraint_install();

↑目录

<a name="principle-UIView-category"></a> DLSimpleAutolayout 的实现之 UIView 类别

DLSimpleAutolayoutUIView 添加了类别,就是类似 dl_xxx 这样的只读属性。
并且每个 view 返回的 dl_xxx 都是一个 DLSimpleViewAttribute 类型。该类别的接口如下:


@interface UIView (DLSimpleAutoLayout)

@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_left;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_top;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_right;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_bottom;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_leading;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_trailing;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_width;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_height;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_centerX;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_centerY;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_baseline;

#if TARGET_OS_IPHONE || TARGET_OS_TV

@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_leftMargin;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_rightMargin;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_topMargin;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_bottomMargin;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_leadingMargin;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_trailingMargin;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_centerXWithinMargins;
@property (nonatomic, strong, readonly) DLSimpleViewAttribute *dl_centerYWithinMargins;

#endif
@end

↑目录

到此为止,DLSimpleAutolayout 基本上就实现了。具体实现的话可以看代码 DLSimpleAutolayout


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

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,066评论 4 62
  • 销售思维和营销思维做外贸 虽然没赶上外贸老前辈在黄金时代躺着赚钱的时代,好歹也在白银时代混迹外贸圈十年,看着整个外...
    汤米苏阅读 152评论 0 0
  • 我不是诗人,但我会用心去写一些文字,为你,为那个与我在灵魂里相遇,相知,相爱,相惜的人。你来,在我的眼里,你不来,...
    安俊杰阅读 364评论 0 1