Kotlin 可以对一个类的属性和方法进行扩展,且不需要继承或使用 Decorator 模式。
扩展是一种静态行为,对被扩展的类代码本身不会造成任何影响。
扩展函数
扩展函数可以在已有类中添加新的方法,不会对原类做修改,扩展函数定义形式:
fun receiverType.functionName(params){
body
}
- receiverType表示函数的接收者,也就是扩展对象。
- functionName表示扩展函数名。
- params表示扩展函数的参数,可以为null
fun main(args: Array<String>) {
val qfxl = User("qfxl")
qfxl.saySth("Hello World")
}
fun User.saySth(words: String) {
println("$name say $words")
}
class User(var name:String)
打印结果:qfxl say Hello World
下面为MutableList扩展一个swap函数:
fun main(args: Array<String>) {
val mutableList = mutableListOf(1,2,3)
//位置1,2的值互换
mutableList.swap(1,2)
println(mutableList.toString())
}
fun MutableList<Int>.swap(index1: Int, index2: Int) {
val temp = this[index1] //this 对应该列表
this[index1] = this[index2]
this[index2] = temp
}
执行结果 1,3,2
this关键字指代接收者对象(receiver object)(也就是调用扩展函数时, 在点号之前指定的对象实例)。
扩展函数是静态解析的
扩展函数是静态解析的,并不是接收者类型的虚拟成员,在调用扩展函数时,具体被调用的的是哪一个函数,由调用函数的的对象表达式来决定的,而不是动态的类型决定的:
fun main(args: Array<String>) {
printFoo(D())
}
open class C
class D : C()
fun C.foo() = "c"
fun D.foo() = "d"
fun printFoo(c: C) {
println(c.foo()) // 类型是 C 类
}
输出结果: c
若扩展函数和成员函数一致,则使用该函数时,会优先使用成员函数。
fun main(args: Array<String>) {
User().doSth()
}
class User() {
fun doSth(): Unit {
println("成员函数")
}
}
fun User.doSth(): Unit {
println("扩展函数")
}
打印 成员函数
扩展一个空对象
在扩展函数内, 可以通过 this 来判断接收者是否为 NULL,这样,即使接收者为 NULL,也可以调用扩展函数。例如:
fun main(args: Array<String>) {
val t = null
println(t.toString())
}
fun Any?.toString(): String {
if (this == null) return "null"
return toString()
}
打印 null
扩展属性
除了能扩展函数,Kotlin还能对属性扩展。
val <T>List<T>.lastIndexOf: Int
get() = size - 1
**扩展属性允许定义在类或者kotlin文件中,不允许定义在函数中。初始化属性因为属性没有后端字段(backing field),所以不允许被初始化,只能由显式提供的 getter/setter 定义。
扩展属性只能被声明为 val。**
伴生对象的扩展
如果一个类定义有一个伴生对象 ,你也可以为伴生对象定义扩展函数和属性。
伴生对象通过”类名.”形式调用伴生对象,伴生对象声明的扩展函数,通过用类名限定符来调用:
class MyClass {
companion object {}
}
fun MyClass.Companion.foo() {
println("伴随对象的扩展函数")
}
val MyClass.Companion.no: Int
get() = 10
fun main(args: Array<String>) {
println("no=${MyClass.no}")
MyClass.foo()
}
输出结果为:
no=10
伴随对象的扩展函数
扩展的作用域:
通常扩展函数或属性定义在顶级包下:
package foo.bar
fun Baz.goo() { …… }
要使用所定义包之外的一个扩展, 通过import导入扩展的函数名进行使用:
class Sample
package com.qfxl.kotlin
fun main(args: Array<String>) {
}
//在顶级包下扩展一个函数
fun Sample.sayHello() {
println("Hello World")
}
//在其他类里面调用扩展的方法需要import扩展的方法
import com.qfxl.kotlin.sayHello
class Sample1 {
fun useage(sample: Sample) {
sample.sayHello()
}
}
扩展声明为成员
在一个类内部你可以为另一个类声明扩展。
在这个扩展中,有个多个隐含的接受者,其中扩展方法定义所在类的实例称为分发接受者,而扩展方法的目标类型的实例称为扩展接受者。
fun main(args: Array<String>) {
val mA = A()
val mB = B()
mB.caller(mA)
}
class A {
fun a() {
println("A a")
}
}
class B {
fun b() {
println("B b")
}
fun A.ex() {
a()
b()
}
fun caller(a: A) {
a.ex()
}
}
输出结果为:
A a
B b
在 B 类内,创建了 A 类的扩展。此时,B 被成为分发接受者,而 A 为扩展接受者。从上例中,可以清楚的看到,在扩展函数中,可以调用派发接收者的成员函数。
假如在调用某一个函数,而该函数在分发接受者和扩展接受者均存在,则以扩展接收者优先,要引用分发接收者的成员你可以使用限定的 this 语法。
fun main(args: Array<String>) {
val mA = A()
val mB = B()
mB.caller(mA)
}
class A {
fun a() {
println("A a")
}
}
class B {
fun a() {
println("B a")
}
fun A.ex() {
a() //调用A的a()扩展接收者优先
this@B.a() //调用b的a()
}
fun caller(a: A) {
a.ex()
}
}
输出结果
A a
B b
以成员的形式定义的扩展函数, 可以声明为 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" —— 扩展接收者静态解析
}