Kotlin 中的 run、let、with、apply、also、takeIf、takeUnless 语法糖使用和原理分析

这些Kotlin的语法糖函数经常用,但也很容易搞混,所以转载一下,若混了可以回来再看

转载自公众号:纸上浅谈

 

正文:

在 Kotlin 有一些可以简化代码的语法糖，比如 run、let、with、apply、also、takeIf、takeUnless  等。

再不明白这些语法糖的情况下去看 Kotlin 代码就会一脸懵逼，可当明白之后就会觉得原来可以这样简化。

带接收者的函数字面值

使用这些语法糖之前回顾一下 Kotlin 的函数式编程，在分析 Kotlin 使用 Anko 构建布局 文章中有提到 带接收者的函数字面值。

它的形式是这样的：

1// 定义一个类
2class ReceiveObject 
3// 定义一个函数
4fun exec(invoke: ReceiveObject.()-> Int){}

在 Kotlin 中，函数也可以当做变量传参，例如：

1fun funAsArg(args:()->Int){}
2// 调用
3funAsArg { 2 }

args 是变量名，它的类型就是函数，函数形式在变量名后面约定：()->Int，函数没有参数，但是会返回一个 Int 类型的值。

而带接收者的函数字面值，就是在作为传入参数的函数变量的具体函数形式的参数前面多了接收者对象，简单说就是在 ()前面多了一个点和一个对象，成了如下的形式：

1fun exec(invoke: ReceiveObject.()-> Int){}

就是这多了的一个点和一个对象，让它有了不一样的功能。

简单的说，invoke 变量是一个函数作为变量，需要传递一个具体函数实现作为形参给 invoke，那么在具体函数实现里面就可以调用接收者对象 ReceiveObject 的相关方法，如下：

 1    // 接收者对象，有个 show 方法
 2    class ReceiveObject{
 3        fun show(){
 4            println("call")
 5        }
 6    }
 7    // 具体函数实现
 8    val invoke: ReceiveObject.() -> Int = {
 9        this.show() // 用 this 指代 接收者对象 ReceiveObject
10        2
11    }
12    exec(invoke)

如上，在 invoke 方法里面使用 this 指代 ReceiveObject 对象，可以调用它的方法。

而 invoke 变量是作为参数传递给 exec 函数的，如果 exec 函数为空，那么 inkoke 具体实现的 show 方法也不会被调用的，在 exec 中调用 invoke 的方法如下：

1fun exec(invoke: ReceiveObject.() -> Int){
2    val receObj = ReceiveObject()
3    // 两种调用形式
4    // 类似于 ReceiceObject 拓展函数一样的调用
5    receObj.invoke() 
6    // 把 ReceiceObject 作为参数传递给 invoke 调用
7    invoke(receObj)
8}

在 exec 的具体调用中，我们需要构造一个 ReceiveObject 对象实例，不然怎么去调用它的 show 方法呢。

在上面的例子中，还需要构造一个指定的接收者对象实例才能完成 invoke 的调用，而 Kotlin 的语法糖中还有一种叫做 拓展函数。

拓展函数

拓展函数相当于给某个类添加函数，但这个函数并不属于这个类的函数，和 static 方法是两码事。

1    fun Context.showToast(msg: String) {
2        Toast.makeText(this, msg, Toast.LENGTH_SHORT).show()
3    }

在拓展函数中，使用 this 指代被拓展的类实例，上面代码中 this 指代就是 Context 。

有了 拓展函数和带接收者的函数字面值，就可以实现文章标题提到的那些语法糖了。

例如，针对 ReceiveObject 对象添加它的拓展函数，拓展函数的参数又是一个函数，函数是带接收者的函数字面值，这个接收者对象就是 ReceiveObject 对象它本身，这样调用 invoke 方法就不用再构造 ReceiveObject 对象了。

1fun ReceiveObject.exec(invoke: ReceiveObject.() -> Int){
2    invoke()
3}

语法糖

下面介绍的语法糖都是位于 Kotlin Standard.kt 文件中的。

run 语法糖

run 的语法糖有两种：

1public inline fun  run(block: () -> R): R {
2    contract {
3        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
4    }
5    return block()
6}

这种语法糖传递的参数就仅仅是一个函数，不是带接收者对象的函数字面值，它的返回结果就是 block 函数调用后的结果。

调用示例：

1    var result = kotlin.run { 
2            "value"
3        }

相对于给 arg 变量赋值为 value 字符串。

run 的另一种语法糖：

1public inline fun  T.run(block: T.() -> R): R {
2    contract {
3        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
4    }
5    return block()
6}

首先，这个语法糖是一个拓展函数，而且用到了泛型 ，T 类型的拓展函数，返回的是 R 类型，T 和 R 可以相同。

其次，传递的参数是带接收者对象的函数字面值，也就是说可以在 block 函数里面调用 T 的相关方法，通过 this 来指代 T ，在 run 方法内部就是调用了 block 方法，返回 block 函数调用后的结果。

调用示例：

1            val result = "a".run {
2                this.plus("b")
3            }

Contracts DSL

在 run 的语法糖里面还出现了如下一段代码：

1 contract {
2      callsInPlace(block, InvocationKind.EXACTLY_ONCE)
3   }

Google 了一番之后

1. https://discuss.kotlinlang.org/t/status-of-kotlin-internal-contracts/6392/2

2. https://stackoverflow.com/questions/49729037/how-does-kotlin-internal-contracts-contractbuilderktcontract-work-in-kotlin

3. https://aisia.moe/2018/03/25/kotlin-contracts-dsl/

得出原来这是 Kotlin 1.2.x 版本中出现的，但实际并没有用，是 Kotlin 后续发展用来解决如下代码问题的：

1if (!x.isNullOrEmpty()) { 
2  // we know that 'x != null' here 
3  println(x.length)
4}

假设 x 是可以为 null 的，经过 isNullOrEmpty 函数判断之后，再执行 println 函数，那么它肯定就不是 null 了，就不需要再加两个 !! 来表示 x 不为 null 了，而现在的情况是要添加 !! 。

从 Google 来的信息得知， contract 这段代码就是为了这样的问题的。

由于语法糖都有那样一段代码，所以就先把它们去掉了。

let 语法糖

1public inline fun  T.let(block: (T) -> R): R {
2    return block(this)
3}

let 语法糖传递的参数是一个函数，不是带接收者的函数字面值，但 block 函数的参数就是 T 类型，所以可以在 block 里面调用 T 类型的方法，但不能通过 this 来指代 T 了，通过 it 来指代 T 类型。

调用示例：

1            val result = "a".let {
2                it.plus("b")
3            }

with 语法糖

1public inline fun  with(receiver: T, block: T.() -> R): R {
2    return receiver.block()
3}

with 语法糖不再是一个拓展函数了，而是需要在语法糖的第一个参数里面传入接收者对象的实例，第二个参数就是带接收者的函数字面值实例，返回的也是 block 调用的结果，这一点和 run 语法糖类似。

调用示例：

1            val result = with("a") {
2                this.plus("b")
3            }

apply 语法糖

1public inline fun  T.apply(block: T.() -> Unit): T {
2    block()
3    return this
4}

apply 语法糖和 run 语法糖都类似，只不过它返回的不是 block 函数调用的结果，而是返回调用者本身，返回 T 类型。

also 语法糖

1public inline fun  T.also(block: (T) -> Unit): T {
2    block(this)
3    return this
4}

also 语法糖和 let 语法糖有点类似，只不过返回的结果不是 block 调用结果，而是返回它本身，返回 T 类型。

调用示例：

1            var result = "a".also {
2                it.plus("b")
3            }

takeIf 语法糖

1public inline fun  T.takeIf(predicate: (T) -> Boolean): T? {
2    return if (predicate(this)) this else null
3}

takeIf 语法糖会调用 predicate 函数进行判断，如果为 true 就返回它本身，否则返回 null 。

takeUnless 语法糖

1public inline fun  T.takeUnless(predicate: (T) -> Boolean): T? {
2    return if (!predicate(this)) this else null
3}

takeUnless 和 takeIf 正好相反，如果 predicate 返回 false 就返回它本身，否则返回 null 。

总结

这么多的语法糖，其实他们的原理都是类似的，共同点在于都是有返回值的，而区别就在于对原有的值进行了哪些操作，然后如何返回最终的值。

最后，光是了解他们的原理和调用情况还是不够的，再不影响代码阅读的情况下要把它们引入到我们的代码中去，灵活地使用它们。