Kotlin实践：自定义DSL

Kotlin语言最显著的特点就是简洁，Kotlin中的诸多语言特性都是为了精简代码同时保证代码具有更高的可读性。通过合理的组合这些语言特性实现DSL则可以将这种简洁性发挥到极致。

本文以封装Dialog为例，简述如何构造项目内部DSL。

什么是DSL？

DSL是Domain-specific language(领域特定语言)的缩写，维基百科的定义是指的是专注于某个应用程序领域的计算机语言。

其实我们熟悉的SQL就是一种领域特定语言，与编程语言相比，SQL语句更接近口语，这也就使得SQL具有更强的表达能力和可读性。

与一般API不同的是，DSL提供了一种特殊的语法结构，其目的也就是为了让代码更易于理解。

DSL:

1. 简洁
2. 可读性强
3. 具有特殊的语法结构
4. 应用于特定领域

为什么要用Kotlin构造DSL？

如果说构造DSL的目的是为了增强可读性，简化代码，那么为什么一定要选择Kotlin呢？Java语言就无法构造DSL了吗？

其实在Android领域就有很多库提供了类DSL的接口，譬如Picasso：

Picasso.get()
  .load(url)
  .resize(50, 50)
  .centerCrop()
  .into(imageView)

从某种意义上将，Picasso的接口复合DSL定义，但是以Java现有的语言特性来说，其在构造DSL方面没有太多的发挥空间。

而在Kotlin的世界中，有诸多的语言特性可以用于构造更为简洁明晰的DSL：

• 扩展函数
• 默认参数
• 中缀表达式
• Lambda表达式
• 函数参数
• 带接收者的函数参数
• ... ...

说了这么多，还是以实际的例子讲解一下如何实现具体的DSL吧。

DSL简化Dialog样板代码

先定义一个CustomDialogFragment，实现了项目中规定的Dialog样式，并提供相应的接口用于设置Title，Message，LeftButton和RightButton。

使用DSL前

val dialogFragment = CustomDialogFragment.newInstance()
dialogFragment.title = "title"
dialogFragment.message = "message"
dialogFragment.rightClicks(key = "确定", dismissAfterClick = true) {
    toast("clicked!")
}
val ft = supportFragmentManager.beginTransaction()
val prev = supportFragmentManager.findFragmentByTag("dialog")
if (prev != null) {
    ft.remove(prev)
}
ft.addToBackStack(null)
dialogFragment.show(ft, "dialog")

使用DSL后

showDialog {
    title = "title"
    message = "message"
    rightClicks {
        toast("clicked!")
    }
}

1. 省略了大量样板代码，保证了代码的简洁性
2. 语义清晰，具有极强的可读性
3. 语法结构与一般API不同
4. 应用于Android项目中的Dialog展示

如何实现？

1. 扩展函数

inline fun AppCompatActivity.showDialog(settings: CustomDialogFragment.() -> Unit) : CustomDialogFragment {
    val dialog = CustomDialogFragment.newInstance()
    dialog.apply(settings)
    val ft = this.supportFragmentManager.beginTransaction()
    val prev = this.supportFragmentManager.findFragmentByTag("dialog")
    if (prev != null) {
        ft.remove(prev)
    }
    ft.addToBackStack(null)
    dialog.show(ft, "dialog")
    return dialog
}

AppCompatActivity增加 showDialog( ) 扩展函数，这样就可以直接在Activity中调用showDialog( )方法展示Dialog了。

2. 带接收者的函数参数

showDialog( )方法中只有唯一的参数settings，其类型是CustomDialogFragment.() -> Unit，即带有CustomDialogFragment参数类型的函数。

在showDialog( )方法内部，构造了CustomDialogFragment对象，并调用dialog.apply(settings)方法，其作用即在构造Dialog对象后，对Dialog进行设置。在实际调用showDialog( )方法时，就可以持有该CustomDialogFragment对象，然后调用CustomDialogFragment提供的public接口配置Dialog。

3. 默认参数

fun leftClicks(key: String = "取消", dismissAfterClick: Boolean = true, callback: () -> Unit) {
    leftKey = key
    leftButtonDismissAfterClick = dismissAfterClick
    leftClicks = callback
}

在CustomDialogFragment提供的接口中，对一些变化不大的参数设置默认值，由于Kotlin语言支持默认参数，无需编写大量的重载方法。

源码

Github: HanderWei/android-dialog-dsl-sample

收尾

在Android项目中，除了Dialog之外还有很多场景需要编写大量样板代码，打造属于自己的DSL，可以帮助整个团队简化开发流程。

文中表述有误的地方希望评论指出。

参考文献

• Higher-Order Functions and Lambdas - Kotlin Programming Language
• From Java Builders to Kotlin DSLs - Kotlin Expertise Blog

个人博客

Hander's Blog