在Kotlin中使用DSL

1 DSL(domain-specific language)

1.1 DSL的定義

DSL被定義為處理特定領域問題而定義的計算機語言, 與其相對的是GPL(general-purpose language). 通常使用的C/C++, Java, Python都是GPL, 而像make, Gradle, 正則表達式都是DSL. DSL通常被分為內(nèi)部DSL和外部DSL. 外部DSL是指獨立于其他語言的, 獨立實現(xiàn)編譯(或解釋)的領域專用語言; 而內(nèi)部DSL通常是在其他語言的內(nèi)部, 利用宿主語言的語法特性而實現(xiàn)的. gradle是內(nèi)部DSL, 因為其是基于Groovy語言實現(xiàn)的, 而正則表達式是外部DSL, 因為其解釋是(基本)不依賴宿主語言的.

1.2 DSL的優(yōu)勢

DSL為簡化問題提供了便捷的途徑. Gradle使用Groovy語言來做項目配置, 可擴展性大大增強, 能夠在配置中完成定義和動作兩方面的內(nèi)容, 這些在基于XML的配置中是難以實現(xiàn)的. 事實上, 很多配置管理類的項目都完成了類似的事情. 在Web前端領域, 諸如gulp的打包工具, 依托Node.js也實現(xiàn)了配置的可執(zhí)行性. 而宿主語言的DSL能力通常會讓這一思想更優(yōu)雅地表現(xiàn)出來.

2 Kotlin語言中DSL的基礎

2.1 中綴記法

當一個函數(shù)滿足下列條件的時候, 能夠以中綴記法調(diào)用:

  • 是成員函數(shù)或者擴展函數(shù)
  • 有且僅有一個參數(shù)
  • 使用infix關鍵字修飾

一個典型的中綴記法調(diào)用如下:

// Define extension to Int
infix fun Int.shl(x: Int): Int {
...
}
// call extension function using infix notation
1 shl 2
// is the same as
1.shl(2)

2.2 作為參數(shù)的函數(shù)

在Kotlin中, 實現(xiàn)了函數(shù)是一等公民的思想, 這是函數(shù)式編程語言的基本概念. 同時, Kotlin采用了類型推導的方式來標記函數(shù)的類型, 這和Haskell一類的語言是類似的. 相比于Java和C#語言中強類型的函數(shù)表達式類型, 這種類型推導的記法更加的清晰; 相比Python等弱類型語言, 類型推導能夠讓解釋器做更多的優(yōu)化, 提供了更高的性能.
Kotlin也提供了一個相當有趣的語法, 如果函數(shù)調(diào)用的最后一個參數(shù)是函數(shù), 那么該參數(shù)能夠夠寫到函數(shù)調(diào)用的外部:

// 寫在外部的lambda表達式, 通常這種調(diào)用是為了傳入一個回調(diào)函數(shù)
foo(1, "something") { it ->
    do_something(it)
}

再考慮Kotlin的另外一個特性, 僅有一個參數(shù)的lambda表達式的參數(shù)可以省略不寫, 那么代碼會更加的簡潔:

// lambda表達式中的it, 會被解釋為該lambda表達式的參數(shù)
foo(1, "something") {
    do_something(it)
}

2.3 擴展函數(shù), function type with receiver

這是一種特殊的函數(shù)類型, 語法為T.() -> K, 代指執(zhí)行T類型的成員方法, 返回K類型的值. 舉一個簡單的例子:

class Person {
    fun setName(name: String) { ... }
    fun setAge(age: Int) { ... }
}

fun person(foo: Person.() -> Unit): Person {
    val person = Person()
    html.foo()
    return p
}

var jack = person {
    this.setName("Jack")
    this.setAge(20)
}
// this 是可以忽略的
var bruce = person {
    setName("Bruce")
    setAge(21)
}

在調(diào)用傳入的函數(shù)時, 需要提供一個T類型的實例, 在執(zhí)行完所有傳入的函數(shù)后, 返回該T類型的實例. 這種語法為Kotlin帶來了較強的DSL能力.

3 Type-Safe Builders

3.1 簡介

Builders是Groovy社區(qū)比較火的概念. Builders允許使用半聲明(semi-declarative)的方法定義數(shù)據(jù), 這種方式十分適合用于XML的生成, UI組件的布局.
Kotlin可以為BUilder是提供類型檢查, 也支持動態(tài)類型的Builders.

一個簡單的Type-Safe Builder的示例(來自官方文檔):

fun result(args: Array<String>) =
    html {
        head {
            title {+"XML encoding with Kotlin"}
        }
        body {
            h1 {+"XML encoding with Kotlin"}
            p {+"this format can be used as an alternative markup to XML"}
            // an element with attributes and text content
            a() {+"Kotlin"}
            // mixed content
            p {
                +"This is some"
                b {+"mixed"}
                +"text. For more see the"
                a() {+"Kotlin"}
                +"project"
            }
            p {+"some text"}
            // content generated by
            p {
                for (arg in args)
                    +arg
            }
        }
    }

這個Builder可用于生成一段HTML文檔.

3.2 具體實現(xiàn)

本節(jié)以上述XML Builder說明建立Builder的一般方法.

通過2.3節(jié)的例子, 可以使用lambda表達式來表達層級關系和子節(jié)點:

fun html(init: HTML.() -> Unit): HTML {
    val html = HTML()
    html.init()
    return html
}

在HTML類中實現(xiàn)head, body成員方法, 將能夠實現(xiàn)html級別文檔的構造; 而headbody也可以用類似的方法去添加子元素. 為了實現(xiàn)添加子元素的功能, 定義一個通用函數(shù):

protected fun <T : Element> initTag(tag: T, init: T.() -> Unit): T {
    tag.init()
    children.add(tag)
    return tag
}

此時, 可以很方便地實現(xiàn)headbody, 如下所示, 其中HeadBody是對應的類.

fun head(init: Head.() -> Unit) = initTag(Head(), init)
fun body(init: Body.() -> Unit) = initTag(Body(), init)

至此, 已經(jīng)能夠處理所有的元素節(jié)點, 對于文本節(jié)點, 需要特別地對待. 示例代碼中, 使用+完成了文本到函數(shù)調(diào)用的轉換(花括號是lambda表達式, 其中的內(nèi)容為函數(shù)調(diào)用, 只有通過函數(shù)調(diào)用并用某種方法接受該文本, 文本才能被添加到Builder中). 這個+是Kotlin中String類的一個前綴操作符unaryPlus, 其實現(xiàn)如下:

fun String.unaryPlus() {
    children.add(TextElement(this))
}

而帶屬性的節(jié)點需要額外的參數(shù)傳入屬性信息, 例如對于錨點節(jié)點, 可以如下實現(xiàn):

fun a(href: String, init: A.() -> Unit) {
    val a = initTag(A(), init)
    a.href = href
}

至此, 一個樸素的XML生成器已經(jīng)完成. 完整的代碼, 可以參考Kotlin 官網(wǎng)

4 DSL的應用

4.1 when語法的改良實現(xiàn)

此節(jié)內(nèi)容來自知乎專欄 - Kotlin雜談(二) - 以DSL重新打造when

Kotlin使用when關鍵字代替了通常語言里的switch關鍵字, 并且提供了更強的特性. 但是其仍無法實現(xiàn)類似SQL中case表達式的模式, 即:

when {
    1 > 5 -> print("something") // OK
}
    
when (1) {
    > 5 -> print("something") // Error
}

問題的關鍵是在when(arg)表達式的內(nèi)部, 無法引用arg. 可以通過類似3節(jié)中的構造方法來構造DSL解決這個問題, 判斷條件的結果作為判斷條件回調(diào)函數(shù)是否執(zhí)行的依據(jù).

fun <T: Comparable<T>> ewhen(target: T, tester: Tester<T>.() -> Unit) {
    val test = Tester(target)
    test.tester()
    test.funFiltered?.invoke() ?: return
}

tester是when下的一系列判斷, 根據(jù)執(zhí)行tester的結果來可以選擇要執(zhí)行的回調(diào), 即funFiltered.

Tester類的實現(xiàn): 原作者的代碼

class Tester<T: Comparable<T>>(val it: T) {
    var funFiltered: (() -> Unit)? = null

    infix fun Boolean.then(block: () -> Unit) {
        if (this && funFiltered == null)
            funFiltered = block
    }

    fun lt(arg: T) = it < arg
    fun gt(arg: T) = it > arg
    fun ge(arg: T) = it >= arg
    fun le(arg: T) = it <= arg
    fun eq(arg: T) = it == arg
    fun ne(arg: T) = it != arg
    fun ct(arg: Collection<T>) = it in arg
    fun ct(arg: String) = it as String in arg
    fun nc(arg: Collection<T>) = it !in arg
    fun nc(arg: String) = it as String !in arg
}

Tester中, 如果保存一個funFiltered的列表, 將能夠實現(xiàn)瀑布式switch的效果.

4.2 一些賞心悅目的基于DSL的庫

本節(jié)來自知乎專欄 - Kotlin 一個很厲害的 DSL 寫法

4.2.1 Anko

Anko是Kotlin用于安卓界面布局的框架, 使用DSL的方式代替了Activity的XML配置.

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    verticalLayout {
        padding = dip(30)
        editText {
            hint = "Name"
            textSize = 24f
        }
        editText {
            hint = "Password"
            textSize = 24f
        }
        button("Login") {
            textSize = 26f
        }
    }
}

4.2.2 JavaFX DSL

class MyView : View() {
    private val persons = FXCollections.observableArrayList(
        Person(1, "Samantha Stuart", LocalDate.of(1981, 12, 4)),
        Person(2, "Tom Marks", LocalDate.of(2001, 1, 23)),
        Person(3, "Stuart Gills", LocalDate.of(1989, 5, 23)),
        Person(3, "Nicole Williams", LocalDate.of(1998, 8, 11))
    )
    override val root = tableview(persons) {
        column("ID", Person::id)
        column("Name", Person::name)
        column("Birthday", Person::birthday)
        column("Age", Person::age)
        columnResizePolicy = SmartResize.POLICY
    }
}
最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末疗隶,一起剝皮案震驚了整個濱河市腮郊,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌西篓,老刑警劉巖主届,帶你破解...
    沈念sama閱讀 216,692評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件淘这,死亡現(xiàn)場離奇詭異忍些,居然都是意外死亡宜鸯,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,482評論 3 392
  • 文/潘曉璐 我一進店門仆邓,熙熙樓的掌柜王于貴愁眉苦臉地迎上來鲜滩,“玉大人伴鳖,你說我怎么就攤上這事♂愎瑁” “怎么了榜聂?”我有些...
    開封第一講書人閱讀 162,995評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長嗓蘑。 經(jīng)常有香客問我须肆,道長,這世上最難降的妖魔是什么桩皿? 我笑而不...
    開封第一講書人閱讀 58,223評論 1 292
  • 正文 為了忘掉前任豌汇,我火速辦了婚禮,結果婚禮上泄隔,老公的妹妹穿的比我還像新娘拒贱。我一直安慰自己,他們只是感情好佛嬉,可當我...
    茶點故事閱讀 67,245評論 6 388
  • 文/花漫 我一把揭開白布逻澳。 她就那樣靜靜地躺著,像睡著了一般巷燥。 火紅的嫁衣襯著肌膚如雪赡盘。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,208評論 1 299
  • 那天缰揪,我揣著相機與錄音陨享,去河邊找鬼钝腺。 笑死抛姑,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的艳狐。 我是一名探鬼主播定硝,決...
    沈念sama閱讀 40,091評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼毫目!你這毒婦竟也來了蔬啡?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 38,929評論 0 274
  • 序言:老撾萬榮一對情侶失蹤镀虐,失蹤者是張志新(化名)和其女友劉穎箱蟆,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體刮便,經(jīng)...
    沈念sama閱讀 45,346評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡空猜,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,570評論 2 333
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片辈毯。...
    茶點故事閱讀 39,739評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡坝疼,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出谆沃,到底是詐尸還是另有隱情钝凶,我是刑警寧澤,帶...
    沈念sama閱讀 35,437評論 5 344
  • 正文 年R本政府宣布管毙,位于F島的核電站腿椎,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏夭咬。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,037評論 3 326
  • 文/蒙蒙 一铆隘、第九天 我趴在偏房一處隱蔽的房頂上張望卓舵。 院中可真熱鬧,春花似錦膀钠、人聲如沸掏湾。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,677評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽融击。三九已至,卻和暖如春雳窟,著一層夾襖步出監(jiān)牢的瞬間尊浪,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,833評論 1 269
  • 我被黑心中介騙來泰國打工封救, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留拇涤,地道東北人。 一個月前我還...
    沈念sama閱讀 47,760評論 2 369
  • 正文 我出身青樓誉结,卻偏偏與公主長得像鹅士,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子惩坑,可洞房花燭夜當晚...
    茶點故事閱讀 44,647評論 2 354

推薦閱讀更多精彩內(nèi)容