Kotlin -正确退出forEach

最近在代码评审的时候，发现看到同事使用 kotlin 的forEach，他以为使用 return@forEach 就可以退出了，相当于 break，但其实并不是，只是相当于 for 的 continue。

一. 问题复现

那么，如何正确退出 forEach呢？
先看这段代码，打印出什么？

listOf(1, 2, 3, 4, 5).forEach {
   if (it == 3) return@forEach 
    print(it)
}

打印如下：

1
2
4
5

嗯，看起来就相当于 for 的continue，去到forEach源码看看：

public inline fun <T> Array<out T>.forEach(action: (T) -> Unit): Unit {
    for (element in this) action(element)
}

它是Array的扩展函数，用了一个高级去循环，所以当 return@forEach 的时候，只是当前这个 action 不执行而已。

1.1 @forEach 怎么来的？

在正确退出forEach 之前，先说说 @forEach 是怎么来的？
在Kotlin 中，任何函数都可以加标签，标签的格式为标识符后跟 @ 符号，例如：abc@,比如上面的代码，我们其实可以改成：

listOf(1, 2, 3, 4, 5).forEach  loop@{
   if (it == 3) return@loop
    print(it)
}

效果是一样的，@forEach 是它的隐式标签

二、 正确退出forEach

可以通过增加另一层嵌套 lambda 表达式，如 loop@，然后使用 return@loop 退出，如下

run loop@{
 listOf(1, 2, 3, 4, 5).forEach {
   if (it == 3) return@loop
    print(it)
}
}