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

韩曙亮

发布于 2023-03-30 10:55:51

1.3K00

代码可运行

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

运行总次数：0

代码可运行

文章目录

一、定义扩展文件

如果定义的扩展函数需要在多个 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)
}