Kotlin基本语法之(八) 扩展函数

721 阅读1分钟

Kotlin语言一大特性就是支持函数扩展,你可以通过一个简单的String对象发现,它比Java中的String对象强大太多,而这是怎么做到的呢?来看今天要讲的扩展函数。

扩展函数

先来个栗子,看看Kotlin中的String类有多强大。

val str = "adafjaidjadgadkjgaf"
str.filter { it != ' ' }
    .replace('b', 'd')
    .groupBy {
        if (it > 'h') 1 else 2
    }
    .forEach { key, value ->
        println("key:$key value:$value")
    }

函数式调用结合了String类的过滤(filter)、替换(replace)和分组(group),然而这些工具方法并不在String类中,实际上是在StringsKt类中,以filter为例:

# StringsKt.kt
public inline fun String.filter(predicate: (Char) -> Boolean): String {
    return filterTo(StringBuilder(), predicate).toString()
}

通过上面的代码,我们开始学习扩展函数的写法。 与函数的声明几乎一样,唯一不同的是需要在方法名前加类名表示是为哪个类做的扩展。 下面的例子展示了为String的一个扩展--所有字符串都会sayHello。

fun String.sayHello(): String {
    return "hello $this"
}

//test
println("lili".sayHello())
//输出
hello lili

在扩展函数体内通过this关键字获取函数的调用者,如果调用方与扩展函数不在一个包中,需要import包名+扩展函数名。

反编译代码可以看到扩展方法的java实现是,生成一个类,类名为文件名+Kt,在这个类中生成一个静态方法。当调用者使用扩展方法时编译器会将此调用转为静态调用。

//反编译结果
public final class TestExtensionKt {
   @NotNull
   public static final String sayHello(@NotNull String $receiver) {
      Intrinsics.checkParameterIsNotNull($receiver, "receiver$0");
      return "hello " + $receiver;
   }
}

//调用
TestExtensionKt.sayHello("lili");

扩展属性

Kotlin中属性也支持扩展,来看下面的例子,为List对象扩展一个lastIndex属性。

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

这样就可以通过属性直接访问List的最后角标。

//test
val lastIndex = arrayListOf(1,5,9).lastIndex
println("lastIndex:$lastIndex")
//输出
2

由于扩展函数的实现是基于生成静态工具方法,原本getter/setter依赖的back field(通常翻译为幕后字段)就不存在了,所以在getter/setter中不能访问field关键字,只能操作this,同时扩展属性不能指定初始化参数,其值只能由显式提供的getters/setters定义。

val Foo.bar = 1 //error

扩展伴生对象

伴生对象也支持扩展

class TestExtension {
    //默认名为 "Companion"
    companion object {

    }
}
//扩展伴生对象
fun TestExtension.Companion.foo() {

}

使用就跟调用一个静态方法一样。

TestExtension.foo()