背景
日常开发中一定会遇到这种场景,在某个类中提供了这样一个方法:
@interface TTDoSomething:NSObject
+ (void)doSomethingWithName:(NSString *)name configA:(ConfigA)configA configB:(ConfigB)configB configC:(ConfigC)configC;
@end
这个方法通过四个参数name
, configA
, configB
, configB
提供了 doSomeThing
的功能,可是这个方法的参数实在是有点多,有的时候我只需要一个默认 config 就好了,并不是每个 config 都需要传入一个值,这时候可以把这个多参数的方法作为全能方法,然后以它为基础实现几个便利方法:
@interface TTDoSomething:NSObject
+ (void)doSomethingWithName:(NSString *)name configA:(ConfigA)configA;
+ (void)doSomethingWithName:(NSString *)name configB:(ConfigB)configB;
+ (void)doSomethingWithName:(NSString *)name configC:(ConfigC)configC;
+ (void)doSomethingWithName:(NSString *)name configA:(ConfigA)configA configB:(ConfigB)configB configC:(ConfigC)configC;
@end
@implementation TTDoSomething
+ (void)doSomethingWithName:(NSString *)name configA:(ConfigA)configA {
[self doSomethingWithName:name configA:configA configB:nil configC:nil];
}
+ (void)doSomethingWithName:(NSString *)name configB:(ConfigB)configB {
[self doSomethingWithName:name configA:nil configB:configB configC:nil];
}
...
@end
但是这么做的缺点也显而易见:
- 组合不灵活,如果需要增加 2 个种 config 组合的便利方法,需要增加新方法;
- 扩展不便,如果全能方法增加了新的配置 configD 需要在现有便利方法的基础上增加更多的便利方法;
链式表达式
今天突然灵光一闪,想到可以用链式表达式解决这个问题。在 iOS 开发领域因为 Masonry 这个库的影响,链式表达式知名度已经很高,因此这篇文章不再赘述其原理。直接进入主题:
首先声明一个链式表达式的链扣类:
.h
@interface TTDoSomethingMaker:NSObject //这里命名也参考 Masonry, 定义为 Maker
// 声明需要的 block 属性,包括 Name 和 Config
@property (nonatomic, copy, readonly) TTDoSomethingMaker *(^name)(NSString *name);
@property (nonatomic, copy, readonly) TTDoSomethingMaker *(^configA)(ConfigA configA);
@property (nonatomic, copy, readonly) TTDoSomethingMaker *(^configB)(ConfigB configB);
@property (nonatomic, copy, readonly) TTDoSomethingMaker *(^configC)(ConfigC configC);
@end
.m
@interface TTDoSomethingMaker ()
// 在.m 中声明保存 name 和 config 的属性,这里不需要暴露给外部,所以不需要声明在 .h
@property(nonatomic, copy) NSString *nameValue;
@property(nonatomic, assign) ConfigA configAValue;
@property(nonatomic, assign) ConfigB configBValue;
@property(nonatomic, assign) ConfigC configCValue;
@end
@implementation TTDoSomethingMaker
// 实现所有的 block getter
- (NSString *)name {
return ^TTDoSomethingMaker *(NSString *name) {
self.nameValue = name;
return self;
};
}
- (ConfigA)configA {
return ^TTDoSomethingMaker *(ConfigA configA) {
self.configAValue = configA;
return self;
};
}
- (ConfigB)configB {
return ^TTDoSomethingMaker *(ConfigB configB) {
self.configBValue = configB;
return self;
};
}
- (ConfigC)configC {
return ^TTDoSomethingMaker *(ConfigC configC) {
self.configCValue = configC;
return self;
};
}
@end
然后在提供功能的 TTDoSomething 类中增加一个方法:
+ (void)doSomething:(void(^)(TTDoSomethingMaker *maker))block {
TTDoSomethingMaker *maker = TTDoSomethingMaker.new;
block ?: block(maker);
// todo
[self doSomethingWithName:maker.nameValue configA:maker.configAValue configB:configBValue configC:configCValue]
}
于是当我们这样调用:
[TTDoSomething doSomething:^(TTDoSomethingMaker *maker) {
maker.name(@"Demo").configA(ConfigAOne);
}];
就相当于调用了
[TTDoSomething doSomethingWithName:@"Demo" configA:ConfigAOne configB:0 configC:0];
如果此时想要将 ConfigB 配置为 ConfigBOne, 只需要在原有的链式表达式后面加一个 .configB(ConfigBOne)
即可。
而如果想给万能方法增加一个 ConfigD, 也只需要修改一下 doSomething:
和 TTDoSomethingMaker
的实现,完美地遵循了开闭原则。
小优化一发
上面 doSomething:
的实现里我加了一个 // todo
的注释,在这个位置可以做一些默认实现,比如说合法性判断和默认值:
+ (void)doSomething:(void(^)(TTDoSomethingMaker *maker))block {
TTDoSomethingMaker *maker = TTDoSomethingMaker.new;
!block ?: block(maker);
NSAssert(maker.nameValue, @"Parameter 'name' should not be nil.");
// 将 ConfigB 配置为 ConfigBTwo
if (maker.configBValue == 0) {
maker.configBValue = ConfigBTwo;
}
[self doSomethingWithName:maker.nameValue configA:maker.configAValue configB:configBValue configC:configCValue]
}
另外,上面的 block getter 可以封装一个宏,减少重复性的代码:
#define TTDoSomethingMakerProperty(TYPE, NAME) - (TTDoSomethingMaker *(^)(TYPE))NAME {\
return ^TTDoSomethingMaker *(TYPE NAME) {\
self.NAME##Value = NAME;\
return self;\
};\
}\
@implementation TTDoSomethingMaker
TTDoSomethingMakerProperty(NSString *, name)
TTDoSomethingMakerProperty(ConfigA, configA)
TTDoSomethingMakerProperty(ConfigB, configB)
TTDoSomethingMakerProperty(ConfigC, configC)
@end
总结
Masonry 利用链式表达式将繁琐的 AutoLayout API 优化成了更表意、灵活、简洁的语法。而链式表达式可以随意自由组合的特性,恰好也是 Objective-C 不支持方法默认参数的优雅解决方式,虽然和 Masonry 的使用场景不一样,但是仔细想想,这两个场景都是对开闭原则的实现。