API设计方案新思路：用顺畅插口结构內部DSL

编程设计語言的抽象性体制包括了2个最基础的层面：一是語言关心的基本元素/词义；另一个是以基本元素/词义到复合型原素/词义的结构标准。在C、C 、Java、C#、Python等通用语言中，語言的基本元素/词义通常离难题域较远，根据API库的方式开展逐层抽象性是减少难题难度系数最常见的方式 。例如，在C语言中最普遍的方法是出示库函数来封裝繁杂逻辑性，便捷外界启用。(北京市网站制作)

但是一般的API设计方法存有一种纯天然的圈套，那便是无论如何封裝，大全过程尽管比小全过程抽象层次高些，但实质上還是全过程，遭受全过程词义的牵制。换句话说，根据基本元素/词义结构更高級抽象性原素/词义的情况下，語言的结构标准非常大水平上限定了抽象性的层面，大家难以跳出来这一层面去，乃至很有可能压根观念不上这一限定。而SQL、HTML、CSS、make等DSL（行业特殊語言）的抽象性层面是为特殊行业量身订做的，从这种抽象性角度观察难题通常更为简易，因此DSL在处理其特殊行业的难题时比通用性编程设计語言更为便捷。一般，SQL等非通用语言被称作外界DSL（External DSL）；在通用语言中，大家实际上还可以在一定水平上提升語言结构标准的抽象性层面限定，界定內部DSL（Internal DSL）。

文中将详细介绍一种被称作顺畅插口（Fluent Interface）的內部DSL设计方法。Wikipedia上Fluent Interface的界定是：

下边将分4个一部分来逐渐表明顺畅插口在结构內部DSL中的典型性运用。

1.基础词义抽象性

假如要輸出0..4这五个数，大家一般会最先想起相近那样的编码：

1.  //Java  
2. for (int i = 0; i < 5;  i) {  
3. system.out.println(i);  
4. }   
5.  

而Ruby尽管也适用相近的for循环，但非常简单的是下边那样的完成：

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

Ruby中一切皆目标，5是Fixnum类的案例，times是Fixnum的一个方式 ，它接纳一个block主要参数。对比for循环完成，Ruby 的times方法更简约，易读性更强，但了解OOP的盆友很有可能会有疑问，times是不是应当做为整形类的方式 呢？在OOP中，方式 启用一般意味着了向目标推送信息，更改或查寻目标的情况，times方式 显而易见并不是对整形目标情况的查寻和改动。假如你是Ruby的设计师，你能把times方式 放进Fixnum类吗？假如回答是否认的，那麼Ruby的这类设计方案实质上意味着了什么？事实上，这儿的times尽管仅仅一个一般的类方法，但它的目地却与一般实际意义上的类方法不一样，它的词义事实上类似for循环那样的語言基础词义，能够 被视作一种自定的基础词义。times的词义从一定水平上跳出来了类方法的圈圈，向难题域迈入了一步！

另一个事例来源于Eric Evans的“用2个时间点结构一个时间范围目标”，一般设计方案：

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

另一种Evans的设计方案是那样：

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

按传统式OO设计方案，until方式 本不可出現在TimePoint类中，这儿TimePoint类的until方式 一样意味着了一种自定的基础词义，促使表述時间域的难题更为当然。

尽管上边的2个简易事例和一般设计方案对比看不出来很大的优点，但它却为大家了解顺畅插口奠定了基本。关键的是应当感受到他们从一定水平上跳出来了語言基础抽象性体制的拘束，大家不应该再用类岗位职责区划、迪米特法则（Law of Demeter）等OO设计原理来对待他们。

2.管路抽象性

在Shell中，我们可以根据管路将一系列的小指令组成在一起完成繁杂的作用。管路中流动性的是单一种类的文字流，测算全过程就是以键入流到輸出流的转换全过程，每一个指令是对文字流的一次转换功效，根据管路将功效累加起來。在Shell中，许多情况下大家只必须一句话就能进行log统计分析那样的中小规模纳税人难题。和别的抽象性体制对比，管路的幽美取决于无嵌套循环。例如下边这一段C程序流程，因为嵌套循环层级较深，不易一下子了解清晰：

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

而用管路来表述一样的作用则清楚得多：

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

大家非常容易了解这段程序表达的意思是：先求a，b的最高值；再把結果和c取极小值；再把結果和d求最高值；再把結果和e求极小值。

jQuery的链条式启用设计方案也具备管路的设计风格，方式 链上流动性的是同一种类的jQuery目标，每一步方式 启用是对目标的一次功效，全部方式 链将每个方式 的功效累加起來。

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

3.结构分析抽象性

除开管路这类“线形”构造外，顺畅插口还可用以结构结构分析抽象性。例如，用Javascript动态创建建立下边的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则要有感染力得多：

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的规范DOM API对比，上边的API设计方案已不限于独立地对待某一个方式 ，只是考虑到了他们在解决困难时的组成应用，因此编码的表达形式尤其接近难题的实质。那样的编码是自表述的（self-explanatory）在易读性层面要显著胜于DOM API，这等同于界定了一种类似HTML的內部DSL，它有着自身的词义和英语的语法。必须需注意的是，上边的结构分析抽象性和管路抽象性拥有实质的不一样，管路抽象性的方式 链上一般是同一目标的持续传送，而层级抽象性中方式 链上的目标却在伴随着层级的转变而转变。此为，我们可以把业务流程标准也表述在顺畅插口中，例如上边的事例中，body()不可以包括在div()回到的目标中，div().body()将抛出去”body方式 不会有”出现异常。(高档网站建设)

4.多线程抽象性

顺畅插口不但能够 结构繁杂的层级抽象性，还能够用以结构多线程抽象性。在根据回调函数体制的多线程方式中，好几个异步调用的同歩和嵌套循环难题是应用多线程的难题所属。有时候一个稍繁杂的启用和同歩关联会造成编码充满了繁杂的同歩定期检查逐层回调函数，难以理解和维护保养。这个问题从实质上讲和上边HTML的事例一样，是因为大部分通用语言仍未把多线程做为基本元素/词义，很多多线程完成方式是向語言的让步。对于这个问题，我就用Javascript撰写了一个根据顺畅插口的多线程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 complete d'); })  
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启用，但从另一个角度观察它却像一段叙述异步调用的DSL程序流程。它根据顺畅接口标准了begin when end的句法结构，begin后边跟的是起动异步调用的编码；when后边是多线程結果解决，能够 挑选each_done, all_done, timeout中的一种或多种多样。而begin when end构造自身是能够 嵌套循环的，例如上边的编码在timeout解决支系中就包括了另一个begin when end构造。根据这一DSL，我们可以比根据回调函数的方法能够更好地表述异步调用的同歩和嵌套循环关联。

上边详细介绍了用顺畅插口结构的4种典型性抽象性，出此以外也有许多别的的抽象性和运用场所，例如：许多单元测试卷架构就根据顺畅接口标准了单元测试卷的DSL。尽管上边的事例以Javascript等动态语言占多数，但实际上顺畅插口所依靠的英语的语法基本并不严苛，即便在Java那样的静态数据語言中，一样能够 轻轻松松地应用。顺畅插口有别于传统式的API设计方案，了解和应用顺畅插口关键是要提升語言抽象性体制产生的思维定势逻辑思维，依据难题域选择适度的抽象性层面，运用語言的基础英语的语法结构行业特殊的词义和英语的语法。