API設(shè)計(jì)新思維：用流暢接口構(gòu)造內(nèi)部DSL

編程語(yǔ)言的抽象機(jī)制包括兩個(gè)基本方面：一是語(yǔ)言關(guān)注的基本元素/語(yǔ)義；另一種是從基本元素/語(yǔ)義到復(fù)合元素/語(yǔ)義的構(gòu)造規(guī)則。在C、C++、Java、C#、Python等通用語(yǔ)言中，語(yǔ)言的基本元素/語(yǔ)義往往遠(yuǎn)離問(wèn)題域。以API庫(kù)的形式逐層抽象是最常用的降低問(wèn)題難度的方法。比如C語(yǔ)言中最常見(jiàn)的方式就是提供一個(gè)函數(shù)庫(kù)來(lái)封裝復(fù)雜的邏輯，方便外部調(diào)用。 （北京網(wǎng)出品）

但是，普通的API設(shè)計(jì)方法有一個(gè)天然的陷阱，就是不管怎么封裝，大進(jìn)程的抽象層次雖然比小進(jìn)程高，但本質(zhì)上還是一個(gè)進(jìn)程，是受流程語(yǔ)義的限制。也就是說(shuō)，當(dāng)通過(guò)基本元素/語(yǔ)義構(gòu)造更高層次的抽象元素/語(yǔ)義時(shí)，語(yǔ)言的構(gòu)造規(guī)則在很大程度上限制了抽象的維度，我們很難跳出這個(gè)維度，我們可能不會(huì)甚至完全意識(shí)到這個(gè)限制。但是，DSL（Domain Specific Language）的抽象維度，如SQL、HTML、CSS、make，都是為特定領(lǐng)域量身定做的。從這些抽象的角度來(lái)看，問(wèn)題往往是最簡(jiǎn)單的，所以在解決特定領(lǐng)域的問(wèn)題時(shí)，DSL 比通用程序要好。設(shè)計(jì)語(yǔ)言更方便。通常將SQL等非通用語(yǔ)言稱(chēng)為外部DSL（External DSL）；在通用語(yǔ)言中，我們其實(shí)可以在一定程度上突破語(yǔ)言構(gòu)造規(guī)則的抽象維度限制，定義內(nèi)部DSL（Internal DSL）。

本文將介紹一種稱(chēng)為流式接口（Fluent Interface）的內(nèi)部DSL設(shè)計(jì)方法。維基百科上對(duì)Fluent Interface 的定義是：

流暢的接口（最初由Eric Evans 和Martin Fowler 創(chuàng)造）是面向?qū)ο驛PI 的實(shí)現(xiàn)，旨在提供更具可讀性的代碼。流暢的接口通常是通過(guò)使用方法鏈接來(lái)中繼后續(xù)調(diào)用的指令上下文來(lái)實(shí)現(xiàn)的（但流暢的接口需要的不僅僅是方法鏈接）。

下面將分為四個(gè)部分逐步說(shuō)明Fluent Interface在內(nèi)部DSL構(gòu)建中的典型應(yīng)用。

1.基本語(yǔ)義抽象

如果我們要輸出5個(gè)數(shù)字0.4，我們通常首先想到的代碼是這樣的：

//Java

for(inti=0;i5;++i){

系統(tǒng).out.println(i);

}

而Ruby雖然也支持類(lèi)似的for循環(huán)，但最簡(jiǎn)單的是下面這樣的實(shí)現(xiàn)：

1. //Ruby ?
2. .times?{|i|?puts?i}? ?

Ruby中一切皆對(duì)象，5是Fixnum類(lèi)的實(shí)例，times是Fixnum的一個(gè)方法，它接受一個(gè)block參數(shù)。相比f(wàn)or循環(huán)實(shí)現(xiàn)，Ruby 的times方式更簡(jiǎn)潔，可讀性更強(qiáng)，但熟悉OOP的朋友可能會(huì)有疑問(wèn)，times是否應(yīng)該作為整型類(lèi)的方法呢？在OOP中，方法調(diào)用通常代表了向?qū)ο蟀l(fā)送消息，改變或查詢對(duì)象的狀態(tài)，times方法顯然不是對(duì)整型對(duì)象狀態(tài)的查詢和修改。如果你是Ruby的設(shè)計(jì)者，你會(huì)把times方法放入Fixnum類(lèi)嗎？如果答案是否定的，那么Ruby的這種設(shè)計(jì)本質(zhì)上代表了什么呢？實(shí)際上，這里的times雖然只是一個(gè)普通的類(lèi)方法，但它的目的卻與普通意義上的類(lèi)方法不同，它的語(yǔ)義實(shí)際上類(lèi)似于for循環(huán)這樣的語(yǔ)言基本語(yǔ)義，可以被視為一種自定義的基本語(yǔ)義。times的語(yǔ)義從一定程度上跳出了類(lèi)方法的框框，向問(wèn)題域邁進(jìn)了一步！

另一個(gè)例子來(lái)自Eric Evans的“用兩個(gè)時(shí)間點(diǎn)構(gòu)造一個(gè)時(shí)間段對(duì)象”，普通設(shè)計(jì)：

1. 3?//Java ?
2. TimePoint?fiveOClock,?sixOClock; ?
3. TimeInterval?meetingTime?=?new?TimeInterval(fiveOClock,?sixOClock);? ?
4. ?

另一種Evans的設(shè)計(jì)是這樣：

1. 2?//Java ?
2. TimeInterval?meetingTime?=?fiveOClock.until(sixOClock);? ?

按傳統(tǒng)OO設(shè)計(jì)，until方法本不應(yīng)出現(xiàn)在TimePoint類(lèi)中，這里TimePoint類(lèi)的until方法同樣代表了一種自定義的基本語(yǔ)義，使得表達(dá)時(shí)間域的問(wèn)題更加自然。

雖然上面的兩個(gè)簡(jiǎn)單例子和普通設(shè)計(jì)相比看不出太大的優(yōu)勢(shì)，但它卻為我們理解流暢接口打下了基礎(chǔ)。重要的是應(yīng)該體會(huì)到它們從一定程度上跳出了語(yǔ)言基本抽象機(jī)制的束縛，我們不應(yīng)該再用類(lèi)職責(zé)劃分、迪米特法則（Law of Demeter）等OO設(shè)計(jì)原則來(lái)看待它們。

2.管道抽象

在Shell中，我們可以通過(guò)管道將一系列的小命令組合在一起實(shí)現(xiàn)復(fù)雜的功能。管道中流動(dòng)的是單一類(lèi)型的文本流，計(jì)算過(guò)程就是從輸入流到輸出流的變換過(guò)程，每個(gè)命令是對(duì)文本流的一次變換作用，通過(guò)管道將作用疊加起來(lái)。在Shell中，很多時(shí)候我們只需要一句話就能完成log統(tǒng)計(jì)這樣的中小規(guī)模問(wèn)題。和其他抽象機(jī)制相比，管道的優(yōu)美在于無(wú)嵌套。比如下面這段C程序，由于嵌套層次較深，不容易一下子理解清楚：

1. 2?//C ?
2. min(max(min(max(a,b),c),d),e)? ?

而用管道來(lái)表達(dá)同樣的功能則清晰得多：

1. ?
2. 2?#!/bin/bash ?
3. max?a?b?|?min?c?|?max?d?|?min?e? ?
4. ?

我們很容易理解這段程序表達(dá)的意思是：先求a，b的最大值；再把結(jié)果和c取最小值；再把結(jié)果和d求最大值；再把結(jié)果和e求最小值。

jQuery的鏈?zhǔn)秸{(diào)用設(shè)計(jì)也具有管道的風(fēng)格，方法鏈上流動(dòng)的是同一類(lèi)型的jQuery對(duì)象，每一步方法調(diào)用是對(duì)對(duì)象的一次作用，整個(gè)方法鏈將各個(gè)方法的作用疊加起來(lái)。

1. 2?//Javascript ?
2. $('li').filter(':event').css('background-color',?'red');? ?
3. ?

3.層次結(jié)構(gòu)抽象

除了管道這種“線性”結(jié)構(gòu)外，流暢接口還可用于構(gòu)造層次結(jié)構(gòu)抽象。比如，用Javascript動(dòng)態(tài)創(chuàng)建創(chuàng)建下面的HTML片段：

1. <div?id="’product_123’"?class="’product’">?
2. <img?src="’preview_123.jpg’"?alt=""?/>?
3. <ul>?
4. <li>Name:?iPad2?32G</li>?
5. <li>Price:?3600</li>?
6. </ul>?
7. </div>? ?
8. ?

若采用Javascript的DOM API：

1. //Javascript ?
2. var?div?=?document.createElement('div'); ?
3. div.setAttribute(‘id’,?‘product_123’); ?
4. div.setAttribute(‘class’,?‘product’); ?
5. ?
6. var?img?=?document.createElement('img'); ?
7. img.setAttribute(‘src’,?‘preview_123.jpg’); ?
8. div.appendChild(img); ?
9. ?
10. var?ul?=?document.createElement('ul'); ?
11. var?li1?=?document.createElement('li'); ?
12. var?txt1?=?document.createTextNode("Name:?iPad2?32G"); ?
13. li1.appendChild(txt1); ?
14. … ?
15. div.appendChild(ul);? ?
16. ?

而下面流暢接口API則要有表現(xiàn)力得多：

1. //Javascript ?
2. var?obj?= ?
3. $.div({id:’product_123’,?class:’product’}) ?
4. .img({src:’preview_123.jpg’}) ?
5. .ul() ?
6. .li().text(‘Name:?iPad2?32G’)._li() ?
7. .li().text(‘Price:?3600’)._li() ?
8. ._ul() ?
9. ._div();??

和Javascript的標(biāo)準(zhǔn)DOM API相比，上面的API設(shè)計(jì)不再局限于孤立地看待某一個(gè)方法，而是考慮了它們?cè)诮鉀Q問(wèn)題時(shí)的組合使用，所以代碼的表現(xiàn)形式特別貼近問(wèn)題的本質(zhì)。這樣的代碼是自解釋的（self-explanatory）在可讀性方面要明顯勝于DOM API，這相當(dāng)于定義了一種類(lèi)似于HTML的內(nèi)部DSL，它擁有自己的語(yǔ)義和語(yǔ)法。需要特別注意的是，上面的層次結(jié)構(gòu)抽象和管道抽象有著本質(zhì)的不同，管道抽象的方法鏈上通常是同一對(duì)象的連續(xù)傳遞，而層次抽象中方法鏈上的對(duì)象卻在隨著層次的變化而變化。此為，我們可以把業(yè)務(wù)規(guī)則也表達(dá)在流暢接口中，比如上面的例子中，body()不能包含在div()返回的對(duì)象中，div().body()將拋出”body方法不存在”異常。(高端網(wǎng)站建設(shè))

4.異步抽象

流暢接口不僅可以構(gòu)造復(fù)雜的層次抽象，還可以用于構(gòu)造異步抽象。在基于回調(diào)機(jī)制的異步模式中，多個(gè)異步調(diào)用的同步和嵌套問(wèn)題是使用異步的難點(diǎn)所在。有時(shí)一個(gè)稍復(fù)雜的調(diào)用和同步關(guān)系會(huì)導(dǎo)致代碼充滿了復(fù)雜的同步檢查和層層回調(diào)，難以理解和維護(hù)。這個(gè)問(wèn)題從本質(zhì)上講和上面HTML的例子一樣，是由于多數(shù)通用語(yǔ)言并未把異步作為基本元素/語(yǔ)義，許多異步實(shí)現(xiàn)模式是向語(yǔ)言的妥協(xié)。針對(duì)這個(gè)問(wèn)題，我用Javascript編寫(xiě)了一個(gè)基于流暢接口的異步DSL，示例代碼如下：

1. //Javascript ?
2. $.begin() ?
3. .async(newTask('task1'),?'task1') ?
4. .async(newTask('task2'),?'task2') ?
5. .async(newTask('task3'),?'task3') ?
6. .when() ?
7. .each_done(function(name,?result)?{ ?
8. console.log(name?+?':?'?+?result);}) ?
9. .all_done(function(){?console.log('good,?all?completed');?}) ?
10. .timeout(function(){ ?
11. console.log('timeout!!'); ?
12. $.begin() ?
13. .async(newTask('task4'),?'task4') ?
14. .when() ?
15. .each_done(function(name,?result)?{ ?
16. console.log(name?+?':?'?+?result);?}) ?
17. .end();} ?
18. ,?3000) ?
19. .end();? ?

上面的代碼只是一句Javascript調(diào)用，但從另一個(gè)角度看它卻像一段描述異步調(diào)用的DSL程序。它通過(guò)流暢接口定義了begin when end的語(yǔ)法結(jié)構(gòu)，begin后面跟的是啟動(dòng)異步調(diào)用的代碼；when后面是異步結(jié)果處理，可以選擇each_done, all_done, timeout中的一種或多種。而begin when end結(jié)構(gòu)本身是可以嵌套的，比如上面的代碼在timeout處理分支中就包含了另一個(gè)begin when end結(jié)構(gòu)。通過(guò)這個(gè)DSL，我們可以比基于回調(diào)的方式更好地表達(dá)異步調(diào)用的同步和嵌套關(guān)系。

上面介紹了用流暢接口構(gòu)造的4種典型抽象，出此之外還有很多其他的抽象和應(yīng)用場(chǎng)合，比如：不少單元測(cè)試框架就通過(guò)流暢接口定義了單元測(cè)試的DSL。雖然上面的例子以Javascript等動(dòng)態(tài)語(yǔ)言居多，但其實(shí)流暢接口所依賴(lài)的語(yǔ)法基礎(chǔ)并不苛刻，即使在Java這樣的靜態(tài)語(yǔ)言中，同樣可以輕松地使用。流暢接口不同于傳統(tǒng)的API設(shè)計(jì)，理解和使用流暢接口關(guān)鍵是要突破語(yǔ)言抽象機(jī)制帶來(lái)的定勢(shì)思維，根據(jù)問(wèn)題域選取適當(dāng)?shù)某橄缶S度，利用語(yǔ)言的基本語(yǔ)法構(gòu)造領(lǐng)域特定的語(yǔ)義和語(yǔ)法。

我們專(zhuān)注高端建站，小程序開(kāi)發(fā)、軟件系統(tǒng)定制開(kāi)發(fā)、BUG修復(fù)、物聯(lián)網(wǎng)開(kāi)發(fā)、各類(lèi)API接口對(duì)接開(kāi)發(fā)等。十余年開(kāi)發(fā)經(jīng)驗(yàn)，每一個(gè)項(xiàng)目承諾做到滿意為止，多一次對(duì)比，一定讓您多一份收獲！