Masonry -- 使用纯代码进行iOS应用的autolayout自适应布局

简介

简化iOS应用使用纯代码机型自适应布局的工作,使用一种简洁高效的语法替代NSLayoutConstraints.

• 项目主页: Masonry
• 最新示例: 点击下载
• 项目简议: 如果再看到关于纯代码,xib或storyboard,使用哪种方式进行UI布局更合适的讨论,请推荐他们先试用下 Masonry. Masonry,像xib一样快速,同时拥有作为纯代码方式的灵活性 -- github关注度 7800 + 是有原因的!

快速入门

安装

使用 CocoaPods 安装

pod 'Masonry'

推荐在你的在 prefix.pch 中引入头文件:

// 定义这个常量,就可以在使用Masonry不必总带着前缀 `mas_`:
#define MAS_SHORTHAND

// 定义这个常量,以支持在 Masonry 语法中自动将基本类型转换为 object 类型:
#define MAS_SHORTHAND_GLOBALS

#import "Masonry.h"

使用

初始Masonry

这是使用MASConstraintMaker创建的约束:

/* 注意:view1应首先添加为某个视图的子视图,superview是一个局部变量,指view1的父视图. */

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

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

甚至可以更短:

[view1 mas_makeConstraints:^(MASConstraintMaker *make) {
    make.edges.equalTo(superview).insets(padding);
}];

不止可以表达相等关系

.equalTo 等价于 NSLayoutRelationEqual

.lessThanOrEqualTo 等价于 NSLayoutRelationLessThanOrEqual

.greaterThanOrEqualTo 等价于 NSLayoutRelationGreaterThanOrEqual

这三个表达相等关系的语句,可以接受一个参数;此参数可以为以下任意一个:

1. MASViewAttribute

make.centerX.lessThanOrEqualTo(view2.mas_left);

MASViewAttribute	NSLayoutAttribute
view.mas_left	NSLayoutAttributeLeft
view.mas_right	NSLayoutAttributeRight
view.mas_top	NSLayoutAttributeTop
view.mas_bottom	NSLayoutAttributeBottom
view.mas_leading	NSLayoutAttributeLeading
view.mas_trailing	NSLayoutAttributeTrailing
view.mas_width	NSLayoutAttributeWidth
view.mas_height	NSLayoutAttributeHeight
view.mas_centerX	NSLayoutAttributeCenterX
view.mas_centerY	NSLayoutAttributeCenterY
view.mas_baseline	NSLayoutAttributeBaseline

2. UIView/NSView

如果你需要 view.left 大于或等于label.left:

// 下面两个约束是完全等效的.
make.left.greaterThanOrEqualTo(label);
make.left.greaterThanOrEqualTo(label.mas_left);

3. NSNumber

自适应布局允许将宽度或高度设置为固定值.
如果你想要给视图一个最小或最大值,你可以这样:

//width >= 200 && width <= 400
make.width.greaterThanOrEqualTo(@200);
make.width.lessThanOrEqualTo(@400)

但是自适应布局不支持将 left,right, centerY等设为固定值.
如果你给这些属性传递一个常量, Masonry会自动将它们转换为相对于其父视图的相对值:

//creates view.left = view.superview.left + 10
make.left.lessThanOrEqualTo(@10)

除了使用 NSNumber 外,你可以使用基本数据类型或者结构体来创建约束:

make.top.mas_equalTo(42);
make.height.mas_equalTo(20);
make.size.mas_equalTo(CGSizeMake(50, 100));
make.edges.mas_equalTo(UIEdgeInsetsMake(10, 0, 10, 0));
make.left.mas_equalTo(view).mas_offset(UIEdgeInsetsMake(10, 0, 10, 0));

4. NSArray

一个数组,里面可以混合是前述三种类型的任意几种:

// 表达三个视图等高的约束.
make.height.equalTo(@[view1.mas_height, view2.mas_height]);
make.height.equalTo(@[view1, view2]);
make.left.equalTo(@[view1, @100, view3.right]);

约束的优先级

.priority 允许你指定一个精确的优先级,数值越大优先级越高.最高1000.

.priorityHigh 等价于 UILayoutPriorityDefaultHigh.优先级值为 750.

.priorityMedium 介于高优先级和低优先级之间,优先级值在 250~750之间.

.priorityLow 等价于 UILayoutPriorityDefaultLow, 优先级值为 250.

优先级可以在约束的尾部添加:

make.left.greaterThanOrEqualTo(label.mas_left).with.priorityLow();

make.top.equalTo(label.mas_top).with.priority(600);

等比例自适应

.multipliedBy 允许你指定一个两个视图的某个属性等比例变化

item1.attribute1 = multiplier × item2.attribute2 + constant,此为约束的计算公式, .multipliedBy本质上是用来限定 multiplier的

注意,因为编程中的坐标系从父视图左上顶点开始,所以指定基于父视图的left或者top的multiplier是没有意义的,因为父视图的left和top总为0.

如果你需要一个视图随着父视图的宽度和高度,位置自动变化,你应该同时指定 right,bottom,width,height与父视图对应属性的比例(基于某个尺寸下的相对位置计算出的比例),并且constant必须为0.

// 指定宽度为父视图的 1/4.
make.width.equalTo(superview).multipliedBy(0.25);

工具方法

Masonry提供了一些工具方法来进一步简化约束的创建.

edges 边界

//使 top, left, bottom, right等于 view2
make.edges.equalTo(view2);

//使 top = superview.top + 5, left = superview.left + 10,
//      bottom = superview.bottom - 15, right = superview.right - 20
make.edges.equalTo(superview).insets(UIEdgeInsetsMake(5, 10, 15, 20))

size 尺寸

// 使宽度和高度大于或等于 titleLabel
make.size.greaterThanOrEqualTo(titleLabel)

//使 width = superview.width + 100, height = superview.height - 50
make.size.equalTo(superview).sizeOffset(CGSizeMake(100, -50))

center 中心

//使 centerX和 centerY = button1
make.center.equalTo(button1)

//使 centerX = superview.centerX - 5, centerY = superview.centerY + 10
make.center.equalTo(superview).centerOffset(CGPointMake(-5, 10))

你可以使用链式语法来增强代码可读性:

// 除top外,其他约束都与父视图相等.
make.left.right.bottom.equalTo(superview);
make.top.equalTo(otherView);

更新约束

有时,你需要修改已经存在的约束来实现动画效果或者移除/替换已有约束.
在 Masonry 中,有几种不同的更新视图约束的途径:

1. References 引用

你可以把 Masonry 语法返回的约束或约束数组,存储到一个局部变量或者类的属性中,以供后续操作某个约束.

// 声明属性
@property (nonatomic, strong) MASConstraint *topConstraint;

...

// when making constraints
[view1 mas_makeConstraints:^(MASConstraintMaker *make) {
    self.topConstraint = make.top.equalTo(superview.mas_top).with.offset(padding.top);
    make.left.equalTo(superview.mas_left).with.offset(padding.left);
}];

...
// 然后你就可以操作这个属性.
[self.topConstraint uninstall];

2. mas_updateConstraints

如果你只是想添加新的约束,你可以使用便利方法mas_updateConstraints,不需要使用 mas_makeConstraints. mas_updateConstraints,不会移除已经存在的约束(即使新旧约束间相互冲突).

// 重写视图的updateConstraints方法: 这是Apple推荐的添加/更新约束的位置.
// 这个方法可以被多次调用以响应setNeedsUpdateConstraints方法.
// setNeedsUpdateConstraints 可以被UIKit内部调用或者由开发者在自己的代码中调用以更新视图约束. 
- (void)updateConstraints {
    [self.growingButton mas_updateConstraints:^(MASConstraintMaker *make) {
        make.center.equalTo(self);
        make.width.equalTo(@(self.buttonSize.width)).priorityLow();
        make.height.equalTo(@(self.buttonSize.height)).priorityLow();
        make.width.lessThanOrEqualTo(self);
        make.height.lessThanOrEqualTo(self);
    }];

    //根据apple机制,最后应调用父类的updateConstraints方法.
    [super updateConstraints];
}

3. mas_remakeConstraints

mas_remakeConstraints与mas_updateConstraints相似,不同之处在于: mas_remakeConstraints 会先移除视图上已有的约束,再去创建新的约束.

- (void)changeButtonPosition {
    [self.button mas_remakeConstraints:^(MASConstraintMaker *make) {
        make.size.equalTo(self.buttonSize);

        if (topLeft) {
        	make.top.and.left.offset(10);
        } else {
        	make.bottom.and.right.offset(-10);
        }
    }];
}