Kotlin - let, apply, with, run的差别和用法

前言

下面除了with之外，所有用例都来自Android生产代码。因项目没有实际使用with语法，所以通过其他例子来示意。在不影响理解的情况下，所有用例移除业务相关代码。

文章中使用的Kotlin版本是1.2.10，不同版本的Kotlin标准库实现可能会有差异。

一、let

调用传入的函数式。接收者为T，且用it指代T，返回值与函数式返回值一致。

// 用`this`作为调用块的实参，并返回块执行结果
@kotlin.internal.InlineOnly
public inline fun <T, R> T.let(block: (T) -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block(this)
}

1.1 用例

把color:Int颜色值设置到text:TextView。

color.let {
    try {
        text.setTextColor(Color.parseColor(it))
    } catch (e: Exception) {
        Log.e("ClazzName", "setTextColor($color) -> ${e.message}")
    }
}

1.2 用例

当results:MutableList<String>不为空时，从results按position取对应值并绑定到viewHolder。

// results进行了判空操作
results?.let {
    if (it.isNotEmpty()) {
        viewHolder.bind(holder, it[position])
    }
}

二、apply

apply使用this指代T，函数值返回值是Unit。但apply通过return this主动返回T的实例。

// 用`this`作为执行块的接收者，并返回`this`的实例
@kotlin.internal.InlineOnly
public inline fun <T> T.apply(block: T.() -> Unit): T {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    block()
    return this
}

2.1 用例

创建LinearLayout并利用apply设置初始化参数，最后返回初始化完毕的LinearLayout实例。

val linearLayout = LinearLayout(itemView.context).apply {
    orientation = LinearLayout.VERTICAL
    layoutParams = LinearLayout.LayoutParams(
            LinearLayout.LayoutParams.MATCH_PARENT,
            LinearLayout.LayoutParams.WRAP_CONTENT)
}

上面的代码等价于：

val linearLayout = LinearLayout(itemView.context)
linearLayout.orientation = LinearLayout.VERTICAL
linearLayout.layoutParams = LinearLayout.LayoutParams(
        LinearLayout.LayoutParams.MATCH_PARENT,
        LinearLayout.LayoutParams.WRAP_CONTENT)

如果构造过程中需要初始化的变量较多，使用apply形成的代码块会非常直观。

2.2 用例

根据newProgress:Int来修改progressBar的状态。

progressBar.apply {
    progress = newProgress
    visibility = if (newProgress in 1..99) View.VISIBLE else View.GONE
}

等价于下列代码：

progressBar.progress = newProgress
progressBar.visibility = if (newProgress in 1..99) View.VISIBLE else View.GONE

三、with

接收一个receiver和一个函数式，通过this调用receiver，返回值根据函数式最后一个返回值为准。

一般会在传入receiver的时候就地创建实例，不然使用apply来替代with会是更好的选择。

// 用给定的[receiver]作为执行块的接收者，并返回接收者的块执行结果
@kotlin.internal.InlineOnly
public inline fun <T, R> with(receiver: T, block: T.() -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return receiver.block()
}

3.1 用例

使用ArrayList<String>()作为闭包的参数，返回类型为println()的返回值Unit。

with(ArrayList<String>()) {
    add("a")
    add("b")
    add("c")
    println("this = " + this)
}

3.2用例

使用ArrayList<String>()做为闭包的参数，返回值类型为this:ArrayList<String>。

with(ArrayList<String>()) {
    add("a")
    add("b")
    add("c")
    this
}

3.3 用例

使用ArrayList<String>()做为闭包的参数，返回值类型为3.1415926的默认类型Double，注意不是Float。

with(ArrayList<String>()) {
    add("a")
    add("b")
    add("c")
    3.1415926
}

四、run

执行传入的函数式，并返回函数的执行结果。run的主要目的是强调需要执行的函数。

// 执行具有指定功能的[block]，并返回执行结果
@kotlin.internal.InlineOnly
public inline fun <R> run(block: () -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block()
}

// 用`this`作为执行块的接收者，并返回块执行的结果
@kotlin.internal.InlineOnly
public inline fun <T, R> T.run(block: T.() -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block()
}

4.1 用例

从intent取EXTRA_URL的值，不为非空且内容不为空，赋值给url。否则弹出提示并关闭页面。

// Init url:String
url = intent.getStringExtra(EXTRA_URL)?.takeIf { it.isNotEmpty() } ?: run {
    toast("不能浏览一个空链接哦")
    activity.finish()
}