如何利用Objective-C寫一個(gè)精美的DSL
推薦序：本文是來自美團(tuán)的 iOS 技術(shù)專家臧成威的投稿。臧老師在 StuQ 開完 RactiveCocoa 的兩次系列課程后，最近新開了一門 《iOS 實(shí)戰(zhàn)黑魔法》的新課程，課程內(nèi)容涉及很多 Objective-C Runtime, Swift 等底層的知識(shí)和應(yīng)用技巧，如果你感興趣，可以看文末的介紹。
感謝臧成威的授權(quán)，以下是文章正文。
背景
在程序開發(fā)中，我們總是希望能夠更加簡(jiǎn)潔、更加語義化地去表達(dá)自己的邏輯，鏈?zhǔn)秸{(diào)用是一種常見的處理方式。我們常用的 Masonry、 Expecta 等第三方庫就采用了這種處理方式。
- // Masonry
- [view1 mas_makeConstraints:^(MASConstraintMaker *make) {
- make.top.equalTo(superview.mas_top).with.offset(padding.top);
- 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);
- }];
- // Expecta
- expect(@"foo").to.equal(@"foo"); // `to` is a syntactic sugar and can be safely omitted.
- expect(foo).notTo.equal(1);
- expect([bar isBar]).to.equal(YES);
- expect(baz).to.equal(3.14159);
像這種用于特定領(lǐng)域的表達(dá)方式，我們叫做 DSL (Domain Specific Language)，本文就介紹一下如何實(shí)現(xiàn)一個(gè)鏈?zhǔn)秸{(diào)用的 DSL.
鏈?zhǔn)秸{(diào)用的實(shí)現(xiàn)
我們舉一個(gè)具體的例子，比如我們用鏈?zhǔn)奖磉_(dá)式來創(chuàng)建一個(gè) UIView，設(shè)置其 frame、backgroundColor， 并添加至某個(gè)父 View。
對(duì)于最基本的 Objective-C (在 iOS4 block 出現(xiàn)之前)，如果要實(shí)現(xiàn)鏈?zhǔn)秸{(diào)用，只能是這個(gè)樣子的：
- UIView *aView = [[[[UIView alloc] initWithFrame:aFrame] bgColor:aColor] intoView:aSuperView];
有了 block，我們可以把中括號(hào)的這種寫法改為點(diǎn)語法的形式
- UIView *aView = AllocA(UIView).with.position(x, y).size(width, height).bgColor(aColor).intoView(aSuperView);
- // 當(dāng)x和y為默認(rèn)值0和0或者width和height為默認(rèn)值0的時(shí)候，還可以省略
- UIView *bView = AllocA(UIView).with.size(width, height).bgColor(aColor).intoView(aSuperView);
可以看出，鏈?zhǔn)秸Z法的語義性很明確，后者的語法更加緊湊，下面我們從兩個(gè)角度看一下后者的實(shí)現(xiàn)。
1. 從語法層面來看
鏈?zhǔn)秸{(diào)用可以用兩種方式來實(shí)現(xiàn)：
1).在返回值中使用屬性來保存方法中的信息
比如，Masonry 中的 .left .right .top .bottom 等方法，調(diào)用時(shí)會(huì)返回一個(gè) MASConstraintMaker 類的實(shí)例，里面有 left/right/top/bottom 等屬性來保存每次調(diào)用時(shí)的信息;
- make.left.equalTo(superview.mas_left).with.offset(15);
再比如，Expecta 中的方法 .notTo 方法會(huì)返回一個(gè) EXPExpect 類的實(shí)例，里面有個(gè) BOOL 屬性 self.negative 來記錄是否調(diào)用了 .notTo;
- expect(foo).notTo.equal(1);
再比如，上例中的 .with 方法，我們可以直接 return self;
2).使用 block 類型的屬性來接受參數(shù)
比如 Masonry 中的 .offset(15) 方法，接收一個(gè) CGFloat 作為參數(shù)，可以在 MASConstraintMaker 類中添加一個(gè) block 類型的屬性：
- @property (nonatomic, copy) MASConstraintMaker* (^offset)(CGFloat);
比如例子中的 .position(x, y)，可以給的某類中添加一個(gè)屬性：
- @property (nonatomic, copy) ViewMaker* (^position)(CGFloat x, CGFloat y);
在調(diào)用 .position(x, y) 方法時(shí)，執(zhí)行這個(gè)block，返回 ViewMaker 的實(shí)例保證鏈?zhǔn)秸{(diào)用得以進(jìn)行。
2. 從語義層面來看
從語義層面上，需要界定哪些是助詞，哪些是需要接受參數(shù)的。為了保證鏈?zhǔn)秸{(diào)用能夠完成，需要考慮傳入什么，返回什么。
還是以上面的例子來講：
- UIView *aView = AllocA(UIView).with.position(x, y).size(width, height).bgColor(aColor).intoView(aSuperView);
分步來看一下，這個(gè) DSL 表達(dá)式需要描述的是一個(gè)祈使句，以 Alloc 開始，以 intoView 截止。在 intoView 終結(jié)語之前，我們對(duì) UIView 進(jìn)行一定的修飾，利用 position size bgColor 這些。
下面我們分別從四段來看，如何實(shí)現(xiàn)這樣一個(gè)表達(dá)式：
(1) 賓語
在 AllocA(UIView) 的語義中，我們確定了賓語是 a UIVIew。由于確定 UIView 是在 intoView 截止那時(shí)，所以我們需要?jiǎng)?chuàng)建一個(gè)中間類來保存所有的中間條件，這里我們用 ViewMaker 類。
- @interface ViewMaker : NSObject
- @property (nonatomic, strong) Class viewClass;
- @property (nonatomic, assign) CGPoint position;
- @property (nonatomic, assign) CGPoint size;
- @property (nonatomic, strong) UIColor *color;
- @end
另外我們可以注意到AllocA是一個(gè)函數(shù)，而UIView無法直接傳遞到這個(gè)函數(shù)中，語法就要變成 AllocA([UIView class]) 而失去了簡(jiǎn)潔性。所以我們需要先定義一個(gè)宏來“吞”掉中括號(hào)和 class 這個(gè)方法：
- #define AllocA(aClass) alloc_a([aClass class])
- ViewMaker* alloc_a(Class aClass){
- ViewMaker *maker = ViewMaker.new;
- maker.viewClass = aClass;
- return maker;
- }
(2) 助詞
很多時(shí)候，為了讓 DSL 的語法看起來更加連貫，我們需要一些助詞來幫助，例如 Masonry 里面的 make.top.equalTo(superview.mas_top).with.offset(padding.top) 這句中的 with 就是這樣一個(gè)助詞。
而這個(gè)助詞和我們學(xué)過的語法一樣，通常沒有什么實(shí)際效果，簡(jiǎn)單返回self就可以。
- @interface ViewMaker : NSObject
- @property (nonatomic, strong) Class viewClass;
- @property (nonatomic, assign) CGPoint position;
- @property (nonatomic, assign) CGPoint size;
- @property (nonatomic, strong) UIColor *color;
- @property (nonatomic, readonly) ViewMaker *with;
- @end
- @implementation ViewMaker
- - (ViewMaker *)with
- {
- return self;
- }
- @end
需要注意的是，返回自己，就沒有辦法阻止用戶不斷調(diào)用自己 .with.with.with ，為了避免這種情況，可以新生成一個(gè)類，每個(gè)類都擁有自己所在層次的方法，避免躍層調(diào)用。
- @interface ViewMaker : NSObject
- @property (nonatomic, strong) Class viewClass;
- @property (nonatomic, assign) CGPoint position;
- @property (nonatomic, assign) CGPoint size;
- @property (nonatomic, strong) UIColor *color;
- @end
- @interface ViewClassHelper : NSObject
- @property (nonatomic, strong) Class viewClass;
- @property (nonatomic, readonly) ViewMaker *with;
- @end
- #define AllocA(aClass) alloc_a([aClass class])
- ViewClassHelper* alloc_a(Class aClass){
- ViewClassHelper *helper = ViewClassHelper.new;
- helper.viewClass = aClass;
- return helper;
- }
- @implementation ViewClassHelper
- - (ViewMaker *)with
- {
- ViewMaker *maker = ViewMaker.new;
- maker.viewClass = self.viewClass;
- return maker;
- }
- @end
這樣就有效防止了，.with.with.with這樣的語法。但是實(shí)際上，我們要根據(jù)真實(shí)的需要來進(jìn)行開發(fā)，使用 DSL 的用戶是為了更好的表達(dá)性，所以并不會(huì)寫出.with.with.with這樣的代碼，這樣的防護(hù)性措施就顯得有點(diǎn)不必要了。
不過使用類來區(qū)分助詞還有另外幾個(gè)小好處，就是它可以確保在語法提示的時(shí)候，ViewClassHelper這個(gè)類只有.with這樣一個(gè)語法提示，而ViewMaker不出現(xiàn).with語法提示;并且同時(shí)確保.with一定要出現(xiàn)。
不過為了簡(jiǎn)化文章，我們都使用前者，既.with返回self來繼續(xù)下文：
- @interface ViewMaker : NSObject
- @property (nonatomic, strong) Class viewClass;
- @property (nonatomic, assign) CGPoint position;
- @property (nonatomic, assign) CGPoint size;
- @property (nonatomic, strong) UIColor *color;
- @property (nonatomic, readonly) ViewMaker *with;
- @end
- @implementation ViewMaker
- - (ViewMaker *)with
- {
- return self;
- }
- @end
(3) 修飾部分——定語
像例子中的position size bgColor這些都是定語部分，用來修飾UIView，他們以屬性的形勢(shì)存在于ViewMaker的實(shí)例中，為了支持鏈?zhǔn)奖磉_(dá)，所以實(shí)現(xiàn)的時(shí)候，都會(huì)繼續(xù)返回self。
我們來試著實(shí)現(xiàn)下：
- @interface ViewMaker : NSObject
- // ...
- @property (nonatomic, copy) ViewMaker* (^position)(CGFloat x, CGFloat y);
- @property (nonatomic, copy) ViewMaker* (^size)(CGFloat x, CGFloat y);
- @property (nonatomic, copy) ViewMaker* (^bgColor)(UIColor *color);
- @end
- @implementation ViewMaker
- - (instancetype)init
- {
- if (self = [super init]) {
- @weakify(self)
- _position = ^ViewMaker *(CGFloat x, CGFloat y) {
- @strongify(self)
- self.position = CGPointMake(x, y);
- };
- _size = ^ViewMaker *(CGFloat x, CGFloat y) {
- @strongify(self)
- self.size = CGPointMake(x, y);
- };
- _bgColor = ^ViewMaker *(UIColor *color) {
- @strongify(self)
- self.color = color;
- };
- }
- return self;
- }
- @end
(4) 終結(jié)詞
“終結(jié)詞”這個(gè)實(shí)在是在現(xiàn)代語法里面找不到對(duì)應(yīng)關(guān)系了，但是在 DSL 中，這一段尤為重要。ViewMaker的實(shí)例從頭至尾收集了很多的修飾，需要***的一個(gè)表達(dá)詞語來產(chǎn)生***的結(jié)果，這里就稱為”終結(jié)詞”。例如在 Expecta 這個(gè)開源庫里面的 equal 就是把真正的行為表現(xiàn)出來的時(shí)候，to 和 notTo 都不會(huì)真正觸發(fā)行為。
在我們的例子里，終結(jié)詞.intoView(aSuperViwe)可以這樣實(shí)現(xiàn)：
- @interface ViewMaker : NSObject
- // ...
- @property (nonatomic, copy) UIView* (^intoView)(UIView *superView);
- @end
- @implementation ViewMaker
- - (instancetype)init
- {
- if (self = [super init]) {
- @weakify(self)
- // ...
- _intoView = ^UIView *(UIView *superView) {
- @strongify(self)
- CGRect rect = CGRectMake(self.position.x, self.position.y,
- self.size.width, self.size.height);
- UIView *view = [[UIView alloc] initWithFrame:rect];
- view.backgroundColor = self.color;
- [superView addSubView:view];
- return view;
- };
- }
- return self;
- }
- @end
這樣，一個(gè)終結(jié)詞就寫好了。
最終代碼的匯總：
- @interface ViewMaker : NSObject
- @property (nonatomic, strong) Class viewClass;
- @property (nonatomic, assign) CGPoint position;
- @property (nonatomic, assign) CGPoint size;
- @property (nonatomic, strong) UIColor *color;
- @property (nonatomic, readonly) ViewMaker *with;
- @property (nonatomic, copy) ViewMaker* (^position)(CGFloat x, CGFloat y);
- @property (nonatomic, copy) ViewMaker* (^size)(CGFloat x, CGFloat y);
- @property (nonatomic, copy) ViewMaker* (^bgColor)(UIColor *color);
- @property (nonatomic, copy) UIView* (^intoView)(UIView *superView);
- @end
- @implementation ViewMaker
- - (instancetype)init
- {
- if (self = [super init]) {
- @weakify(self)
- _position = ^ViewMaker *(CGFloat x, CGFloat y) {
- @strongify(self)
- self.position = CGPointMake(x, y);
- };
- _size = ^ViewMaker *(CGFloat x, CGFloat y) {
- @strongify(self)
- self.size = CGPointMake(x, y);
- };
- _bgColor = ^ViewMaker *(UIColor *color) {
- @strongify(self)
- self.color = color;
- };
- _intoView = ^UIView *(UIView *superView) {
- @strongify(self)
- CGRect rect = CGRectMake(self.position.x, self.position.y,
- self.size.width, self.size.height);
- UIView *view = [[UIView alloc] initWithFrame:rect];
- view.backgroundColor = self.color;
- [superView addSubView:view];
- return view;
- };
- }
- return self;
- }
- - (ViewMaker *)with
- {
- return self;
- }
- @end
總結(jié)
這種鏈?zhǔn)秸{(diào)用能夠使程序更加清晰，在特定場(chǎng)景下使程序的可讀性更強(qiáng)。這種手段在Swift也是相同道理，大家可以善加利用，讓自己的代碼更加美觀。
其實(shí)，iOS 開發(fā)者要想不斷精進(jìn)，成長(zhǎng)為真正的大牛高手，必須將自己的視野凌駕于業(yè)務(wù)需求之上，精簡(jiǎn)強(qiáng)化核心技能，提升自己對(duì)語言和工具的掌握層次，才能提高開發(fā)效率，提升技能水平。
這里為你準(zhǔn)備了更多好玩的，讓你事半功倍的 iOS 高階黑魔法攻防術(shù)，斯達(dá)克學(xué)院(StuQ ) 特別邀請(qǐng)備受學(xué)員喜愛的資深 iOS 技術(shù)專家臧成威老師開設(shè)《 iOS 實(shí)戰(zhàn)黑魔法 》課程，6周12小時(shí)高效 Get iOS 必須掌握的高階黑魔法攻防術(shù)，讓你從普通的開發(fā)者中漸漸走出來，看到一個(gè)不一樣的語言，感受不一樣的開發(fā)!
