Masonry 源码解析

Masonry

上图是 Masonry 的大体结构。

Masonry 主要分两层,一部分通过主要的用户接口及通过 DSL 能力。另一部分则是核心功能代码。

DSL

Masonry 通过自定义 DSL,让用户可以通过简单的代码实现布局。

mas_makeConstraints 是我们最常用的方法。

mas_makeConstraints

1
2
3
4
5
6
7
8
9
10
11
12
- (NSArray *)mas_makeConstraints:(void(^)(MASConstraintMaker *))block {
self.translatesAutoresizingMaskIntoConstraints = NO;
// 构建一个 MASConstraintMaker 对象
MASConstraintMaker *constraintMaker = [[MASConstraintMaker alloc] initWithView:self];
// 将对象传给 block
block(constraintMaker);
// 执行 install 布局
return [constraintMaker install];
}

mas_makeConstraints 在,给 block 传入 MASConstraintMaker 对象。

left

MASConstraintMakerMASConstraint 中定义了大量的属性。

1
2
3
- (MASConstraint *)left {
return [self addConstraintWithLayoutAttribute:NSLayoutAttributeLeft];
}

这些属性的代码,大概都长这样。添加完实现后,又返回 MASConstraint 。这样使得我们能够通过 . 语法不断的添加 Layout 属性。

addConstraintWithLayoutAttribute:

MASConstraintMaker 中的 addConstraintWithLayoutAttribute: 最终调用 constraint:addConstraintWithLayoutAttribute:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
- (MASConstraint *)constraint:(MASConstraint *)constraint addConstraintWithLayoutAttribute:(NSLayoutAttribute)layoutAttribute {
MASViewAttribute *viewAttribute = [[MASViewAttribute alloc] initWithView:self.view layoutAttribute:layoutAttribute];
// 生成新的约束
MASViewConstraint *newConstraint = [[MASViewConstraint alloc] initWithFirstViewAttribute:viewAttribute];
// 对于约束有依赖的处理
if ([constraint isKindOfClass:MASViewConstraint.class]) {
//replace with composite constraint
NSArray *children = @[constraint, newConstraint];
MASCompositeConstraint *compositeConstraint = [[MASCompositeConstraint alloc] initWithChildren:children];
compositeConstraint.delegate = self;
[self constraint:constraint shouldBeReplacedWithConstraint:compositeConstraint];
return compositeConstraint;
}
// 对于 View 的依赖处理
if (!constraint) {
newConstraint.delegate = self;
[self.constraints addObject:newConstraint];
}
return newConstraint;
}
  • MASCompositeConstraintMASViewConstraint 都是 MASConstraint 的子类。
  • 方法会返回 MASCompositeConstraintMASViewConstraint
  • constraint:addConstraintWithLayoutAttribute:delegate 的方法。MASConstraintMaker 的方法中将 newConstraint.delegate = self;, compositeConstraint.delegate = self;。使用在调用 MASConstraintleft 这样的属性时,最终还是会回到 MASConstraintMaker 的这个方法中。
  • constraint:addConstraintWithLayoutAttribute: 主要做了一件事,就是把 MASCompositeConstraintMASViewConstraint 对象存入数组中。等 mas_makeConstraints 进行 install

offset

MASConstraint 还存在一类属性,是允许传入参数的。 offset 就是最典型的例子。

1
2
3
4
5
6
- (MASConstraint * (^)(CGFloat))offset {
return ^id(CGFloat offset){
self.offset = offset;
return self;
};
}

所以,这类属性时通过 block 实现。设置完属性后返回 self 。这样使得链式调用可以继续。

equalTo & mas_equalTo

Masonry 定义了两个预编译宏。一个 MAS_SHORTHAND 用于控制可以使用 makeConstraints 方法调用。不需要 mas_ 作为前缀。

另一个是 MAS_SHORTHAND_GLOBALS

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
#define mas_equalTo(...) equalTo(MASBoxValue((__VA_ARGS__)))
#define mas_greaterThanOrEqualTo(...) greaterThanOrEqualTo(MASBoxValue((__VA_ARGS__)))
#define mas_lessThanOrEqualTo(...) lessThanOrEqualTo(MASBoxValue((__VA_ARGS__)))
#define mas_offset(...) valueOffset(MASBoxValue((__VA_ARGS__)))
#ifdef MAS_SHORTHAND_GLOBALS
#define equalTo(...) mas_equalTo(__VA_ARGS__)
#define greaterThanOrEqualTo(...) mas_greaterThanOrEqualTo(__VA_ARGS__)
#define lessThanOrEqualTo(...) mas_lessThanOrEqualTo(__VA_ARGS__)
#define offset(...) mas_offset(__VA_ARGS__)
#endif

equalTo 宏

如果 MAS_SHORTHAND_GLOBALS 定义了则 equalTo 等同与调用 equalTo(MASBoxValue((__VA_ARGS__)))

调用 equalTo 宏 -> 调用 mas_equalTo 宏 -> 调用 equalTo(MASBoxValue((__VA_ARGS__)))

但如果 MAS_SHORTHAND_GLOBALS 没定义调用的是 MASConstraintequalTo 属性。

MASBoxValue

1
#define MASBoxValue(value) _MASBoxValue(@encode(__typeof__((value))), (value))

MASBoxValue 最终调用了 _MASBoxValue 。做了一件事,就是把 int , double 等转换为 NSNumber ; 把 CGPoint , CGSize 转换为 NSValue

为什么要做一层转换呢?看了 equalTo 属性的定义我们就明白了。

equalTo 属性

1
- (MASConstraint * (^)(id attr))equalTo;

equalTo 属性的定义, 是个 block , 返回 MASConstraint , 接收一个 id 类型的入参。 而 int , double , CGPoint 这些并非对象, 所以 需要通过 MASBoxValue 做个转换。

总结

  • Masonry 的核心代码主要在 MASConstraintMakerMASViewConstraintMASCompositeConstraint
  • Masonry 主要通过属性和 block 的方式实现链式调用,自定义了一套 DSL 。
  • Masonry 定义了些宏,这些宏会改变 equalTo 这样的一些操作的行为。在使用是需要特别注意 。