Kotlin学习_扩展（Extensions）和This表达式

Kotlin1.1

扩展是Kotlin中特别强大的一个功能，如扩展函数，本文是学习Kotlin中的扩展(Extensions)和This表达式的相关知识。

扩展(Extensions)

在Java开发时，会经常将那些共用的方法写到一个Utils类，如FileUtils,StringUtils等等。很有名的java.util.Collections也是其中一员的，在使用的时候

1	Collections.swap(list, Collections.binarySearch(list, Collections.max(otherList)), Collections.max(list))

Kotlin中提供了一种可以在不继承父类，也不使用类似Decorator这样的设计模式的情况下对指定类进行扩展，在Kotlin中称为扩展的特殊声明，支持函数扩展和属性扩展。
如上面的可以写成

1	list.swap(list.binarySearch(otherList.max()), list.max())

比如要将Toast写成可以直接调用toast(this, "toast")

1
2
3

fun Context.toast(context: Context, content: String) {
    Toast.makeText(context, content, Toast.LENGTH_SHORT).show()
}

扩展函数(Extension Functions)

要声明一个扩展函数，我们需要在函数的名称前加上一个接收者类型并且加上.符号

/**
* MutableList<Int> 添加一个 swap() 扩展函数
*/
fun MutableList<Int>.swap(index1: Int, index2: Int) {
    val tmp = this[index1] // this对应list
    this[index1] = this[index2]
    this[index2] = tmp
}

在扩展函数中的this关键字表示接收者对象，下面会讲到this表达式，在这里的this对应MutableList<Int>类型的对象。

1 2	val l = mutableListOf(1, 2, 3) l.swap(0, 2) // 在 `swap()` 函数中 `this` 持有的值是 `l`

如果要改成对任意类型MutableList<T>都适用

fun <T> MutableList<T>.swap(index1: Int, index2: Int) {
    val tmp = this[index1] 
    this[index1] = this[index2]
    this[index2] = tmp
}

像在集合Collections里面就可以找到很多的扩展函数：

extension

扩展是静态解析(Extensions are resolved statically)

由于Kotlin的扩展是静态解析的，所以在定义了一个扩展函数之后，并不会给这个类添加方法，而是让这个方法能够被这个类的实例对象通过.来调用。举例

open class C

class D: C()

fun C.foo() = "c"

fun D.foo() = "d"

fun printFoo(c: C) {
    println(c.foo())
}

在调用printFoo(D())的话会打印c还是d，答案是打印c，因为在定义扩展函数的时候接收对象类型是C类，而且Kotlin的扩展是静态解析的，所以即使调用的时候是传了C类的子类D类进去，还是会执行定义的时候的类型的函数。

那如果类中有个函数foo()，然后在写个扩展函数C.foo()，这时候如果调用的话，是调用哪个函数呢？

class C {
    fun foo() { println("member") }

}
fun C.foo() { println("extension") }

答案是调用类的成员函数，如果有同名同参数的成员函数和扩展函数，调用的时候必然会使用成员函数，所以这里会打印member

扩展函数完全可以重载具有相同名称但不同参数的成员函数

class C {
    fun foo() { println("number") }
}

fun C.foo(i:Int) { println("extention") }

总结一下，如果扩展函数和成员函数同名同参数，则成员函数优先级高于扩展函数。

可空接收者(Nullable Receiver)

Kotlin的扩展支持接收者对象为空，举个例子，在调用字符串的toString()函数的时候，如果字符串为null的话会报空指针异常，这里可以改成扩展函数，里面将传进来的字符串进行this == null判断，就可以在 Kotlin 中任意调用toString()函数而不进行空指针检查。

fun Any?.toString(): String {
    if (this == null) return "null"
    // 在空检查之后，`this` 被自动转为非空类型，因此 toString() 可以被解析到任何类的成员函数中
    return toString()
}

属性扩展(Extension Properties)

与函数类似，Kotlin支持扩展属性

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

前面说过，Kotlin是静态解析扩展的，所以扩展属性不会有备用字段，这也是为什么初始化函数不允许有扩展属性，扩展属性只能够通过明确提供getter和setter函数来进行定义。

1	val Foo.bar = 1 // 错误: 初始化函数不允许有扩展属性

伴生对象扩展(Companion Object Extensions)

如果一个类有伴生对象，同样可以为伴随对象定义扩展函数和属性

class MyClass {
    companion object { } 
}

fun MyClass.Companion.foo() {
    // ...
}

调用的时候

1	MyClass.foo()

扩展的范围

在前面说过Top-level是与类同级的，大多数情况下，扩展也可以在Top-level层级定义。

1 2	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()
}

This表达式(This Expression)

上面说了，在扩展函数中的this关键字对应接收者对象，this表示当前接收者，用到了this表达式。

在类的成员中，this表示当前类的对象
在扩展函数或带接收者的文本函数中，this在.的左边，表示接收者参数

This表达式的限制(Qualified this)

为了在范围外部(类、扩展函数、带接收者的文本函数访问this，需要使用到@label，在前面也说过return到标签(@label)，这里用this@label表示

class A { // 默认有@A标签
    // this表示A
    val aThis = this 
    inner class B { // 默认有@B标签
        // this表示B
        val bThis = this 
        fun Int.foo() { // 默认有@foo标签
            // 表示A
            val a = this@A 
            // 表示B
            val b = this@B 

            // this表示带接收者为Int的文本函数foo()
            val c = this 
            // 表示带接收者为Int的文本函数foo()
            val c1 = this@foo 
        }
    }
}

将下面的代码运行，会打印出什么呢？

运行的结果为：