Kotlin高阶函数之let、run、with、apply、also

这几个都是 Standard.kt 中的高阶函数,使用起来比较相似,容易混淆,下面就分析一下它们的区别和使用场景。

先看下不使用这些高阶函数的例子:

data class Person(val name: String, val age: Int) {
    fun work(): String {
        println("${name}正在工作...")
        return "工作完成"
    }
}

fun findPerson(): Person? {
    return Person("JamFF", 18)
}

fun main() {
    val person = findPerson()
    println(person?.name) // 输出 JamFF
    println(person?.age) // 输出 18
    val result = person?.work() // 输出 JamFF正在工作...
    println(result) // 输出 工作完成
}

一、let 函数

/**
 * Calls the specified function [block] with `this` value as its argument and returns its result.
 *
 * For detailed usage information see the documentation for [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)
}

使用 let 简化:

fun main() {
    val result = findPerson()?.let { person ->
        println(person.name) // 输出 JamFF
        println(person.age) // 输出 18
        person.work() // 输出 JamFF正在工作...
    }
    println(result) // 输出 工作完成

Lambda 还可以简化,使用 it 代替:

fun main() {
    val result = findPerson()?.let {
        println(it.name) // 输出 JamFF
        println(it.age) // 输出 18
        it.work() // 输出 JamFF正在工作...
    }
    println(result) // 输出 工作完成
}

在作用域中使用 it 代替调用者,最后一行为返回值。

二、run 函数

/**
 * Calls the specified function [block] with `this` value as its receiver and returns its result.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#run).
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> T.run(block: T.() -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block()
}

对于 T.() -> R 类型不理解的可以看这里:带有接收者的函数字面值

使用 run 简化:

fun main() {
    val result = findPerson()?.run {
        println(this.name) // 输出 JamFF
        println(age) // 输出 18
        work() // 输出 JamFF正在工作...
    }
    println(result) // 输出 工作完成
}

在作用域中使用 this 代替调用者(可以省略),最后一行为返回值。

还有一个重载 run 函数:

/**
 * Calls the specified function [block] and returns its result.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#run).
 */
@kotlin.internal.InlineOnly
public inline fun <R> run(block: () -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block()
}

该函数使用场景不多,看下面一个例子:

fun foo() {
    val age = 42
    val result = run {
        val age = 8
        println("内部运行年龄 $age")// 输出 内部运行年龄 8
        "内部运行结束"// 最后一行返回值
    }
    println(result)// 内部运行结束
    println("外部运行年龄 $age")// 输出 外部运行年龄 42
}

可以看到 run 函数新建了一个作用域,屏蔽了外面 age 变量, 另外 run 函数是有返回值的。

三、with 函数

/**
 * Calls the specified function [block] with the given [receiver] as its receiver and returns its result.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#with).
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> with(receiver: T, block: T.() -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return receiver.block()
}

使用 with 简化:

fun main() {
    val result = with(findPerson()) {
        println(this?.name) // 输出 JamFF
        println(this?.age) // 输出 18
        this?.work() // 输出 JamFF正在工作...
    }
    println(result) // 输出 工作完成
}

需要传入参数,在作用域中使用 this 代替参数(可以省略),最后一行为返回值。

四、apply 函数

/**
 * Calls the specified function [block] with `this` value as its receiver and returns `this` value.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#apply).
 */
@kotlin.internal.InlineOnly
public inline fun <T> T.apply(block: T.() -> Unit): T {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    block()
    return this
}

使用 apply 简化:

fun main() {
    val result = findPerson()?.apply {
        println(this.name) // 输出 JamFF
        println(age) // 输出 18
        work() // 输出 JamFF正在工作...
    }
    println(result) // 输出 Person1(name=JamFF, age=18)
}

类似 run,区别是,返回值是调用者自己。

在作用域中使用 this 代替调用者(可以省略),调用者为返回值。

五、also 函数

/**
 * Calls the specified function [block] with `this` value as its argument and returns `this` value.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#also).
 */
@kotlin.internal.InlineOnly
@SinceKotlin("1.1")
public inline fun <T> T.also(block: (T) -> Unit): T {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    block(this)
    return this
}

使用 also 简化:

fun main() {
    val result = findPerson()?.also {
        println(it.name) // 输出 JamFF
        println(it.age) // 输出 18
        it.work() // 输出 JamFF正在工作...
    }
    println(result) // 输出 Person1(name=JamFF, age=18)
}

类似 let,区别是,返回值是调用者自己。

在作用域中使用 it 代替调用者,调用者为返回值。

六、 总结

上面五个函数,不论用哪个,都可以完成类似功能,只不过使用恰当的函数,可以进一步减少代码量,选择标准可以参考下面图片:


let、run、with、apply、also 如何选择

最后再看下老外整理的两张图加深记忆:


Kotlin 标准方法流程图
Kotlin 标准方法表格
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,165评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,503评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,295评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,589评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,439评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,342评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,749评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,397评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,700评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,740评论 2 313
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,523评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,364评论 3 314
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,755评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,024评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,297评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,721评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,918评论 2 336

推荐阅读更多精彩内容