Kotlin标准库函数 ④ ( takeIf 标准库函数 | takeUnless 标准库函数 )

Posted 2023-01-12 韩曙亮

文章目录

• 一、takeIf 标准库函数
• 二、takeUnless 标准库函数

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

一、takeIf 标准库函数

---

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

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

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

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

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

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

takeIf 函数原型 :

/**
 * 如果满足给定的[谓词]则返回' this '值，如果不满足则返回' null '值。
 *
 * 有关详细使用信息，请参阅[scope functions]的文档
 * (https://kotlinlang.org/docs/reference/scope-functions.html#takeif-and-takeunless)。
 */
@kotlin.internal.InlineOnly
@SinceKotlin("1.1")
public inline fun <T> 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 标准库函数

---

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

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

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

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

takeUnless 函数原型 :

/**
 * 如果不满足给定的[谓词]，则返回' this '值;如果满足，则返回' null '值。
 *
 * 有关详细使用信息，请参阅[scope functions]的文档
 * (https://kotlinlang.org/docs/reference/scope-functions.html#takeif-and-takeunless)。
 */
@kotlin.internal.InlineOnly
@SinceKotlin("1.1")
public inline fun <T> 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