HJProject 0.0.6

HJProject 0.0.6

×

测试已测试✗
语言语言 Objective-CObjective-C
许可证 MIT
发布上次发布2016年11月

由‘GiaJiang’维护。

 
依赖
MJRefresh>= 0
Masonry>= 0
 

HJProject 0.0.6

  • 作者：
  • GiaJiang

Masonry

Masonry 仍然在积极维护，我们承诺修复错误并合并社区提交的优质 PR。然而，如果您在项目中使用 Swift，我们建议使用SnapKit，因为它提供了更简单的 API，具有更好的类型安全性。

Masonry 是一个轻量级的布局框架，它通过更友好的语法包装了 AutoLayout。Masonry 独有的布局 DSL 通过链式方式描述 NSLayoutConstraints，结果得到更简洁、更易读的布局代码。Masonry 支持 iOS 和 Mac OS X。

例如，请查看 Masonry 工作区中的 Masonry iOS 示例 项目。下载后您需要运行 pod install。

NSLayoutConstraints 有什么问题？

Auto Layout 是一种强大且灵活的思想方式，用于组织和布局视图。然而，从代码中创建约束既冗长又缺乏描述性。想象一个简单的例子，您想使一个视图填满其父视图，每边都有 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

这三个等式约束接受一个参数，可以是以下任何一个

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

如果您想使视图的左边缘大于或等于标签的左边缘

//these two constraints are exactly the same
make.left.greaterThanOrEqualTo(label);
make.left.greaterThanOrEqualTo(label.mas_left);

3. NSNumber

自动布局允许将宽度和高度设置为固定值。如果您想设置视图的最小和最大宽度，可以将数值传递给等式块

//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，可以提供无前缀版本。

4. NSArray

一个包含任何前面的类型的混合类型的数组

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中，有一些不同的方法来更新约束。

1. 引用

您可以通过将约束构建表达式的结果分配给局部变量或类属性来保留对特定约束的引用。您也可以通过将它们存储在数组中来引用多个约束。

// 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];

2. mas_updateConstraints

如果您只想更新约束的常量值，可以使用便捷方法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];
}

3. mas_remakeConstraints

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

安装

使用orsome CocoaPods。

在您的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>}];

功能

  • 不仅限于Auto Layout的子集。任何NSLayoutConstraint可以做的事情，Masonry也能做！
  • 优秀的调试支持，给视图和约束指定有意义的名称。
  • 约束读起来像句子。
  • 没有疯狂宏魔法。Masonry不会使用宏污染全局命名空间。
  • 不是基于字符串或字典的，因此您得到编译时检查。

待办事项

  • 视觉糖果
  • Mac示例项目
  • 更多测试和示例