Kotlin中的扩展函数与属性示例详解

前言

Kotlin 中类的扩展方法并不是在原类的内部进行拓展，通过反编译为Java代码，可以发现，其原理是使用装饰模式，对源类实例的操作和包装，其实际相当于我们在 Java中定义的工具类方法，并且该工具类方法是使用调用者为第一个参数的，然后在工具方法中操作该调用者；

理论上来说，扩展函数很简单，它就是一个类的成员函数，不过定义在类的外面。让我们来添加一个方法，来计算一个字符串的最后一个字符:

package strings
/**
 * @author :Reginer in 2018/5/22 21:04.
 * 联系方式:QQ:282921012
 * 功能描述:
 */
fun String.lastChar(): Char = get(this.length - 1)

要做的，就是把要扩展的类或者接口的名称，放到即将添加的函数前面。这个类的名称被称为接收者类型；用来调用这个扩展函数的对象，叫做接收者对象。

接收者类型是由扩展函数定义的，接收对象是该类型的一个实例

可以像调用类的成员函数一样去调用这个函数:

println("Kotlin".lastChar())
>n

从某种意义上说，现在已经为String类添加了自己的方法。不管String类是用Java、Kotlin，或者像Groovy的其他JVM语言编写的，只要它会编译为Java类，就可以为这个类添加自己的扩展。

在这个扩展函数中，可以像其他成员函数一样用this。也可以像普通的成员函数一样，省略它:

fun String.lastChar(): Char = get(this.length - 1)

注意，扩展函数并不允许打破它的封装性。和在类内部定义的方法不同的是，扩展函数不能访问私有的或者是受保护的成员。

3.3.1导入和扩展函数

对于定义的一个扩展函数，它不会自动地在整个项目范围内生效。相反，如果要使用它，需要进行导入，就像其他任何的类或者函数一样。这是为了避免偶然性的命名冲突。Kotlin允许用和导入类一样的语法来导入单个的函数:

import strings.lastChar
//星号导入
import strings.*

3.3.2在Java中调用扩展函数

其实，扩展函数是静态函数，它把调用对象作为了它的第一个参数。调用扩展函数，不会创建适配的对象或者任何运行时的额外消耗。

这使得从Java中调用Kotlin的扩展函数变得非常简单:调用这个静态函数，然后把接收对象作为第一个参数传进去即可。假设它声明在一个叫做StringUtil.kt的文件中:

char c = StringUtil.lastChar("Java");

和Kotlin版本比较起来，可读性略差。

3.3.3作为扩展函数的工具函数

现在，可以写一个joinToString函数的终极版本了:

fun <T> Collection<T>.joinToString(separator: String = ", ", prefix: String = "", postfix: String = ""): String {
 val result = StringBuilder(prefix)
 for ((index, element) in this.withIndex()) {
 if (index > 0) result.append(separator)
 result.append(element)
 }
 result.append(postfix)
 return result.toString()
}

因为扩展函数无非就是静态函数的一个高效语法糖，可以使用更具体的类型来作为接收者类型，而不是一个类。假设想要一个join函数，只能由字符串的集合来触发:

fun Collection<String>.join(separator: String = ", ", prefix: String = "", postfix: String = ""): String {
 val result = StringBuilder(prefix)
 for ((index, element) in this.withIndex()) {
 if (index > 0) result.append(separator)
 result.append(element)
 }
 result.append(postfix)
 return result.toString()
}

如果是用其他类型的对象列表来调用会报错。

3.3.4不可重写的扩展函数

扩展函数并不是类的一部分，它是声明在类之外的。扩展函数并不存在重写，因为Kotlin会把它们当做静态函数对待。

3.3.5扩展属性

val String.lastChar: Char get() = get(this.length - 1)

和扩展函数一样，扩展属性也像接收者的一个普通成员属性一样。

这里必须定义getter函数，因为没有支持字段，因此没有默认的getter的实现。同理，初始化也不可以，因为没有地方存储初始值。

如果在StringBuilder上定义一个相同的属性，可以置为var，因为StringBuilder的内容是可变的：

var StringBuilder.lastChar: Char
 get() = get(length - 1)
 set(value) {
 this.setCharAt(length - 1, value)
 }

可以像访问成员属性一样访问它:

println("Kotlin".lastChar)
> n
val sb = StringBuilder("Kotlin?")
sb.lastChar = '!'
println(sb)
> Kotlin!

注意，当需要从Java中访问扩展属性的时候，应该显式地调用它的getter函数：StringUtil.getLastChar("Java");

总结