Kotlin學(xué)習(xí) 11 -- 使用 DSL 構(gòu)建專有的語法結(jié)構(gòu)

本篇文章主要介紹以下幾個知識點:

SUMMER DAY (圖片來源于網(wǎng)絡(luò))

DSL 的全稱是領(lǐng)域特定語言(Domain Specific Language),通過它可以編寫出一些看似脫離其原始語法結(jié)構(gòu)的代碼,從而構(gòu)建出一種專有的語法結(jié)構(gòu)。

舉個栗子,平時在項目中添加依賴庫的語法結(jié)構(gòu)就是 Groovy 語言的提供的 DSL 功能:

dependencies {
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0"
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.0"
}

在 Kotlin 中實現(xiàn) DSL 的方式不固定,最常見的是通過高階函數(shù)的方式來實現(xiàn)。(其他比如用 infix 函數(shù)構(gòu)建出特有的語法結(jié)構(gòu))。


接下來借助 Kotlin 的 DSL來實現(xiàn)類似上面添加依賴庫的語法結(jié)構(gòu),首先創(chuàng)建個 DSL.kt 文件,里面定義個 Dependency 類如下:

class Dependency {
    // 定義個 list 來保存所有依賴庫
    val libraries = ArrayList<String>()

    // 定義向 list 中添加依賴庫的方法
    fun implementation(lib: String) {
        libraries.add(lib)
    }
}

接下來定義一個 dependencies 高階函數(shù)如下:

// 把函數(shù)類型參數(shù)定義到 Dependency 類中,調(diào)用它時先創(chuàng)建實例,通過實例調(diào)用函數(shù)類型參數(shù)
// 傳入的 Lambda 表達(dá)式就能得到執(zhí)行,最后把保存的依賴庫集合返回
fun dependencies(block: Dependency.() -> Unit): List<String> {
    val dependency = Dependency()
    dependency.block()
    return dependency.libraries
}

經(jīng)過這樣的 DSL 設(shè)計后,就可以在項目中使用如下的語法結(jié)構(gòu)了:

dependencies {
    // dependencies 接收一個函數(shù)類型參數(shù) Lambda 表達(dá)式,此時表達(dá)式中有 Dependency 的上下文,
    // 從而可以直接調(diào)用 Dependency 類中方法
    implementation ("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0")
    implementation ("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.0")
}

另外,還可以通過 dependencies 函數(shù)的返回值來獲取所添加的依賴庫:

fun main() {
    val libraries = dependencies {
        implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0")
        implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.0")
    }
    for (lib in libraries) {
        println(lib)
    }
}
// 打印結(jié)果:
// org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0
// org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.0

這種語法結(jié)構(gòu)比直接調(diào)用 Dependency 對象的 implementation() 方法更加直觀,當(dāng)添加的依賴庫越多,使用 DSL 寫法的優(yōu)勢越明顯。


再舉個栗子,在 Kotlin 中借助 DSL 定義一種語法結(jié)構(gòu)來動態(tài)生成表格所對應(yīng)的 HTML 代碼,其中 HTML 代碼如下:

<!-- 一個兩行三列的 html 表格 -->
<table>
    <tr>
        <td>apple</td>
        <td>grape</td>
        <td>orange</td>
    </tr>
    <tr>
        <td>pear</td>
        <td>banana</td>
        <td>orange</td>
    </tr>
</table>

若用字符串拼接的方式來實現(xiàn)顯然十分繁瑣,也難以閱讀。而借助 DSL 構(gòu)建的語法結(jié)構(gòu)能夠輕松實現(xiàn)生成上面的 HTML 代碼。

首先定義個 Td 類如下:

// <td> 標(biāo)簽表示一個單元格
class Td {
    // 定義 content 字段來存儲單元格的顯示內(nèi)容
    var content = ""

    // 定義返回一段<td>標(biāo)簽的 html 代碼的方法
    fun html() = "\n\t\t<td>$content</td>"
}

接著再定義個 Tr 類如下:

// <tr> 標(biāo)簽表示表格的行,可包含多個 <td> 標(biāo)簽
class Tr {
    // 定義個集合來存儲當(dāng)前 Tr 所包含的 Td 對象
    private val children = ArrayList<Td>()

    // 定義向集合中添加 Td 對象的方法
    fun td(block: Td.() -> String) {
        val td = Td()
        td.content = td.block()
        children.add(td)
    }

    // 定義返回一段<tr>標(biāo)簽的 html 代碼的方法
    fun html() = StringBuilder().apply {
        append("\n\t<tr>")
        for (childTag in children) {
            append(childTag.html())
        }
        append("\n\t</tr>")
    }.toString()
}

現(xiàn)在,就可以用如下語法來構(gòu)建表格中的一行數(shù)據(jù):

val tr = Tr()
tr.td { "apple" }
tr.td { "grape" }
tr.td { "orange" }

最后再定義個 Table 類如下:

// <table> 標(biāo)簽包含多個 <tr> 標(biāo)簽
class Table {
    private val children = ArrayList<Tr>()

    fun tr(block: Tr.() -> Unit) {
        val tr = Tr()
        tr.block()
        children.add(tr)
    }

    fun html() = StringBuilder().apply {
        append("<table>")
        for (childTag in children) {
            append(childTag.html())
        }
        append("\n</table>")
    }.toString()
}

這樣,就可以用如下語法來構(gòu)建一個表格了:

val table = Table()
table.tr { 
    td { "apple" }
    td { "grape" }
    td { "orange" }
}
table.tr { 
    td { "pear" }
    td { "banana" }
    td { "orange" }
}

當(dāng)然,還可以進(jìn)一步精簡,定義個 table() 函數(shù)如下:

fun table(block: Table.() -> Unit): String {
    val table = Table()
    table.block()
    return table.html()
}

現(xiàn)在就可以用以下語法結(jié)構(gòu)來動態(tài)生成一個表格對應(yīng)的 HTML 代碼了:

fun main() {
    val html = table {
        tr {
            td { "apple" }
            td { "grape" }
            td { "orange" }
        }
        tr {
            td { "pear" }
            td { "banana" }
            td { "orange" }
        }
    }
    println(html)
}

另外,在 DSL 中也可以用 Kotlin 的其他語法特性,比如循環(huán)來批量生成標(biāo)簽:

fun main() {
    val html = table {
        repeat(2) {
            tr {
                val fruits = listOf("apple", "grape", "orange")
                for (fruit in fruits) {
                    td { fruit }
                }
            }
        }
    }
}

小結(jié):構(gòu)建 DSL,只是通過對高階函數(shù)的靈活運(yùn)用,編寫出一段看似不屬于 Kotlin 語言的語法結(jié)構(gòu)。這里只是提供了下 DSL 定制的思路。

本篇文章就介紹到這。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容