当前位置：首页 > news >正文

Kotlin 高端玩法之DSL

news 2025/8/10 10:48:31

如何在 kotlin 优雅的封装匿名内部类（DSL、高阶函数）

匿名内部类在 Java 中是经常用到的一个特性，例如在 Android 开发中的各种 Listener，使用时也很简单，比如：

//lambda
button.setOnClickListener(v -> {//do some thing
});
//匿名内部类
button.setOnClickListener(new View.OnClickListener() {@Overridepublic void onClick(View v) {//do some thing}
});

只有一个函数的接口在 Java 和 Kotlin 中都可以很方便的使用 lambda 表达式来缩略，但是如果接口含有多个函数，使用起来就比较”不优雅“了，例如：

etString.addTextChangedListener(object :TextWatcher{override fun beforeTextChanged(s: CharSequence?, start: Int, count: Int, after: Int) {TODO("Not yet implemented")}override fun onTextChanged(s: CharSequence?, start: Int, before: Int, count: Int) {TODO("Not yet implemented")}override fun afterTextChanged(s: Editable?) {TODO("Not yet implemented")}
})

使用起来与 Java 基本差不多，通过 object 关键字实现了一个匿名内部类，这种方法没什么大问题，例如上面的例子中，三个回调函数并非每次都要使用，很多场景可能只会用到其中一个或者几个，其余的都是空实现，每次都写这样一个匿名内部类只不过是不优雅而已。

在 Kotlin 中我们可以有两种方式实现比较优雅的使用匿名内部类：

1. DSL

2. 高阶函数

DSL

DSL 方式实现封装可以分为以下几步：

1.创建接口实现类：XxxxInterfaceDslImpl

还有上面的 TextWatcher 作为例子：

class TextWatcherDslImpl : TextWatcher {//原接口对应的kotlin函数对象private var afterTextChanged: ((Editable?) -> Unit)? = nullprivate var beforeTextChanged: ((CharSequence?, Int, Int, Int) -> Unit)? = nullprivate var onTextChanged: ((CharSequence?, Int, Int, Int) -> Unit)? = null/*** DSL中使用的函数，一般保持同名即可*/fun afterTextChanged(method: (Editable?) -> Unit) {afterTextChanged = method}fun beforeTextChanged(method: (CharSequence?, Int, Int, Int) -> Unit) {beforeTextChanged = method}fun onTextChanged(method: (CharSequence?, Int, Int, Int) -> Unit) {onTextChanged = method}/*** 实现原接口的函数*/override fun afterTextChanged(s: Editable?) {afterTextChanged?.invoke(s)}override fun beforeTextChanged(s: CharSequence?, start: Int, count: Int, after: Int) {beforeTextChanged?.invoke(s, start, count, after)}override fun onTextChanged(s: CharSequence?, start: Int, before: Int, count: Int) {onTextChanged?.invoke(s, start, before, count)}
}

这个实现类由三个部分组成：

1. 原接口方法对应的 Kotlin 函数对象，函数对象的签名与对应的方法签名保持一致。

2. DSL 函数，函数名称、签名都与原接口的方法一一对应，用于接收 lambda 赋值给 Kotlin 函数对象。

3. 原接口方法的实现，每个接口方法的实现，都是对实现类中 Kotlin 函数对象的调用。

2.创建与原函数同名的扩展函数，函数参数为实现类扩展函数

fun TextView.addTextChangedListenerDsl(init: TextWatcherDslImpl.() -> Unit) {val listener = TextWatcherDslImpl()listener.init()this.addTextChangedListener(listener)
}

扩展函数与原函数同名可以方便使用者调用，无需记忆其他函数名，如果担心混淆，可以在函数名后加上 Dsl 用以区分。该函数的参数是我们第一步创建的实现类的扩展函数，这是为了实现 DSL 语法。

3.使用

etString.addTextChangedListenerDsl {afterTextChanged {if (it.toString().length >= 4) {KeyboardUtils.toggleSoftInput()}}
}

使用这种方式时，可以说相当之优雅，我们只需要调用我们需要实现的接口方法即可，不需要使用的接口方法默认空实现。

高阶函数

高阶函数方式比 DSL 方式更简单一点：

inline fun TextView.addTextChangedListenerClosure(crossinline afterTextChanged: (Editable?) -> Unit = {},crossinline beforeTextChanged: (CharSequence?, Int, Int, Int) -> Unit = { charSequence, start, count, after -> },crossinline onTextChanged: (CharSequence?, Int, Int, Int) -> Unit = { charSequence, start, after, count -> }
) {val listener = object : TextWatcher {override fun afterTextChanged(s: Editable?) {afterTextChanged.invoke(s)}override fun beforeTextChanged(s: CharSequence?, start: Int, count: Int, after: Int) {beforeTextChanged.invoke(s, start, count, after)}override fun onTextChanged(s: CharSequence?, start: Int, before: Int, count: Int) {onTextChanged.invoke(s, start, before, count)}}this.addTextChangedListener(listener)
}

我们创建一个同名扩展函数，使用 Closure 尾缀作为区分，该函数的参数为与接口方法一一对应的 Kotlin 函数对象，并给其默认值赋值为 {} 即空实现，在函数体里通过 object 关键字构建匿名内部类实现对象，在其接口方法实现中调用与之一一对应的 Kotlin 函数对象。

使用方式上与普通的 Kotlin 高阶函数使用方式相同：

etString.addTextChangedListenerClosure(afterTextChanged = {if (it.toString().length >= 4) {KeyboardUtils.toggleSoftInput()}},
)

tips：

上面示例的扩展函数中，我们使用了 inline 与 crossinline 两个关键字，这是 Koltin 特有的。inline 关键字通常用于修饰高阶函数，用于提升性能。crossinline 声明的 lambda 不允许局部返回，用于避免调用者错误的使用 return 导致函数中断。

提供一个示例代码，亲自尝试一下也许可以更好的理解：

@Test
fun testInline() {testClosure {return}
}
private inline fun testClosure(test: (String) -> String ) {println("step 1")println(test("step test"))println("step 2")
}

在 Kotlin 中巧妙的使用 DSL 封装 SpannableStringBuilder

源从何来

在 Android 开发中 Spannable 实现富文本显示，也算是一个比较常见的使用场景，例如在登录页显示《隐私政策》、《服务协议》，通常这是一个有自定义颜色与点击事件的 Span，使用起来大致需要写如下代码：

private fun agreePrivate() {val tv = findViewById<TextView>(R.id.tv_agree)val builder = SpannableStringBuilder()val text = "我已详细阅读并同意《隐私政策》"builder.append(text)//设置span点击事件val clickableSpan = object :ClickableSpan(){override fun onClick(widget: View) {//do some thing}}builder.setSpan(clickableSpan, 9, 15, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE)//设置span无下划线val noUnderlineSpan = NoUnderlineSpan()builder.setSpan(noUnderlineSpan, 9, 15, Spanned.SPAN_MARK_MARK)//设置span文字颜色val foregroundColorSpan = ForegroundColorSpan(Color.parseColor("#0099FF"))builder.setSpan(foregroundColorSpan, 9, 15, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE)//设置可点击tv.movementMethod = LinkMovementMethod.getInstance()tv.setText(builder)
}class NoUnderlineSpan : UnderlineSpan() {override fun updateDrawState(ds: TextPaint) {ds.color = ds.linkColords.isUnderlineText = false}
}

用起来还是比较麻烦的，就像上面的代码只是一个 span 就写了三个 setSpan，如果需要使用 Span 的地方比较多，这些代码看起来实在是不够优雅。有没有更优雅方式呢，答案就是 DSL，上面的代码最终通过 DSL 封装后如下：

tvTestDsl.buildSpannableString {addText("我已详细阅读并同意")addText("《隐私政策》"){setColor("#0099FF")onClick(false) {//do some thing}}
}

他们的显示效果是完全一致的，无疑 DSL 的方式更加优雅，对于调用者而言也更加方便。

实现思路

当我有用 DSL 封装 Spannable 这个想法时，我首先写的是我应该如何去使用它，当时我在纸上胡乱的写下了上面的那段代码。

1. 它应该是 TextView的一个扩展函数。

2. 它的内部是 DSL 风格的代码。

3. 它的每段文字都有设置颜色 & 点击事件的函数。

所以就有了如下的两个接口与扩展函数：

interface DslSpannableStringBuilder {//增加一段文字fun addText(text: String, method: (DslSpanBuilder.() -> Unit)? = null)
}interface DslSpanBuilder {//设置文字颜色fun setColor(color: String)//设置点击事件fun onClick(useUnderLine: Boolean = true, onClick: (View) -> Unit)
}//为 TextView 创建扩展函数，其参数为接口的扩展函数
fun TextView.buildSpannableString(init: DslSpannableStringBuilder.() -> Unit) {//具体实现类val spanStringBuilderImpl = DslSpannableStringBuilderImpl()spanStringBuilderImpl.init()movementMethod = LinkMovementMethod.getInstance()//通过实现类返回SpannableStringBuildertext = spanStringBuilderImpl.build()
}

上一篇文章我们说了，在 DSL 风格的函数中，其参数应当是某个接口（或者他的实现类）的扩展函数，这样我们相当于通过接口来限定了在 DSL 中可调用的函数。上一篇中使用的是实现类，本文中使用的是接口，原因很简单，上文是扩展原有接口变成 DSL 风格，本文是直接从无至有，实现的 DSL 风格。

实现相应接口

其实对于像我这样初次接触DSL 的新手而言，思路是最难的，有了接口，有了 DSL 层级，剩下的就是相对简单的实现了。直接看代码：

class DslSpannableStringBuilderImpl : DslSpannableStringBuilder {private val builder = SpannableStringBuilder()//记录上次添加文字后最后的索引值var lastIndex: Int = 0var isClickable = falseoverride fun addText(text: String, method: (DslSpanBuilder.() -> Unit)?) {val start = lastIndexbuilder.append(text)lastIndex += text.lengthval spanBuilder = DslSpanBuilderImpl()method?.let { spanBuilder.it() }spanBuilder.apply {onClickSpan?.let {builder.setSpan(it, start, lastIndex, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE)isClickable = true}if (!useUnderLine) {val noUnderlineSpan = NoUnderlineSpan()builder.setSpan(noUnderlineSpan, start, lastIndex, Spanned.SPAN_MARK_MARK)}foregroundColorSpan?.let {builder.setSpan(it, start, lastIndex, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE)}}}fun build(): SpannableStringBuilder {return builder}
}class DslSpanBuilderImpl : DslSpanBuilder {var foregroundColorSpan: ForegroundColorSpan? = nullvar onClickSpan: ClickableSpan? = nullvar useUnderLine = trueoverride fun setColor(color: String) {foregroundColorSpan = ForegroundColorSpan(Color.parseColor(color))}override fun onClick(useUnderLine: Boolean, onClick: (View) -> Unit) {onClickSpan = object : ClickableSpan() {override fun onClick(widget: View) {onClick(widget)}}this.useUnderLine = useUnderLine}
}class NoUnderlineSpan : UnderlineSpan() {override fun updateDrawState(ds: TextPaint) {ds.color = ds.linkColords.isUnderlineText = false}
}