阅读完需:约 6 分钟
扩展函数
Kotlin与C#和Go类似,提供了扩展一个新功能的类,而不必继承类或使用任何类型的设计模式。
这是通过称为扩展名的特殊声明完成的。 Kotlin支持扩展功能和扩展属性。
您需要在String类中使用一种方法,该方法返回删除了第一个和最后一个字符的新字符串。此方法在String类中不存在。您可以使用扩展函数来完成此任务。
fun String.removeFirstLastChar(): String = this.substring(1, this.length - 1)
fun main(args: Array<String>) {
val myString= "Hello Everyone"
val result = myString.removeFirstLastChar()
println("输出结果: $result")
}
运行该程序时,输出为:
输出结果: ello Everyon
在这里,扩展函数removeFirstLastChar ()被添加到String类中。
类名是接收者类型(在我们的示例中为String类)。 扩展函数中的this关键字引用接收者对象。

扩展程序被静态解析
扩展不会实际修改它们扩展的类。 通过定义扩展名,不将新成员插入到类中,而只能使用这种类型的变量上的点符号来调用新的函数。
扩展功能是静态调度的,即它们不是接收器类型的虚拟机。 这意味着被调用的扩展函数由调用该函数的表达式的类型决定,而不是在运行时评估该表达式的结果的类型。 例如:
open class C
class D: C()
fun C.foo() = "c" // 扩展函数 foo
fun D.foo() = "d" // 扩展函数 foo
fun printFoo(c: C) {
println(c.foo()) // 类型是 C 类
}
fun main(arg:Array<String>){
printFoo(D())
}
编译运行以上 Kotlin 范例,输出结果如下
c
若扩展函数和成员函数一致,则使用该函数时,会优先使用成员函数。
class C {
fun foo() { println("成员函数") }
}
fun C.foo() { println("扩展函数") }
fun main(arg:Array<String>)
{
var c = C()
c.foo()
}
输出结果如下
成员函数
扩展一个空对象
在扩展函数内, 可以通过 this 来判断接收者是否为 null
这样,即使接收者为 null,也可以调用扩展函数
fun Any?.toString(): String
{
if (this == null) return "null"
// 空检测之后,“this”会自动转换为非空类型,所以下面的 toString()
// 解析为 Any 类的成员函数
return toString()
}
fun main(arg:Array<String>)
{
var t = null
println(t.toString())
}
编译运行以上 Kotlin 范例,输出结果如下
null
扩展属性除了函数,Kotlin 也支持属性对属性进行扩展
val <T> List<T>.lastIndex: Int
get() = size - 1
扩展属性允许定义在类或者包内,不允许定义在函数中
初始化属性因为属性没有后端字段(backing field),所以不允许被初始化,只能由显式提供的 getter/setter 定义。
val Foo.bar = 1 // 错误:扩展属性不能有初始化器
扩展属性只能被声明为 val
伴生对象的扩展
如果一个类定义有一个伴生对象 ,Kotlin 允许为伴生对象定义扩展函数和属性
伴生对象通过 类名.
形式调用伴生对象,伴生对象声明的扩展函数,通过用类名限定符来调用
class MyClass
{
companion object { } // 将被称为 "Companion"
}
fun MyClass.Companion.foo()
{
println("伴随对象的扩展函数")
}
val MyClass.Companion.no: Int
get() = 10
fun main(args: Array<String>)
{
println("no:${MyClass.no}")
MyClass.foo()
}
编译运行以上 Kotlin 范例,输出结果如下
no:10
伴随对象的扩展函数
扩展的作用域
通常扩展函数或属性定义在顶级包下
package foo.bar
fun Baz.goo() { …… }
要使用所定义包之外的一个扩展, 通过 import 导入扩展的函数名进行使用
package com.example.usage
import foo.bar.goo // 导入所有名为 goo 的扩展
// 或者
import foo.bar.* // 从 foo.bar 导入一切
fun usage(baz: Baz) {
baz.goo()
}
扩展声明为成员
Kotlin 允许在一个类内部为另一个类声明扩展方法
在这样的扩展中,有个多个隐含的接受者,其中扩展方法定义所在类的实例称为分发接受者
而扩展方法的目标类型的实例称为扩展接受者
class D
{
fun bar() { println("D bar") }
}
class C
{
fun baz() { println("C baz") }
fun D.foo() {
bar() // 调用 D.bar
baz() // 调用 C.baz
}
fun caller(d: D) {
d.foo() // 调用扩展函数
}
}
fun main(args: Array<String>)
{
val c: C = C()
val d: D = D()
c.caller(d)
}
编译运行以上 Kotlin 范例,输出结果如下
D bar
C baz
在 C 类内,创建了 D 类的扩展。此时,C 被成为分发接受者,而 D 为扩展接受者
从上例中可以看到,在扩展函数中,可以调用派发接收者的成员函数
假如在调用某一个函数,而该函数在分发接受者和扩展接受者均存在,则以扩展接收者优先,要引用分发接收者的成员你可以使用限定的 this 语法
class D
{
fun bar() { println("D bar") }
}
class C
{
fun bar() { println("C bar") } // 与 D 类 的 bar 同名
fun D.foo() {
bar() // 调用 D.bar(),扩展接收者优先
this@C.bar() // 调用 C.bar()
}
fun caller(d: D) {
d.foo() // 调用扩展函数
}
}
fun main(args: Array<String>) {
val c: C = C()
val d: D = D()
c.caller(d)
}
编译运行以上 Kotlin 范例,输出结果如下
D bar
C bar
以成员的形式定义的扩展函数, 可以声明为 open , 而且可以在子类中覆盖
也就是说, 在这类扩展函数的派发过程中, 针对分发接受者是虚拟的(virtual), 但针对扩展接受者仍然是静态的
open class D
{
}
class D1 : D()
{
}
open class C
{
open fun D.foo() {
println("D.foo in C")
}
open fun D1.foo() {
println("D1.foo in C")
}
fun caller(d: D) {
d.foo() // 调用扩展函数
}
}
class C1 : C()
{
override fun D.foo() {
println("D.foo in C1")
}
override fun D1.foo() {
println("D1.foo in C1")
}
}
fun main(args: Array<String>)
{
C().caller(D()) // 输出 "D.foo in C"
C1().caller(D()) // 输出 "D.foo in C1" —— 分发接收者虚拟解析
C().caller(D1()) // 输出 "D.foo in C" —— 扩展接收者静态解析
}
编译运行以上 Kotlin 范例,输出结果如下
D.foo in C
D.foo in C1
D.foo in C