测试已测试 | ✗ |
语言语言 | Obj-CObjective C |
许可证 | MIT |
发布上次发布 | 2016年2月 |
由[CapriHuang]维护。
依赖项 | |
Masonry | >= 0 |
ReactiveCocoa | >= 0 |
Masonry 仍在积极维护,我们致力于修复错误并合并社区中优质的技术申请。但如果您在项目中使用 Swift,我们建议使用SnapKit,因为它提供了更安全的类型和更简单的 API。
Masonry 是一个轻量级的布局框架,它使用更好的语法包裹了 AutoLayout。Masonry 有自己的布局 DSL,它提供了描述 NSLayoutConstraints 的链式方式,从而产生更简洁易读的布局代码。Masonry 支持 iOS 和 Mac OS X。
例如,请参考 Masonry 工作空间中的 Masonry iOS 示例 项目。下载后,您需要运行 pod install
。
在底层,Auto Layout 是一种强大且灵活的方法来组织和布局视图。然而,从代码创建约束是详尽的,并且并不很直观。想象一下这样一个简单示例:您想要有一个视图填充其父视图,但在每一边都有 10 像素的内边距。
UIView *superview = self;
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],
]];
就是这样一个简单示例,代码已经很详尽,当你有超过 2 或 3 个视图时,它会很快变得难以阅读。另一个选择是使用视觉格式语言(VFL),它比 VFL 简短一些。然而,ASCII 类型的语法有自己的不足,并且由于 NSLayoutConstraint constraintsWithVisualFormat:
返回一个数组,因此它也难以动画化。
这是使用 MASConstraintMaker 创建的相同约束。
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);
}];
甚至更简短
[view1 mas_makeConstraints:^(MASConstraintMaker *make) {
make.edges.equalTo(superview).with.insets(padding);
}];
注意,在第一个示例中,我们需要将约束添加到父视图 [superview addConstraints:...
。Masonry 会自动将约束添加到合适的位置视图。
Masonry 也会为您调用 view1.translatesAutoresizingMaskIntoConstraints = NO;
。
.equalTo
等同于 NSLayoutRelationEqual
.lessThanOrEqualTo
等同于 NSLayoutRelationLessThanOrEqual
.greaterThanOrEqualTo
等同于 NSLayoutRelationGreaterThanOrEqual
这三种相等约束接受一个参数,可以是以下任意一种
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 |
如果你想让 view.left 大于或等于 label.left
//these two constraints are exactly the same
make.left.greaterThanOrEqualTo(label);
make.left.greaterThanOrEqualTo(label.mas_left);
自动布局允许将宽度和高度设置为常量值。如果你想让 view 有最小和最大宽度,可以向相等块传递一个数字。
//width >= 200 && width <= 400
make.width.greaterThanOrEqualTo(@200);
make.width.lessThanOrEqualTo(@400)
但是自动布局不允许将对齐属性(如左、右、centerY 等)设置为常量值。因此,如果为这些属性传递一个 NSNumber,Masonry 将将其转换为相对于 view 的父视图的约束,即
//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));
默认情况下,支持自动装箱的宏前缀为 mas_
。通过在导入 Masonry 之前定义 MAS_SHORTHAND_GLOBALS
,可以获得无前缀的版本。
任一前述类型混合的数组
make.height.equalTo(@[view1.mas_height, view2.mas_height]);
make.height.equalTo(@[view1, view2]);
make.left.equalTo(@[view1, @100, view3.right]);
.priority
允许您指定一个确切的优先级
.priorityHigh
等同于 UILayoutPriorityDefaultHigh
.priorityMedium
是高和低之间的中间值
.priorityLow
等同于 UILayoutPriorityDefaultLow
优先级可以作为约束链的末尾附加,如下所示
make.left.greaterThanOrEqualTo(label.mas_left).with.priorityLow();
make.top.equalTo(label.mas_top).with.priority(600);
Masonry 还提供了一些方便的方法,可以同时创建多个约束。这些称为 MASCompositeConstraints
// make top, left, bottom, right equal view2
make.edges.equalTo(view2);
// make 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))
// make width and height greater than or equal to titleLabel
make.size.greaterThanOrEqualTo(titleLabel)
// make width = superview.width + 100, height = superview.height - 50
make.size.equalTo(superview).sizeOffset(CGSizeMake(100, -50))
// make centerX and centerY = button1
make.center.equalTo(button1)
// make centerX = superview.centerX - 5, centerY = superview.centerY + 10
make.center.equalTo(superview).centerOffset(CGPointMake(-5, 10))
您可以通过链式调用视图属性来提高可读性
// All edges but the top should equal those of the superview
make.left.right.and.bottom.equalTo(superview);
make.top.equalTo(otherView);
有时您需要修改现有的约束以进行动画或删除/替换约束。在 Masonry 中,有几种方法可以更新约束。
您可以通过将约束创建表达式的结果分配给局部变量或类属性来保留特定约束的引用。您还可以通过将它们存储在数组中以引用多个约束。
// in public/private interface
@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);
}];
...
// then later you can call
[self.topConstraint uninstall];
或者,如果您只是更新约束的常量值,可以使用方便的方法 mas_updateConstraints
而不是 mas_makeConstraints
// this is Apple's recommended place for adding/updating constraints
// this method can get called multiple times in response to setNeedsUpdateConstraints
// which can be called by UIKit internally or in your code if you need to trigger an update to your constraints
- (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);
}];
//according to apple super should be called at end of method
[super updateConstraints];
}
mas_updateConstraints
非常适用于更新一组约束,但是进行超出更新常量值之外的操作可能会非常繁琐。这就是 mas_remakeConstraints
发挥作用的时刻。
mas_remakeConstraints
与 mas_updateConstraints
类似,但是它不是更新常量值,而是在重新安装之前会移除所有约束。这样,你可以在不需要保留想要删除的约束的引用的情况下提供不同的约束。
- (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);
}
}];
}
你可以在 Masonry iOS 示例 项目中找到这三个方法的所有详细示例。
布局视图并不总是按计划进行。所以当事情真的出了问题时,你不希望看到这样的控制台输出
Unable to simultaneously satisfy constraints.....blah blah blah....
(
"<NSLayoutConstraint:0x7189ac0 V:[UILabel:0x7186980(>=5000)]>",
"<NSAutoresizingMaskLayoutConstraint:0x839ea20 h=--& v=--& V:[MASExampleDebuggingView:0x7186560(416)]>",
"<NSLayoutConstraint:0x7189c70 UILabel:0x7186980.bottom == MASExampleDebuggingView:0x7186560.bottom - 10>",
"<NSLayoutConstraint:0x7189560 V:|-(1)-[UILabel:0x7186980] (Names: '|':MASExampleDebuggingView:0x7186560 )>"
)
Will attempt to recover by breaking constraint
<NSLayoutConstraint:0x7189ac0 V:[UILabel:0x7186980(>=5000)]>
Masonry 为 NSLayoutConstraint 添加了一个类别,它覆盖了默认的 - (NSString *)description
实现。现在你可以为视图和约束提供有意义的名称,并且可以轻松地识别出由 Masonry 创建的约束。
这意味着你的控制台输出现在可以看起来这样
Unable to simultaneously satisfy constraints......blah blah blah....
(
"<NSAutoresizingMaskLayoutConstraint:0x8887740 MASExampleDebuggingView:superview.height == 416>",
"<MASLayoutConstraint:ConstantConstraint UILabel:messageLabel.height >= 5000>",
"<MASLayoutConstraint:BottomConstraint UILabel:messageLabel.bottom == MASExampleDebuggingView:superview.bottom - 10>",
"<MASLayoutConstraint:ConflictingConstraint[0] UILabel:messageLabel.top == MASExampleDebuggingView:superview.top + 1>"
)
Will attempt to recover by breaking constraint
<MASLayoutConstraint:ConstantConstraint UILabel:messageLabel.height >= 5000>
有关如何设置此内容的示例,请查看 Masonry 工作区中的 Masonry iOS 示例 项目。
@implementation DIYCustomView
- (id)init {
self = [super init];
if (!self) return nil;
// --- Create your views here ---
self.button = [[UIButton alloc] init];
return self;
}
// tell UIKit that you are using AutoLayout
+ (BOOL)requiresConstraintBasedLayout {
return YES;
}
// this is Apple's recommended place for adding/updating constraints
- (void)updateConstraints {
// --- remake/update constraints here
[self.button remakeConstraints:^(MASConstraintMaker *make) {
make.width.equalTo(@(self.buttonSize.width));
make.height.equalTo(@(self.buttonSize.height));
}];
//according to apple super should be called at end of method
[super updateConstraints];
}
- (void)didTapButton:(UIButton *)button {
// --- Do your changes ie change variables that affect your layout etc ---
self.buttonSize = CGSize(200, 200);
// tell constraints they need updating
[self setNeedsUpdateConstraints];
}
@end
在你的 Podfile 中
pod 'Masonry'
如果您想在不保留那些讨厌的 'mas_' 前缀的情况下使用 Masonry。请在导入 Masonry 之前,在 prefix.pch 中添加 #define MAS_SHORTHAND
#define MAS_SHORTHAND
开始使用 Masonry
#import "Masonry.h"
将包含的代码片段复制到 ~/Library/Developer/Xcode/UserData/CodeSnippets
中,以快速编写 Masonry 块!
mas_make
-> [<view> mas_makeConstraints:^(MASConstraintMaker *make){<code>}];
mas_update
-> [<view> mas_updateConstraints:^(MASConstraintMaker *make){<code>}];
mas_remake
-> [<view> mas_remakeConstraints:^(MASConstraintMaker *make){<code>}];