ECGPublicLib 1.2.1

ECGPublicLib 1.2.1

测试已测试
Lang语言 Obj-CObjective C
许可 MIT
Released上次发布2017年4月

范坛 维护。



 
依赖
Masonry~> 1.0.2
SDWebImage~> 4.0.0
 

  • Fighter-FT

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 类型的语法有其自身的缺陷,并且由于 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

这三个相等约束接受一个参数,可以是以下之一

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的值

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

3. NSNumber

自动布局允许将宽度和高度设置为常量值。如果你想设置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,可以获得无前缀的版本。

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_addConstraints

// 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_remakeConstraintsmas_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 之前,将 #define MAS_SHORTHAND 添加到 prefix.pch 中

#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>}];

功能

  • 不仅限于 Auto Layout 的子集。任何 NSLayoutConstraint 可以做的事情,Masonry 都可以做到!
  • 优秀的调试支持,为视图和约束提供有意义的命名。
  • 约束可以像句子一样阅读。
  • 没有疯狂的宏魔法。Masonry 不会用宏污染全局命名空间。
  • 不是基于字符串或字典的,因此您可以获得编译时检查。

待办事项

  • 视觉美学
  • Mac 示例项目
  • 更多的测试和例子