Kotlin扩展函数 ③ ( 定义扩展文件 | 重命名扩展函数 | Kotlin 标准库扩展函数 )

Posted 2023-01-26 韩曙亮

文章目录

• 一、定义扩展文件
• 二、重命名扩展函数
• 三、Kotlin 标准库扩展函数

一、定义扩展文件

---

如果定义的 扩展函数 需要在 多个 Kotlin 代码文件 中使用 , 则需要在 单独的 Kotlin 文件 中定义 , 该文件被称为 扩展文件 ;

定义 标准库函数 的 Standard.kt 就是 独立的 扩展文件 ;

代码示例 : 扩展文件一般都 单独定义在一个 Package 中 , 命名一般是 XxxExt.kt , 在该代码中扩展文件定义在了 kim.hsl.extension 包中 , 扩展文件名称是 IterableExt.kt ;

package kim.hsl.extension

/**
 * 定义 Iterable<T> 扩展函数
 * 将集合随机打乱顺序, 返回第一个元素, 也就是获取集合中的随机元素
 * 函数必须是 public 函数, 不能是 private 函数
 */
fun <T> Iterable<T>.randomElement(): T = this.shuffled().first()

执行结果 :

Tom
Jerry

二、重命名扩展函数

---

如果 对 要调用的 扩展函数 名字不满意 , 则可以 使用 as 关键字 重命名扩展函数 ;

注意 : 一旦使用了 重命名扩展函数 , 则原扩展函数不能使用 , 一旦使用 , 直接报 Unresolved reference: randomElement 错误 ;

代码示例 :

import kim.hsl.extension.randomElement as getRandomElement

fun main() 
    val list = listOf("abc", "123", "Tom", "Jerry")
    println(list.getRandomElement())

    val set = setOf("abc", "123", "Tom", "Jerry")
    println(set.getRandomElement())

执行结果 :

Jerry
Jerry

三、Kotlin 标准库扩展函数

---

Kotlin 标准库 提供的功能 , 都是通过 扩展函数 实现的 , 为 现有类 扩展的 标准库文件 都是 在 类名的基础上加上 s 来命名的 , 如 :

• 为 Sequence 类提供的扩展函数 , 定义在 Sequences.kt 代码中 ;
• 为 Range 类提供的扩展函数 , 定义在 Ranges.kt 代码中 ;
• 为 Map 类提供的扩展函数 , 定义在 Maps.kt 代码中 ;

标准库 中的 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)

在使用 Lambda 表达式作为参数的时候 , Kotlin 编译器直接将 inline 内联函数 的 函数体 直接拷贝到 使用位置 ; 内联函数 类似于 C 语言中的 预编译指令 宏定义 , 在编译时直接替换拷贝宏定义内容 ; Kotlin 中的 内联函数 也是一种 编译时 进行 宏替换的操作 ;

内联函数参考 【Kotlin】函数 ⑦ ( 内联函数 | Lambda 表达式弊端 | “ 内联 “ 机制避免内存开销 - 将使用 Lambda 表达式作为参数的函数定义为内联函数 | 内联函数本质 - 宏替换 ) 博客进行理解 ;

Kotlin 中的标准库函数 , 参考 【Kotlin】标准库函数总结 ( apply 函数 | let 函数 | run 函数 | with 函数 | also 函数 | takeIf 函数 | takeUnless 函数 ) , 基本都是 泛型扩展函数 ;