如何创建 Kotlin DSL - DSL 语法 Kotlin。

11

就像使用 anko 一样,您可以编写如下的回调函数:

alert {
    title = ""
    message = ""
    yesButton {
       toast("Yes") 
    }
    noButton { 
       toast("No")
    }
}

我该如何创建像这样的嵌套函数?我尝试以下方式创建,但似乎不起作用。
class Test {
    fun f1(function: () -> Unit) {}
    fun f2(function: () -> Unit) {}
}

现在,如果我将这个与扩展函数一起使用,
fun Context.temp(function: Test.() -> Unit) {
    function.onSuccess() // doesn't work
}

从Activity中调用:

temp {
    onSuccess {
        toast("Hello")
    }
}

无法正常工作。我在这里仍然缺乏一些基本概念。有人可以指导吗?


2
请看这个链接:https://kotlinlang.org/docs/reference/type-safe-builders.html - marstran
2个回答

15

Kotlin DSLs

Kotlin非常适合编写自己的类型安全构建器,也称为领域特定语言。正如你提到的,Anko库是使用DSL的一个例子。这里你需要理解的最重要的语言特性叫做“带接收者的函数字面值”,你已经使用过了:Test.() -> Unit

带接收者的函数字面值-基础知识

Kotlin支持“带接收者的函数字面值”概念。它使得在函数字面值体内可以无需任何特定限定符来调用接收者上的可见方法。这与扩展函数非常相似,在扩展函数中也可以访问扩展对象的成员。

一个简单的例子,也是Kotlin标准库中最酷的函数之一,就是apply

public inline fun <T> T.apply(block: T.() -> Unit): T { block(); return this }

正如您所看到的,此处将带有接收器的函数文字作为参数block。这个block只是被执行,并返回接收器(它是T的一个实例)。实际操作如下:

val text: String = StringBuilder("Hello ").apply {
            append("Kotliner")
            append("! ")
            append("How are you doing?")
        }.toString()

一个StringBuilder作为接收者并在其上调用apply{}(lambda表达式)中作为参数传递的block不需要使用其他限定符,只需多次调用StringBuilder的可见方法append

具有接收者的函数字面值 - 在DSL中

如果您查看文档中的此示例,则可以看到它的实际效果:

class HTML {
    fun body() { ... }
}

fun html(init: HTML.() -> Unit): HTML {
    val html = HTML()  // create the receiver object
    html.init()        // pass the receiver object to the lambda
    return html
}


html {       // lambda with receiver begins here
    body()   // calling a method on the receiver object
}

html() 函数期望一个带有 HTML 作为接收器的函数字面量。在函数体中,您可以看到它是如何使用的:创建了一个 HTML 实例并调用了其 init 方法。

好处

调用此类期望带有接收器的函数字面量(例如 html())的高阶函数的调用者,可以使用任何可见的 HTML 函数和属性而无需额外限定符(例如 this),正如您在调用中所看到的那样。

html {       // lambda with receiver begins here
    body()   // calling a method on the receiver object
}

你的示例

我创建了一个简单的示例,展示了您想要的内容:

class Context {
    fun onSuccess(function: OnSuccessAction.() -> Unit) {
        OnSuccessAction().function();
    }

    class OnSuccessAction {
        fun toast(s: String) {
            println("I'm successful <3: $s")
        }
    }
}

fun temp(function: Context.() -> Unit) {
    Context().function()
}

fun main(args: Array<String>) {
    temp {
        onSuccess {
            toast("Hello")
        }
    }
}

1
需要一些时间来理解这个。还没有直接进入我的脑海:/ - kirtan403
你到底哪里不理解呢?让我提供更多信息给你吧。 - s1m0nw1
谢谢回复。我会在晚上看一下,然后告诉你。 - kirtan403
我有一点理解。假设 temp 是上下文函数。现在你正在调用 temp(上下文)的 onSuccess 方法,这还好。但是,当进入它时,我完全被搞混了.. :/ - kirtan403
明白了!谢谢! :) - kirtan403
显示剩余7条评论

1
在你的例子中,alert是返回某个类(例如Alert)的函数。此函数接受带有接收器的函数字面量作为参数。
在你的例子中,你应该将onSuccess作为Test类的成员方法,并且你的temp函数应该返回Test类的实例而不调用它。但是,为了让toast按照你的意愿被调用,它必须是由onSuccess返回的任何类的成员函数。
我认为你并不完全理解带有接收器的函数字面量的工作原理。当你拥有fun(something: A.() -> Unit)时,这意味着“something”是A类的成员函数。
所以,
你可以看看我的博客文章:如何为AsyncTask创建小型DSL

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接