Kotlin 扩展

Kotlin 提供了向一个类扩展新功能的能力, 而且不必从这个类继承, 也不必使用任何设计模式, 比如 Decorator 模式之类. 这种功能是通过一种特殊的声明来实现的, Kotlin 中称为扩展(extension). Kotlin 支持扩展函数(extension function) 和扩展属性(extension property)。

扩展函数

要声明一个扩展函数, 我们需要在函数名之前添加前缀, 表示这个函数的接收者类型(receiver type), 表明我们希望扩展的对象类型, 如下，List增加丢弃前k个项目的函数。

package com.test.example

fun <E> List<E>.drop(k: Int): List<E> {
    val resultSize = size - k
    when {
        resultSize <= 0 -> return emptyList<E>()
        else -> {
            val list = ArrayList<E>(resultSize)
            for (index in k..size - 1) {
                list.add(this[index])
            }
            return list
        }
    }
}

使用的时候，和顶层函数一样，需要 import

import com.test.example.drop

val list = listOf(1,2,3)
val droppedList = list.drop2(2)

定义扩展函数时, 其实并没有向类中插入新的成员方法, 而只是创建了一个新的函数, 并且可以通过点号标记法的形式, 对这个数据类型的变量调用这个新函数。

扩展函数的调用派发过程是静态的，调用扩展函数时, 具体被调用的函数是哪一个, 是通过调用函数的对象表达式的类型来决定的, 而不是在运行时刻表达式动态计算的最终结果类型决定的。

如果类中存在成员函数, 同时又在同一个类上定义了同名的扩展函数, 并且与调用时指定的参数匹配, 这种情况下总是会优先使用成员函数。

扩展函数通常定义成顶层函数，但是也可以定义在类内部，以限制其作用域。

class Mappings {
    private val map = hashMapOf<Int, String>()
    private fun String.stringAdd(): Unit {
        map.put(hashCode(), this)
    }
    fun add(str: String): Unit = str.stringAdd()
}

这种方式的扩展函数，可以定义成 open, 被子类覆盖。

open class Element(val name: String) {
    open fun Particle.react(name: String): Unit {
        println("$name is reacting with a particle")
    }
}

class NobleGas(name: String) : Element(name) {
    override fun Particle.react(name: String): Unit {
        println("$name is noble, it doesn't react with particles")
    }
}

可为空的接收者(Nullable Receiver)

对可以为空的接收者类型也可以定义扩展。这样的扩展函数, 即使在对象变量值为 null 时也可以调用,在扩展函数的实现体之内, 可以通过 this == null 来检查接收者是否为 null。

fun Any?.safeEquals(other: Any?): Boolean {
    if (this == null && other == null) return true
    if (this == null) return false
    return this.equals(other)
}

扩展属性

与扩展函数类似, Kotlin 也支持扩展属性。

val <T> List<T>.lastIndex: Int
    get() = size - 1

由于扩展属性实际上不会向类添加新的成员, 因此无法让一个扩展属性拥有一个后端域变量。所以, 对于扩展属性不允许存在初始化器. 扩展属性的行为只能通过明确给定的取值方法与设值方法来定义。
val Foo.bar = 1 // 错误: 扩展属性不允许存在初始化器

同伴对象扩展

fun Int.Companion.random(): Int {
    val random = Random()
    return random.nextInt()
}

val int = Int.random()

参考
《Programming Kotlin》Stephen Samuel ，Stefan Bocutiu
《Kotlin in Action》Dmitry Jemerov，Svetlana Isakova

Kotlin 扩展

推荐阅读更多精彩内容