一、扩展方法的概述
Kotlin
可以对一个类的属性和方法进行扩展,且不需要继承或使用Decorator
(装饰者)模式。
扩展是一种静态行为,对被扩展的类代码本身不会造成任何影响。
例如,你可以为一个你不能修改的、来自第三方库中的类编写一个新的函数。 这个新增的函数就像那个原始类本来就有的函数一样,可以用普通的方法调用。 这种机制称为 扩展函数 。此外,也有 扩展属性 , 允许你为一个已经存在的类添加新的属性。
在Java
中没有扩展方法这个概念,Kotlin
的扩展方法类似于Java
中的工具类中的方法。
二、扩展函数
扩展函数可以在已有类中添加新的方法,不会对原类做修改。
-
扩展函数定义形式
fun receiverType.functionName(params) { // body }
receiverType
:表示函数的接收者functionName
:扩展函数的名称params
:扩展函数的参数,可以为NULL
-
扩展函数示例
class User(var name: String) // 扩展函数 fun User.printName(){ println("用户名 $name") } fun main(args: Array<String>) { var user = User("Robin") user.printName(); }
三、扩展函数是静态解析的
扩展函数是静态解析的,并不是接收者类型的虚拟成员,在调用扩展函数时,具体被调用的的是哪一个函数,由调用函数的的对象表达式来决定的,而不是动态的类型决定的,具体示例如下:
open class SimpleClass
class SubClass: SimpleClass
fun SimpleClass.foo() = "ABC"// 扩展函数 foo
fun SubCLass.f00() = "DEF"
func printFoo(c: SimpleClass) {
println(c.foo())
}
fun main(args: Array<String>) {
printlnFoo(SubClass())
}
输出结果为:
ABC
若扩展函数和成员函数一致,则使用该函数时,会优先使用成员函数。
class SimpleClass {
fun foo() {
println("成员函数")
}
}
fun SimpleClass.foo() {
println("扩展函数")
}
fun main(args: Array<String>) {
var c = SimpleClass()
c.foo()
}
实际输出结果为:
成员函数
四、扩展一个空对象
在扩展函数内,可以通过this
来判断接收者是否为NULL
,即使接收者为NULL
,也可以调用扩展函数,如:
fun Any?.toString(): String {
if (this == null) return "null"
// 空检测之后,"this"会自动转换为非空类型,所以下面的toString()解析为Any类的成员函数
return toString()
}
fun main(args: Array<String>) {
var t = null
println(t.toString())
}
实际输出结果为:
null
五、扩展属性
除了函数,Kotlin
也支持对属性进行扩展:
val <T> List<T>.lastIndex: Int
get() = size - 1
扩展属性允许定义在类或者Kotlin
文件中,不允许定义在函数中。初始化属性因为属性没有后端字段(back field),所以不允许被初始化,只能由显式的getter/setter
定义。
val Foo.bar = 1 // 错误:扩展属性不能有初始化器
六、伴生对象的扩展
如果一个类定义有一个伴生对象,你也可以为伴生对象定义扩展函数和属性。
伴生对象通过“类名.”形式调用伴生对象,伴生对象声明的扩展函数,通过用类名限定符来调用:
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()
}
实力执行后输出结果为:
no:10
伴生对象的扩展函数
伴生对象内的成员相当于 Java 中的静态成员,其生命周期伴随类始终,在伴生对象内部可以定义变量和函数,这些变量和函数可以直接用类名引用。
对于伴生对象扩展函数,有两种形式,一种是在类内扩展,一种是在类外扩展,这两种形式扩展后的函数互不影响(甚至名称都可以相同),即使名称相同,它们也完全是两个不同的函数,并且有以下特点:
- 类内扩展的伴随对象函数和类外扩展的伴随对象可以同名,它们是两个独立的函数,互不影响;
- 当类内扩展的伴随对象函数和类外扩展的伴随对象同名时,类内的其它函数优先引用类内扩展的伴随对象函数,即对于类内其它成员函数来说,类内扩展屏蔽类外扩展;
- 类内扩展的伴随对象函数只能被类内的函数引用,不能被类外的函数和伴随对象内的函数引用;
- 类外扩展的伴随对象函数可以被伴随对象内的函数引用
例如以下代码:
class MyClass {
companion object {
val myClassField1: Int = 1
var myClassField2 = "this is myClassField2"
fun companionFun1() {
println("this is 1st companion function.")
foo()
}
fun companionFun2() {
println("this is 2st companion function.")
companionFun1()
}
}
fun MyClass.Companion.foo() {
println("伴随对象的扩展函数(内部)")
}
fun test2() {
MyClass.foo()
}
init {
test2()
}
}
val MyClass.Companion.no: Int
get() = 10
fun MyClass.Companion.foo() {
println("foo 伴随对象外部扩展函数")
}
fun main(args: Array<String>) {
println("no:${MyClass.no}")
println("field1:${MyClass.myClassField1}")
println("field2:${MyClass.myClassField2}")
MyClass.foo()
MyClass.companionFun2()
}
运行结果:
no:10
field1:1
field2:this is myClassField2
foo 伴随对象外部扩展函数
this is 2st companion function.
this is 1st companion function.
foo 伴随对象外部扩展函数
七、扩展的作用域
通常扩展函数或属性定义在顶级包下:
package foo.bar
fun Baz.goo() {...}
要使用所定义包之外的一个扩展,通过import到入扩展函数名进行使用:
package com.example.usage
import foo.bar.goo // 导入所有名为goo的扩展
// 或者从foo.bar导入一切
import foo.bar.*
fun usage(baz: Baz) {
baz.goo()
}
八、扩展声明为成员
在一个类内部你可以为另一个类声明扩展。
在这个扩展中,有多个隐含的接收者,其中扩展方法定义所在类的实例成为分发接收者,而扩展方法的目标类型的实例成为扩展接收者。
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)
}
实力输出结果为:
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)
}
实力输出结果为:
D bar
C bar
以成员的形式定义的扩展函数,可以声明为open
,而且可以在子类中覆盖,也就是说,在这类扩展函数的派发过程中,针对分发接收者是虚拟的(Virtual),但针对扩展接收者仍然是静态的。
open class D {
}
open 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”--扩展接收者静态解析
}
实力执行输出结果为:
D.foo in C
D.foo in C1
D.foo in C