【Kotlin】扩展函数 ① ( 扩展函数简介 | 为 Any 超类定义扩展函数 | private 私有扩展函数 | 泛型扩展函数 | 标准函数 let 函数是泛型扩展函数 )

韩曙亮

发布于 2023-03-30 18:55:24

1.9K00

代码可运行

文章被收录于专栏：韩曙亮的移动开发专栏韩曙亮的移动开发专栏

运行总次数：0

代码可运行

文章目录

一、扩展函数简介

为现有类定义扩展函数 , 可以在不修改原有类的情况下增加类的功能 ;

Kotlin 中如果类没有被 open 关键字修饰 , 则该类不能被继承 , 如果想要扩展该类 , 可以使用扩展函数 ;

扩展函数可以作用于自定义的类 , 也可以作用于系统自带的类 , 如 String , List , 等标准库 API 类 ;

为某个类定义扩展函数 , 格式为 :

fun 类名.扩展函数名(参数列表): 返回值类型 {
	函数体
}

定义扩展函数与定义普通函数唯一的区别是扩展函数前多了 类名. ;

下面的代码中 , 为 String 定义扩展函数 , 拼接原字符串和扩展函数参数 , 并将结果返回 ;

代码示例 :

/**
 * 为 String 定义扩展函数, 拼接原字符串和扩展函数参数, 并将结果返回
 */
fun String.addStr(str: String): String {
    println("this = $this, string = $str")
    return this + str
}

fun main() {
    println("123".addStr("abc"))
}

执行结果 :

this = 123, string = abc
123abc

二、为 Any 超类定义扩展函数

扩展函数的特点是为父类定义扩展函数 , 子类也可以调用该扩展函数 ;

为 Any 超类定义扩展函数 , 那么所有的 Any 子类都可以调用该扩展函数 ;

一旦在 Any 超类中定义了扩展函数 , 则在整个项目中 , 该扩展函数都有效 ;

这就导致了 Kotlin 的框架非常灵活 , 使用别人的 SDK 时会发现为各种现有类定义的扩展函数 ;

代码示例 : 在下面的代码中 , 为 Any 超类定义了 printSelf 扩展函数 , 所有的类如 : String , Int , Boolean 等类的实例对象 , 都可以调用该 printSelf 扩展函数 ;

fun Any.printSelf() {
    println(this)
}

fun main() {
    "abc".printSelf()
    88.printSelf()
    true.printSelf()
}

执行结果 :

abc
88
true

三、private 私有扩展函数

如果扩展函数使用 private 修饰 , 则该扩展函数只在该 Kotlin 代码文件中有效 , 在其它的 Kotlin 代码中就无法调用了 ;

代码示例 :

在 Hello.kt 代码中 , 使用 private 定义了 Any 超类的扩展函数 , 在本代码中的 main 函数中调用该扩展函数是有效的 ;

private fun Any.printSelf() {
    println(this)
}

fun main() {
    "abc".printSelf()
    88.printSelf()
    true.printSelf()
}

在另外一个 Kotlin 代码中 , 调用该 Any 扩展函数 , 就会报编译时报错信息 ;

Cannot access 'printSelf': it is private in file

四、泛型扩展函数

泛型扩展函数可以支持任何类型的接收者 ( 调用函数的实例对象 ) , 同时还可以获取接收者的泛型参数类型 ;

泛型扩展函数格式 : 一般泛型扩展函数都是为了配合链式编程 , 其返回值类型就是接收者泛型参数类型 ;

fun <T> T.函数名(参数列表): T {
	函数体
}

代码示例 : 在该代码中 , 定义了一个泛型扩展函数 , 为泛型 T 定义了扩展函数 printSelf , 在函数中打印接收者 , 并将接收者返回 , 该泛型可以是任意类型 ;

在 main 函数中 , 先调用字符串实力对象的 printSelf 泛型扩展函数打印自身 , 然后调用字符串的扩展函数 String.addStr 拼接字符串 , 最后再次调用字符串实力对象的 printSelf 泛型扩展函数打印自身 , 这样实现了一个链式编程 ;

// 泛型扩展函数 
fun <T> T.printSelf(): T{
    println(this)
    return this
}

// 字符串扩展函数
fun String.addStr(str: String): String {
    println("this = $this, string = $str")
    return this + str
}

fun main() {
	// 链式编程
    "abc".printSelf().addStr("123").printSelf()
}

执行结果 :

abc
this = abc, string = 123
abc123

五、标准函数 let 函数是泛型扩展函数

标准库中的 let 函数 , 就是泛型扩展函数 ,

inline 关键字表明该函数是内联函数 , 其中的匿名函数参数在编译时直接将函数体拷贝到使用位置 , 避免创建匿名函数相关对象 , 造成堆内存开销 ;
该函数中涉及到两个泛型 T 和 R , 在 fun 关键字后声明 ,
为泛型 T 定义了一个扩展函数 let ,
传入 (T) -> R 类型的匿名函数 , 该 Lambda 表达式返回 R 类型实例对象 ,
该扩展函数最终返回 R 类型实例对象 ,

/**
 * 调用以' this '值作为参数的指定函数[block]，并返回其结果。
 *
 * 有关详细使用信息，请参阅[scope functions]的文档
 * (https://kotlinlang.org/docs/reference/scope-functions.html#let)。
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> T.let(block: (T) -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block(this)
}