测试已测试 | ✗ |
语言语言 | Obj-CObjective C |
许可证 | MIT |
发布上次发布 | 2017年7月 |
由 LY 先生 维护。
依赖项 | |
Masonry | ~> 1.0.1 |
pop | ~> 1.0.9 |
#Masonry
Masonry 仍在积极维护中,我们致力于修复错误并合并来自更广泛社区的优质 PR。但是,如果您在项目中使用 Swift,我们建议使用 SnapKit,因为它提供了更好的类型安全性和更简单的 API。
Masonry 是一个轻量级的布局框架,它使用更简洁的语法包装了 AutoLayout。Masonry 有自己的布局 DSL,它提供了一种链式方式来描述您的 NSLayoutConstraints,从而使得布局代码更加简短和可读。Masonry 支持 iOS 和 Mac OS X。
例如,请查看 Masonry 工作空间中的 Masonry iOS 示例 项目。下载后,您需要运行 pod install
。
在底层,自动布局是一种强大且灵活的方式来组织和布局您的视图。然而,从代码中创建约束既冗长又不易描述。想象一个简单的例子,您希望有一个视图填充其父视图,但每边都缩进 10 个像素
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],
]];
即使是这样一个简单的例子,所需的代码也很冗长,当您有 2 或 3 个以上的视图时,代码很快就会变得难以阅读。另一个选择是使用视觉格式语言(VFL),这比 VFL 简短一些。然而,ASCII 类型语法有其自身的缺陷,并且由于其返回一个数组,所以它也更难以动画。
以下是使用 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 的左边距为 label 的左边距
//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 将将其转换为相对于视图父视图的约束,即
//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
开始 Masoning
#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>}];