在对象的上下文中执行代码块。当您在提供lambda表达式的对象上调用这样的函数时,它会形成一个临时作用域。在此范围内,可以不带名称地访问对象。这样的函数称为作用域函数。
let
run
with
apply
also
作用域函数不会引入任何新的技术功能,但它们可以使代码更加简洁易读。
尽管作用域函数可以使代码更加简洁,但要避免过度使用它们:这会使代码难以阅读并导致错误。我们还建议避免嵌套作用域函数,并在链接它们时要小心,因为很容易混淆当前上下文对象和this或it的值。
对比
函数 | 对象引用 | 返回值 | 是否是扩展函数 |
---|---|---|---|
let | it | Lambda result | Yes |
run | this | Lambda result | Yes |
run | - | Lambda result | No:在没有上下文对象的情况下调用 |
with | this | Lambda result | No:以上下文对象作为参数。是顶层函数 |
apply | this | Context object(不会返回闭包结果) | Yes |
also | it | Context object(不会返回闭包结果) | Yes |
let
可用于对调用链的结果调用一个或多个函数。例如,下面的代码打印一个集合上的两个操作的结果:
val numbers = mutableListOf("one", "two", "three", "four", "five")
val resultList = numbers.map { it.length }.filter { it > 3 }
println(resultList)
val numbers = mutableListOf("one", "two", "three", "four", "five")
numbers.map { it.length }.filter { it > 3 }.let {
println(it)
// and more function calls if needed
}
Let通常用于执行包含非空值的代码块。要对非空对象执行操作,请使用安全调用运算符?。
val str: String? = "Hello"
//processNonNullString(str) // compilation error: str can be null
val length = str?.let {
println("let() called on $it")
processNonNullString(it) // OK: 'it' is not null inside '?.let { }'
it.length
}
在 Fragment
中获取参数
arguments?.let {
param1 = it.getString(ARG_PARAM1)
}
with
不能判空
建议在不需要使用返回结果时使用with来调用上下文对象上的函数。在代码中,with可读为“使用此对象,执行以下操作。”
val numbers = mutableListOf("one", "two", "three")
with(numbers) {
println("'with' is called with argument $this")
println("It contains $size elements")
}
run
Run的功能与with相同,但它是作为扩展函数实现的。
当你的lambda既初始化对象又计算返回值时,Run很有用。
val service = MultiportService("https://example.kotlinlang.org", 80)
val result = service.run {
port = 8080
query(prepareRequest() + " to port $port")
}
// the same code written with let() function:
val letResult = service.let {
it.port = 8080
it.query(it.prepareRequest() + " to port ${it.port}")
}
还可以将run作为非扩展函数调用。run的非扩展变体没有上下文对象,但它仍然返回lambda结果。非扩展运行允许您在需要表达式的地方执行由几个语句组成的块。
val hexNumberRegex = run {
val digits = "0-9"
val hexDigits = "A-Fa-f"
val sign = "+-"
Regex("[$sign]?[$digits$hexDigits]+")
}
for (match in hexNumberRegex.findAll("+123 -FFFF !%*& 88 XYZ")) {
println(match.value)
}
apply
建议您将它用于不返回值且主要操作receiver对象成员的代码块。apply最常见的用例是用于对象配置。这样的调用可以理解为“对对象应用下列赋值”。
val adam = Person("Adam").apply {
age = 32
city = "London"
}
println(adam)
apply的另一个用例是在多个调用链中包含apply,以进行更复杂的处理。
给 Fragment
的参数赋值
arguments = Bundle().apply {
putString(ARG_PARAM1, param1)
}
also
对于需要引用对象而不是其属性和函数的操作,或者当您不想从外部作用域遮挡this引用时,使用also。
当您在代码中看到also时,您可以将其读为“并且还对对象执行以下操作”。
val numbers = mutableListOf("one", "two", "three")
numbers
.also { println("The list elements before adding new one: $it") }
.add("four")
资料
https://kotlinlang.org/docs/scope-functions.html