DSL · Kotin知识点难点归纳总结

## DSL DSL（Domain-Specific Language，领域特定语言）指的是专注于特定领域问题的计算机语言，不同于通用的计算机语言（GPL），领域特定语言只用在某些特定的领域，这些领域可能是某一种产业，例如保险、教育、航空、医疗等，也可能是一种方法或技术，例如数据库SQL、HTML等。本章将针对DSL进行详细讲解。 ### DSL简介 #### DSL概述 DSL是问题解决方案模型的外部封装，这个模型可能是一个API库，也可能是一个完整的框架，没有具体的标准来区分DSL和普通的API，DSL代码更易于理解，不仅对于开发人员而且对于初学者来说也更易于理解。常见的DSL有软件构建领域Ant、UI设计师HTML、硬件设计师VHDL。 DSL与通用的编程语言的区别如下。 * DSL供非程序员和领域专家使用。 * DSL有更高级的抽象，不涉及类似数据结构的细节。 * DSL表现力有限，其只能描述该领域的模型，而通用编程语言能够描述任意的模型。根据是否从宿主语言构建而来，DSL分为内部DSL（从一种宿主语言构建而来）和外部DSL（从零开始构建的语言，需要实现语法分析器等）。在Kotlin中创建DSL时，一般有以下3个特性。 * 扩展函数与扩展属性。 * 带接收者的Lambda表达式（高阶函数）。 * invoke()函数的调用约定（使用invoke约定可以构建灵活的代码块嵌套）。 #### DSL程序上一个小节我们对DSL进行了简单的介绍，接下来通过两个案例来演示DSL风格的代码与传统代码的区别。 1. 传统风格的代码在IDEA中，创建一个名为Chapter11的Kotlin项目，该项目的包名指定为com.itheima. chapter11，接着在该包中创建一个DSL.kt文件，在该文件中按照传统的形式分别创建一个Person类和Address类，具体代码如下所示。 ``` class Person(var name: String? = null, var age: Int? = null, var address: Address? = null) { override fun toString(): String { return "Person(name='$name', age=$age, address=$address)" } } class Address(var city: String? = null, var street: String? = null, var number: Int? = null) { override fun toString(): String { return "Address(city='$city', street='$street', number=$number)" } } fun main(args: Array<String>) { val address = Address("北京", "长安街", 30) val person = Person("张三", 20, address) println(person) } ``` 运行结果： ``` Person（name='张三', age=20, address=Address（city='北京', street='长安街', number=30）） ``` 上述代码中，创建了两个类，分别是Person和Address，在Person类中传递了姓名、年龄以及住址信息。在Address类中传递了住址信息中的城市、街道以及门牌号。最后在main()函数中分别创建这两个类的对象并打印person对象。 2. DSL风格的代码由于上面示例中的main()方法中的内容符合API的规范，但不符合人类的自然语言理解，如果想要让初学者更好地理解代码，则需要对这段代码进行DSL风格的一个抽取。修改后的代码如下所示。 ``` class Person(var name: String? = null, var age: Int? = null, var address: Address? = null) { override fun toString(): String { return "Person(name='$name', age=$age, address=$address)" } } class Address(var city: String? = null, var street: String? = null, var number: Int? = null) { override fun toString(): String { return "Address(city='$city', street='$street', number=$number)" } } /** * address()是一个扩展函数 * 这个函数中传递的参数也是一个函数，该函数的返回值为Unit */ fun Person.address(block: Address.() -> Unit) { val a = Address() address = a block(a) } /** * person()是一个扩展函数，这个函数返回一个Person对象， * 这个函数中传递的参数也是一个函数，该函数的返回值为Unit */ fun person(block: Person.() -> Unit): Person { //Person相当于把这个函数定义在Person中 val p = Person() block(p) //通过这个函数把main()函数中设置的对应的值传递过来 return p } fun main(args: Array<String>) { val p = person { //扩展函数 name = "张三" age = 20 address { city = "北京" street = "长安街" number = 30 } } println(p) } ``` 运行结果： ``` Person（name='张三', age=20, address=Address（city='北京', street='长安街', number=30）） ``` 上述代码中，分别创建了person()扩展函数和address()扩展函数，这两个扩展函数中通过block()函数将main()函数中设置的对应数据传递过来。在main()函数中，创建了一个Person的扩展函数，这个扩展函数既是一个lambda表达式，也是一个匿名函数，通过这个函数设置Person类中的一些属性的值。以上的这种代码风格就是DSL风格。 3. 通过apply()函数对DSL代码进行优化上述DSL风格的代码中，扩展函数address()和person()还可以进一步通过Kotlin中的apply()函数进行优化，优化后的代码如下所示： ``` fun Person.address(block: Address.() -> Unit) { address= Address().apply(block) } fun person(block: Person.() -> Unit): Person { return Person().apply(block) } ``` ### DSL的使用在实际开发中，DSL会在特定的情况下使用，对代码进行优化。在本节我们将通过传统代码与DSL代码分别打印HTML标签并进行对比来观察DSL的优点。 #### 打印简单的HTML标签在Kotlin中，通过普通API来打印HTML中最简单的“＜html＞＜/html＞”标签，具体代码如下所示。 ``` //标签对象 class Tag(var name: String) { var list = ArrayList<Tag>() //添加子标签 fun addChild(tag: Tag) { list.add(tag) } //字符串 override fun toString(): String { val sb = StringBuilder() //开始标签 sb.append("<$name>") //循环获取子标签并添加到sb中 list.forEach { sb.append(it) } //结束标签 sb.append("</$name>") return sb.toString() } } fun main(args: Array<String>) { val html = Tag("html") println(html) } ``` 运行结果： ``` ＜html＞＜/html＞ ``` 由于上述代码中的toString()方法中多次使用变量sb容易产生代码冗余，因此为了不多次使用这个变量，也可以使用DSL中的apply()方法将上述代码进行简写，具体代码如下所示。 ``` //标签对象 class DSLTag(var name: String) { var list = ArrayList<Tag>() //添加子标签 fun addChild(tag: Tag) { list.add(tag) } //字符串 override fun toString(): String { return StringBuffer().apply { append("<$name>") list.forEach { append(it.toString()) } append("</$name>") }.toString() } } fun main(args: Array<String>) { val html = DSLTag("html") println(html) } ``` 运行结果： ``` ＜html＞＜/html＞ ``` #### 打印复杂的HTML标签在Kotlin中，可以通过普通API打印“`＜html＞＜head＞＜title＞你好＜/title＞＜/head＞＜body＞＜/body＞＜div＞＜/div＞＜/html＞`”这些复杂的HTML标签，具体代码如下所示。 ``` class Html : HtmlTag("html") //Html标签 class Head : HtmlTag("head") //Head标签 class Body : HtmlTag("body") //Body标签 //标签对象 open class HtmlTag(var name: String) { var list = ArrayList<HtmlTag>() //添加子标签 fun addChild(tag: HtmlTag) { list.add(tag) } //字符串 override fun toString(): String { return StringBuffer().apply { append("<$name>") list.forEach { append(it.toString()) } append("</$name>") }.toString() } } //Title标签 class Title(var title: String) : HtmlTag("title") { override fun toString(): String { return "<title>$title</title>" } } fun main(args: Array<String>) { val html = Html() val head = Head() val title = Title("你好") val body = Body() head.addChild(title) //title添加到head中，顺序不能变，关系不是很强，容易出错 html.addChild(head) //head添加到html中 html.addChild(body) //body添加到html中 println(html) } ``` 运行结果： ``` ＜html＞＜head＞＜title＞你好＜/title＞＜/head＞＜body＞＜/body＞＜/html＞ ``` 上述代码中，第33～35行代码主要是通过addChild()方法将对应的标签添加到＜head＞标签或者＜html＞标签中，这3行代码的顺序不能任意变动，否则容易出现内存泄露。如果使用第33～35行的代码来设置对应的标签，则标签的子关系不是很强并且容易出现错误。因此，接下来我们通过DSL风格来修改上述代码。修改后的代码如下所示。 ``` class HtmlDSL : HtmlTagDSL("html") class HeadDSL : HtmlTagDSL("head") class BodyDSL : HtmlTagDSL("body") open class HtmlTagDSL(var name: String) { val list = ArrayList<HtmlTagDSL>() fun addChild(tag: HtmlTagDSL) { list.add(tag) } override fun toString(): String { return StringBuffer().apply { append("<$name>") list.forEach { append(it.toString()) } append("</$name>") }.toString() } } class TitleDSL : HtmlTagDSL("title") { var title: String? = null override fun toString(): String { return "<title>$title</title>" } } fun html(block: HtmlDSL.() -> Unit): HtmlTagDSL { return HtmlDSL().apply(block) } fun HtmlDSL.head(block: HeadDSL.() -> Unit) { addChild(HeadDSL().apply(block)) } fun HeadDSL.title(block: TitleDSL.() -> Unit) { addChild(TitleDSL().apply(block)) } fun HtmlDSL.body(block: BodyDSL.() -> Unit) { addChild(BodyDSL().apply(block)) } fun main(args: Array<String>) { val result = html { //扩展函数 head { title { title = "你好" } } body { } } println(result) } ``` 运行结果： ``` ＜html＞＜head＞＜title＞你好＜/title＞＜/head＞＜body＞＜/body＞＜/html＞ ``` ### Anko插件 Anko是一个DSL，它是用Kotlin写的Android插件，由JetBrains公司开发的。Anko主要的作用是替代以前用XML的方式来生成UI布局。大家都知道，Android界面是通过XML来进行布局的，一个应用中通常有多个布局，当程序运行时，XML被转化为Java代码，这就导致程序很耗费资源。由于Anko是直接通过Java代码来编写布局文件的，不用进行转化，因此使用Anko编写Android界面的布局会更加简单、快捷。接下来我们通过一个案例来演示Anko生成Android界面的布局。首先看一下最熟悉的XML方式生成的UI布局，布局名称以main.xml为例。具体代码如下所示。 ``` <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_height="match_parent" android:layout_width="match_parent"> <EditText android:id="@+id/title" android:layout_width="match_parent" android:layout_heigh="wrap_content" android:hint="@string/title_hint" /> <Button android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@string/add" /> </LinearLayout> ``` 在上述XML文件中，主要是放置了1个EditText控件用于显示一个标题，1个Button控件用于显示一个添加的按钮。接下来使用Anko生成Android布局，与传统的XML方式进行对比，并在这个布局中绑定Button按钮的点击事件。这段代码是在Android项目中的Activity中添加的，在这里将这个Activity命名为MainActivity，具体代码如下所示。 **MainActivity.java ** ``` verticalLayout { var title = editText { id = R.id.title hintResource = R.string.title_hint } button { textResource = R.string.add onClick { view -> { title.text = "Foo" } } } } ``` 从上述代码可知，DSL的一个主要优点是只需很少的时间就可以理解和传达某个领域的详细信息。