背景日常开发中一定会遇到这种场景,在某个类中提供了这样一个方法:@interface TTDoSomething:NSObject+ (void)doSomethingWithName:(NSStri
背景
日常开发中一定会遇到这种场景,在某个类中提供了这样一个方法:
@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- (TTDoSomethingMaker *(^)(NSString *))name { return ^TTDoSomethingMaker *(NSString *name) { self.nameValue = name; return self; };}- (TTDoSomethingMaker *(^)(ConfigA))configA { return ^TTDoSomethingMaker *(ConfigA configA) { self.configAValue = configA; return self; };}- (TTDoSomethingMaker *(^)(ConfigB))configB { return ^TTDoSomethingMaker *(ConfigB configB) { self.configBValue = configB; return self; };}- (TTDoSomethingMaker *(^)(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 TTDoSomethingMakerTTDoSomethingMakerProperty(NSString *, name)TTDoSomethingMakerProperty(ConfigA, configA)TTDoSomethingMakerProperty(ConfigB, configB)TTDoSomethingMakerProperty(ConfigC, configC)@end
总结
Masonry 利用链式表达式将繁琐的 AutoLayout API 优化成了更表意、灵活、简洁的语法。而链式表达式可以随意自由组合的特性,恰好也是 Objective-C 不支持方法默认参数的优雅解决方式,虽然和 Masonry 的使用场景不一样,但是仔细想想,这两个场景都是对开闭原则的实现。
补充
这篇文章在写完后第二天,同事也和我提到了参数对象
这个方案,当时和他进行了一番讨论,最后结论还是链式表达式更可取,本来犯懒不想补充在文章里了,鉴于评论有同学提到,我就再写一点。
参数对象
参数对象就是说声明一个新的类,里面收拢了所有的方法参数,类似这样:
@interface TTDoSomethingObject@property(nonatomic, copy) NSString *name;@property(nonatomic, assign) ConfigA configA;@property(nonatomic, assign) ConfigB configB;@property(nonatomic, assign) ConfigC configC;@end
然后新增一个方法:
- (void)doSomething:(TTDoSomethingObject *)object;
这样确实在一定程度上解决了问题也遵循了开闭原则,但是链式表达式的方案能最大限度地利用 IDE 的提示/自动补全让你少些很多代码,先来看看上面的调用示例:
[TTDoSomething doSomething:^(TTDoSomethingMaker *maker) { maker.name(@"Demo").configA(ConfigAOne);}];
上面的代码中,除了 maker 这个 block 参数需要额外地手动敲一个 m
, 其他的代码都可以通过 IDE 提示并补全,而如果使用参数对象
,代码会是这样:
[TTDoSomething doSomething:({ TTDoSomethingObject *object = TTDoSomethingObject.new; object.configA = ConfigAOne; object.name = @"Demo"; object;})];
为了美观我这里用了 ({})
的语法糖,可以看出来要手动多写很多代码,在便利程度上孰优孰劣一目了然。评论里提到的方案是用 C struct 来做参数,这里也举个例子,我把上面的 Class 换成 C struct:
typedef struct TTDoSomethingObject { NSString *name; ConfigA configA; ...}TTDoSomethingObject;
于是调用方式可以变成:
[TTDoSomething doSomething:(TTDoSomethingObject){@"Demo", ConfigAOne, 0, 0}];
或者
//需要强转不然会报错[TTDoSomething doSomething:(TTDoSomethingObject){.name = @"Demo", .configA = ...}];
再或者
TTDoSomethingObject object; object.name = @"Demo"; object.configA = ConfigAOne; [TTDoSomething doSomething:object];
再再或者
[TTDoSomething doSomething:^(TTDoSomethingObject *object) { object->name = @"Demo"; object->configA = ConfigAOne; ...}];
- 第一种写法代码简洁了不少,但是并没有解决参数默认值和参数值省略的问题,同时也需要自己手写较多的代码;
- 第二种写法相对比第一种要多写一些代码,因为输入
.n
时编译器无法索引出.name
, 但是解决了省略参数的问题,然而还是没有默认参数值; - 第三种写法和上面的 Class 方案区别不大;
- 第四种的问题还是一样,需要多手写代码。
有人可能会觉得了,不就手动多写一点代码吗,这也算缺点?对此我想说,这篇文章的出发点就是为了解决方法参数过长带来的不便利,也就是说我的初衷就是不想手动多写代码,就这个目的来说,手动多写一个字母都是更不具优势的方案。综上,我认为除了改写编译器 or 更换语言,链式表达式还是最优解。欢迎讨论
.
- 0