gitbook/软件设计之美/docs/248638.md
2022-09-03 22:05:03 +08:00

10 KiB
Raw Permalink Blame History

11 | DSL你也可以设计一门自己的语言

你好!我是郑晔。

在前面,我们花了三讲的篇幅探讨程序设计语言,一方面是为了增进我们对程序设计语言的理解,另一方面,也希望从中学习到软件设计方面做得好的地方。除了借鉴一些语言特性之外,我们还能怎样应用程序语言,来帮我们做设计呢?

讲到程序设计语言模型时,我说过,程序设计语言的发展趋势,就是离计算机本身越来越远,而离要解决的问题越来越近。但通用程序设计语言无论怎样逼近要解决的问题,它都不可能走得离问题特别近,因为通用程序设计语言不可能知道具体的问题是什么。

这给具体的问题留下了一个空间,如果我们能把设计做到极致,它就能成为一门语言,填补这个空间。注意,我这里用的并不是比喻,而是真的成为一门语言,一门解决一个特定问题的语言。

这种语言就是领域特定语言Domain Specific Language简称 DSL它是一种用于某个特定领域的程序设计语言。这种特定于某个领域是相对于通用语言而言的通用语言可以横跨各个领域我们熟悉的大多数程序设计语言都是通用语言。

我在第8讲说过它们都是图灵完备的但DSL不必做到图灵完备它只要做到满足特定领域的业务需求就足以缩短问题和解决方案之间的距离降低理解的门槛。

虽然大多数程序员并不会真正地实现一个通用程序设计语言但实现一个DSL我们还是有机会的。这一讲我们就来谈谈DSL看看我们可以怎样设计自己的语言。

领域特定语言

不过一说起设计一门语言很多人直觉上会有畏惧心理。但实际上你可能已经在各种场合接触过一些不同的DSL了。程序员最熟悉的一种DSL就是正则表达式了没错也许已经习惯使用正则表达式的你都不知道但它确实就是一种DSL一种用于文本处理这个特定领域的DSL。

如果你觉得正则表达式有点复杂还有一种更简单的DSL就是配置文件。你可能真的不把配置文件当作一种DSL但它确实是在实现某个特定领域的需求而且可以根据你的需求对软件的行为进行定制。

一个典型的例子是Ngnix。无论你是用它单独做Web服务器也好做反向代理也罢抑或是做负载均衡只要通过Ngnix的配置文件你都能实现。配合OpenResty你甚至可以完成一些业务功能。

这么一说你是不是觉得DSL的门槛不像听上去那么高了。

经过前面几讲的学习你应该知道了语法只是一种接口。很多人说到设计DSL脑子里实际想的也只是设计一种语法。所以从软件设计的角度看DSL最终呈现出来的语法只是一种接口但最重要的是它包裹的模型。

Martin Fowler在他的《领域特定语言》这本书中将这个模型称为语义模型Semantic Model。不过在我看来Martin Fowler起这个名字是站在语言开发的角度毕竟语义这个词只有学过编译原理的人才好理解。所以这里真正的重点是模型。

想要实现一个DSL可以这么说DSL的语法本身都是次要的模型才是第一位的。当你有了模型之后所谓的构建DSL就相当于设计一个接口将模型的能力暴露出来。

当把DSL理解成接口我们接受DSL的心理负担就小了很多。你可以想一想它和你熟悉的REST API其实没有什么本质的不同。

既然是接口形式就可以有很多种我们经常能接触到的DSL主要有两种外部DSL和内部 DSL。Martin Fowler在他的书中还提到了语言工作台Language Workbench不过这种做法在实际工作中用到的不多我们暂且忽略。

外部DSL和内部DSL的区别就在于DSL采用的是不是宿主语言Host Language。你可以这么理解假设你的模型主要是用Java写的如果DSL用的就是Java语言它就是内部DSL如果DSL用的不是Java比如你自己设计了一种语法那它就是外部DSL。

把概念说清楚了一些问题便迎刃而解了。这也可以解释为什么DSL让有些人畏惧了原因就是说起 DSL这些人想到的就是自己设计语法的外部的 DSL。其实即便是外部DSL也不一定要设计一门语法我们甚至可以借助已有的语法来完成。比如很多程序员熟悉的一种语法XML。

如果你是一个Java程序员XML就再熟悉不过了。从Ant到Maven从Servlet到Spring曾经的XML几乎是无处不在的。如果你有兴趣可以去找一些使用Ant做构建工具的项目项目规模稍微大一点其XML配置文件的复杂程度就不亚于普通的源代码。

因为它本质上就是一种用于构建领域的DSL只不过它的语法是XML而已。正是因为这种DSL越来越复杂后来一种新的趋势渐渐兴起就是用全功能语言也就是真正的程序设计语言做DSL这是后来像Gradle这种构建工具逐渐流行的原因它们只是用内部DSL替换了外部DSL。

从复杂度而言自己设计一种外部DSL语法大于利用一种现有语法做外部DSL二者之间的差别在于谁来开发解析器。而外部DSL的复杂度要大于内部DSL因为内部DSL连解析的过程都省略了。从实用性的角度更好地挖掘内部DSL的潜力对我们的实际工作助益更多。

代码的表达性

你或许会有一个疑问内部DSL听上去就是一个程序库啊你这个理解是没错的。我们前面说过语言设计就是程序库设计程序库设计就是语言设计。当一个程序库只能用在某个特定领域时它就是一个内部DSL这个内部DSL的语法就是这个程序库的用法。

我先用一个例子让你感受一下内部DSL它来自Martin Fowler的《领域特定语言》。我们要创建一个Computer的实例如果用普通风格的代码写出来应该是这个样子

Processor p = new Processor(2, 2500, Processor.Type.i386); Disk d1 = new Disk(150, Disk.UNKNOWN_SPEED, null);
Disk d2 = new Disk(75, 7200, Disk.Interface.SATA);
return new Computer(p, d1, d2);

而用内部 DSL 写出来,则是这种风格:

computer() 
  .processor()
    .cores(2) 
    .speed(2500) 
    .i386()
  .disk()
    .size(150)
  .disk()
   .size(75)
   .speed(7200) 
   .sata()
.end();

如果这是一段普通的Java代码我们看到一连串的方法调用一定会说这段代码糟糕至极但在这个场景下和前面的代码相比这段代码省去了好多变量反而是清晰了。这其中的差别在哪里呢

之所以我们会觉得这种一连串的方法调用可以接受一个重要的原因是这段代码并不是在做动作而是在进行声明。做动作是在说明怎么做How而声明的代码则是在说做什么What

二者的抽象级别是不同的,“怎么做”是一种实现,而“做什么”则体现着意图。将意图与实现分离开来是内部DSL与普通的程序代码一个重要的区别同样这也是一个好设计的考虑因素。

Martin Fowler在讨论DSL定义时提到了DSL的4个关键元素

  • 计算机程序设计语言Computer programming language
  • 语言性Language nature
  • 受限的表达性Limited expressiveness
  • 针对领域Domain focus

其中语言性强调的就是DSL要有连贯的表达能力。也就是说你设计自己的DSL时重点是要体现出意图。抛开是否要实现一个DSL不说的确程序员在写代码时应该关注代码的表达能力,而这也恰恰是很多程序员忽略的,同时也是优秀程序员与普通程序员拉开差距的地方。

普通程序员的关注点只在于功能如何实现,而优秀的程序员会懂得将不同层次的代码分离开来,将意图和实现分离开来,而实现可以替换。

说到这里你就不难理解学习内部DSL的价值了退一步说你不一定真的要自己设计一个内部DSL但学会将意图与实现分离开这件事对日常写代码也是有极大价值的。

有了这个意识你就可以很好地理解程序设计语言的一个重要发展趋势声明式编程。现在一些程序设计语言的语法就是为了方便进行声明式编程典型的例子就是Java的Annotation。正是它的出现Spring原来基于XML的外部DSL就逐步转向了今天常用的内部DSL了也就是很多人熟悉的Java Config。

你会发现,虽然我在这说的是写代码,但分离意图和实现其实也是一个重要的设计原则,是的,想写好代码,一定要懂得设计

总结时刻

今天我们讨论了领域特定语言这是针对某个特定领域的程序设计语言。DSL在软件开发领域中得到了广泛的应用。要实现一个DSL首先要构建好模型。

常见的DSL主要是外部 DSL和内部DSL。二者的主要区别在于DSL采用的是不是宿主语言。相对于外部 DSL内部DSL的开发成本更低与我们的日常工作结合得更加紧密。

内部DSL体现更多的是表达能力相对于传统的代码编写方法而言这种做法很好地将作者的意图体现了出来。即便我们不去设计一个内部DSL这种写代码的方式也会对我们代码质量的提高大有助益。

关于语言,已经讲了四讲,我们先告一段落。下一讲,我们要来讨论编程范式,也就是做设计的时候,我们可以利用的元素有哪些。

如果今天的内容你只能记住一件事,那请记住:好的设计要迈向DSL我们可以从编写有表达性的代码起步

思考题

最后我想请你分享一下你还能举出哪些DSL的例子呢欢迎在留言区分享你的想法。

感谢阅读,如果你觉得这一讲的内容对你有帮助的话,也欢迎把它分享给你的朋友。