文章目录

  • 背景
  • 扩展函数
  • 实例
  • 扩展函数是静态解析的
  • 实例
  • 扩展一个空对象
  • 扩展属性
  • 伴生对象的扩展
  • 扩展的作用域
  • 扩展声明为成员


背景

  • 学习 记录分享 坚持开源!

Kotlin 可以对一个类的属性和方法进行扩展,且不需要继承或使用 Decorator 模式。

扩展是一种静态行为,对被扩展的类代码本身不会造成任何影响。


扩展函数

扩展函数可以在已有类中添加新的方法,不会对原类做修改,扩展函数定义形式:

fun receiverType.functionName(params){
    body
}
  • receiverType:表示扩展函数的接收者,也就是函数扩展的对象
  • functionName:扩展函数的名称
  • params:扩展函数的参数,可以为 NULL

实例

以下实例扩展 User 类:

class User(var name: String) {
}

/**
 * 扩展函数 call
 * 对 User 类进行方法扩展
 */
fun User.call(){
    println("> username is: ${name}")
}

调用:

private fun UserTest() {
        println("> --- UserTest ---")
        var user = User("imxiaoqi")
        user.call()
    }

输出结果:

Java中怎么使用kotlin的扩展函数 kotlin 类的扩展_kotlin


扩展函数是静态解析的

扩展函数是静态解析的,并不是接收者类型的虚拟成员。

在调用扩展函数时,具体被调用的的是哪一个函数,由调用函数的的对象表达式来决定的,而不是动态的类型决定的。

实例

open class Car {

}

class Bmw: Car() {

}

fun Car.speed() = "100km/h" // Car 类的扩展函数

fun Bmw.speed() = "80km/h" // Bmw 类的扩展函数

调用:

private fun carTest() {
        println("> --- carTest ---")
        showSpeed(Bmw())
    }

    fun showSpeed(car: Car){
        println("> ${car.speed()}") // Car 类对象调用的扩展函数
    }

输出结果:

Java中怎么使用kotlin的扩展函数 kotlin 类的扩展_扩展_02

  • 若扩展函数和成员函数一致,则使用该函数时,会优先使用成员函数。
class User(var name: String) {
    fun call(){
        println("> 成员函数")
    }
}

/**
 * 扩展函数 call
 * 对 User 类进行方法扩展
 */
fun User.call(){
    println("> username is: ${name}")
}

调用:

private fun UserTest() {
        println("> --- UserTest ---")
        var user = User("imxiaoqi")
        user.call()
    }

输出结果:

Java中怎么使用kotlin的扩展函数 kotlin 类的扩展_基础学习_03


扩展一个空对象

在扩展函数内, 可以通过 this 来判断接收者是否为 NULL,这样,即使接收者为 NULL,也可以调用扩展函数。例如:

fun Any?.toString(): String{
        if (this == null) return "custom null";
        // 解析为 Any 类的成员函数
        return toString();
    }

调用:

private fun emptyObjTest() {
        println("> --- emptyObjTest ---")
        var obj = null
        println("> obj is ${obj.toString()}")
    }

输出结果:

Java中怎么使用kotlin的扩展函数 kotlin 类的扩展_android_04


扩展属性

除了函数,Kotlin 也支持对属性进行扩展:

val <T>  List<T>.index: Int
    get() {
        return size - 1;
    }

扩展属性允许定义在类或者 kotlin 文件中,不允许定义在函数中。

初始化属性因为属性没有后端字段(backing field),所以不允许被初始化,只能由显式提供的 getter/setter 定义。

扩展属性只能被声明为 val


伴生对象的扩展

如果一个类定义有一个伴生对象 ,你也可以为伴生对象定义扩展函数和属性。

伴生对象通过"类名."形式调用伴生对象,伴生对象声明的扩展函数,通过用类名限定符来调用:

class Associate {
    // 将被称为 "Companion"
    companion object{}
}

fun Associate.Companion.call(){
    println("> 伴生对象的扩展函数")
}

val Associate.Companion.name: String
    get() {
        return "伴生对象扩展属性:imxiaoqi"
    }

调用:

private fun associateTest() {
        println("> --- associateTest ---")
        println("> ${Associate.name}")
        Associate.call()
    }

输出结果:

Java中怎么使用kotlin的扩展函数 kotlin 类的扩展_android_05


扩展的作用域

通常扩展函数或属性定义在顶级包下:

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

扩展声明为成员

在一个类内部你可以为另一个类声明扩展。

在这个扩展中,有个多个隐含的接受者,其中扩展方法定义所在类的实例称为 分发接受者,而扩展方法的目标类型的实例称为 扩展接受者

class FenF {

    fun call(){
        println("> FenF call")
    }

    fun KuoZ.sing(){
        action() //  调用 KuoZ 成员函数
        call() // 调用 FenF 成员函数
    }

    fun doCall(k: KuoZ){
        k.sing() // 调用KuoZ的扩展函数sing()
    }
}

class KuoZ{
    fun action(){
        println("> KuoZ action")
    }
}

调用:

private fun fenFTest() {
        println("> --- fenFTest ---")
        val f = FenF()
        val k = KuoZ()
        f.doCall(k)
    }

输出结果:

Java中怎么使用kotlin的扩展函数 kotlin 类的扩展_扩展_06

FenF 类内,创建了 KuoZ 类的扩展。
此时,FenF 被成为分发接受者,而 KuoZ 为扩展接受者。
从上例中,可以清楚的看到,在扩展函数中,可以调用分发接收者的成员函数。

假如在调用某一个函数,而该函数在分发接受者和扩展接受者均存在,则以扩展接收者优先。

class FenF {

    fun call(){
        println("> FenF call")
    }

    fun KuoZ.sing(){
        call() //  调用 KuoZ 成员函数 扩展接受者优先
        this@FenF.call() // 调用 FenF 成员函数
    }

    fun doCall(k: KuoZ){
        k.sing() // 调用KuoZ的扩展函数sing()
    }
}

class KuoZ{
    fun call(){
        println("> KuoZ call")
    }
}

调用:

private fun fenFTest() {
        println("> --- fenFTest ---")
        val f = FenF()
        val k = KuoZ()
        f.doCall(k)
    }

输出结果:

Java中怎么使用kotlin的扩展函数 kotlin 类的扩展_kotlin_07

要引用分发接收者的成员你可以使用限定的 this 语法。

以成员的形式定义的扩展函数, 可以声明为 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")
    }
}

调用:

private fun nomoTest() {
        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

技术永不眠!我们下期见!