【Kotlin】标准库函数总结 ( apply 函数 | let 函数 | run 函数 | with 函数 | also 函数 | takeIf 函数 | takeUnless 函数 )

Kotlin 语言中 , 在 Standard.kt 源码中 , 为所有类型定义了一批标准库函数 , 所有的 Kotlin 类型都可以调用这些函数 ;

---

Kotlin 标准库函数 中的 apply 函数 ,

该函数可以看作 实例对象 的 配置函数 ,

传入 T.() -> Unit 类型 的 Lambda 表达式 作为参数 ,

该实例对象默认为 Lambda 表达式中的 this 参数 ;

apply 函数 的返回值 是 接收者对象 ,

也就是 调用 apply 函数 的实例对象 ,

同时也是 Lambda 表达式参数中的 this 参数 ;

apply 标准库函数原型 :

@kotlin.internal.InlineOnlypublic inline fun  T.apply(block: T.() -> Unit): T {    contract {        callsInPlace(block, InvocationKind.EXACTLY_ONCE)    }    block()    return this}

代码示例 : 创建 File 文件对象 , 并为该文件设置 可读 , 可写 , 可执行 权限 ;

import java.io.Filefun main() {    val file = File("hello.txt")    file.setReadable(true)    file.setWritable(true)    file.setExecutable(true)}

apply 函数代码示例 : 后面设置 可读 , 可写 , 可执行 权限的配置操作 , 可以在 apply 标准库函数中完成 , 代码如下 :

import java.io.Filefun main() {    val file = File("hello.txt").apply {        this.setReadable(true)        this.setWritable(true)        this.setExecutable(true)    }}

---

Kotlin 标准库函数 中的 let 函数 ,

可以传入 (T) -> R 类型 的 Lambda 表达式 作为参数 ,

该 匿名函数 中 使用 it 默认变量 获取 调用者 实例对象 ;

apply 函数与 let 函数的区别 :

• apply 函数的 返回值是 调用者 ;
• let 函数的 返回值是 Lambda 表达式的最后一行 ;

let 函数原型 :

@kotlin.internal.InlineOnlypublic inline fun  T.let(block: (T) -> R): R {    contract {        callsInPlace(block, InvocationKind.EXACTLY_ONCE)    }    return block(this)}

代码示例 :

fun main() {    val name = "tom".let {        it.capitalize()    }    println(name)}

上述代码中 , 调用 字符串 “tom” 的 let 函数 ,

在 let 函数中 , 将首字母变为大写 , 并返回 ,

let 函数返回的是 匿名函数 的最后一行 , 因此将 “Tom” 字符串 返回了 ;

如果将 let 函数换成 apply 函数 , 则返回的就是 “tom” 字符串本身 , 不是 Lambda 表达式的最后一行 ;

执行结果 :

Tom

let 函数与 空安全操作符 ?. , 空合并操作符 ?: 结合使用 , 可替代 if 语句效果 ;

代码示例 :

fun main() {    val name: String? = null    println(getName(name))}fun getName(name: String?): String {    return name?.let {        "欢迎 $name 同学"    }?: "name 为空"}

在上述函数中 , 首先确定 name 变量是否为空 ,

如果 name 为空 , 则 name?.let {...} 为空 , 后面的 let 函数根本不会执行 ,

此时会取 空合并操作符 ?: 后面的值作为整个表达式的值 ;

如果 name 不为空 , 则 执行 let 函数 , 整个表达式的值 就是 let 函数的最后一行 返回值 ;

执行结果 :

name 为空

---

1、run 函数传入 Lambda 表达式作为参数

run 标准库函数原型如下 :

@kotlin.internal.InlineOnlypublic inline fun  T.run(block: T.() -> R): R {    contract {        callsInPlace(block, InvocationKind.EXACTLY_ONCE)    }    return block()}

run 函数 传入 T.() -> R 类型 的 Lambda 表达式 作为参数 ,

该 run 函数的 返回值 就是 Lambda 表达式 的返回值 ;

代码示例 : 在下面的代码中 ,

run 函数的 Lambda 表达式参数 返回的是 boolean 类型的 true 值 ,

该值就是最终 run 函数的返回值 ;

fun main() {    val ret = "Hello".run {        true    }    println(ret)}

执行结果 :

true

2、run 函数传入函数引用作为参数

在上述函数原型中 :

public inline fun  T.run(block: T.() -> R): R {}

run 函数 , 传入 T.() -> R 类型 的 函数参数 ,

此处也可以传入 函数引用 ;

利用 run 函数的该用法 , 可以进行链式调用 ;

代码示例 : 在下面的代码中 ,

"hello".run(::hasO) 代码 等价于 hasO("hello") 代码 ;

"hello".run(::hasO).run(::log) 代码 等价于 log(hasO("hello")) 代码 ;

"hello".run(::hasO).run(::log).run(::println) 代码 等价于 println(log(hasO("hello"))) 代码 ;

前者是链式调用代码 , 后者是正常的函数调用方式 ;

fun main() {    "hello"        .run(::hasO)        .run(::log)        .run(::println)}fun hasO(name: String): Boolean {    return name.contains("o")}fun log(hasO: Boolean): String {    if (hasO) {        return "name has o"    } else {        return "name doesn't has o"    }}

执行结果 :

name has o

---

with 函数 与 run 函数 功能是一样的 ,

其使用形式不同 , with 函数是 独立使用的 ,

调用时 , 需要 将 接收者实例对象 作为 with 函数的 参数 ;

with 函数原型 :

@kotlin.internal.InlineOnlypublic inline fun  with(receiver: T, block: T.() -> R): R {    contract {        callsInPlace(block, InvocationKind.EXACTLY_ONCE)    }    return receiver.block()}

with 函数的第一个参数是 receiver: T 接收者 ,

第二个参数是 block: T.() -> R , 是 T.() -> R 类型的 Lambda 表达式 ;

代码示例 :

fun main() {    val str = with("hello") {        capitalize()    }    println(str)}

执行结果 :

Hello

上述 with 函数的执行效果与下面的 run 函数执行效果是相同的 ;

代码示例 :

fun main() {    val str = "hello".run {        capitalize()    }    println(str)}

执行结果 :

Hello

---

also 函数 功能与 let 函数 功能 类似 ;

also 函数 将 接收者 ( 函数调用者 ) 作为参数传递给 Lambda 表达式参数 ,

并返回 接收者实例对象本身 ;

also 函数 与 let 函数 返回值不同 ,

also 函数 返回 接收者对象本身 ,

let 函数 返回 Lambda 表达式的最后一行 ;

also 函数 返回 接收者对象本身 , 那么就可以使用该特性 , 对 接收者 执行 函数式编程的 链式调用 ;

代码示例 :

fun main() {    val str = "hello".also {        println(it)    }.also {        // 该对象的生命周期仅限于该闭包        println(it.capitalize())    }    // 最终打印的是最初的 接收者对象    println(str)}

执行结果 :

helloHellohello

---

takeIf 函数 的 返回值 由其 Lambda 表达式参数的返回值 确定 ,

Lambda 表达式 返回 true , 则 返回 接收者对象 ;

Lambda 表达式 返回 false , 则 返回 null 空值 ;

takeIf 函数 的功能 也可以使用 if 语句实现 ,

但是该函数 可以 直接 作用于 接收者对象 , 非常适合进行 函数式编程 的 链式调用 场景 ,

如果使用 if 语句 , 需要分 多行代码实现 , 还要定义临时变量 ;

takeIf 函数原型 :

@kotlin.internal.InlineOnly@SinceKotlin("1.1")public inline fun  T.takeIf(predicate: (T) -> Boolean): T? {    contract {        callsInPlace(predicate, InvocationKind.EXACTLY_ONCE)    }    return if (predicate(this)) this else null}

代码示例 : 在下面的代码中 ,

takeIf 函数 的 Lambda 表达式参数中 ,

使用 it.contains("o") 判断 接收者 字符串中是否包含 "o" 字符串 ,

如果返回 true , 则返回 接收者本身 , 否则返回 null ;

fun main() {    val str = "hello".takeIf {        it.contains("o")    }?.capitalize()    println(str)}

执行结果 :

Hello

---

takeUnless 函数 与 takeIf 函数 效果正好相反 ;

takeUnless 函数 的 返回值 由其 Lambda 表达式参数的返回值 确定 ,

Lambda 表达式 返回 false , 则 返回 接收者对象 ;

Lambda 表达式 返回 true , 则 返回 null 空值 ;

takeUnless 函数原型 :

@kotlin.internal.InlineOnly@SinceKotlin("1.1")public inline fun  T.takeUnless(predicate: (T) -> Boolean): T? {    contract {        callsInPlace(predicate, InvocationKind.EXACTLY_ONCE)    }    return if (!predicate(this)) this else null}

代码示例 : 在下面的代码中

takeUnless 函数的 Lambda 表达式 参数 返回的结果 为 true ,

因此 "hello".takeUnless { it.contains("o") } 的返回值为 null ,

由于后面的 ?.capitalize() 是空安全操作符调用 , 接收者为空的情况下不执行 ,

最终的 str 值为 null ;

fun main() {    val str = "hello".takeUnless {        it.contains("o")    }?.capitalize()    println(str)}

执行结果 :

null

来源地址：https://blog.csdn.net/shulianghan/article/details/128640441