Scope Functions: Kotlin中的作用域函數(shù)
本文收錄于: https://github.com/mengdd/KotlinTutorials
Kotlin標(biāo)準(zhǔn)庫提供了5個(gè)scope functions(作用域函數(shù)): let, run, with, apply, also.
作用域函數(shù)的目的是為了在對(duì)象的上下文中執(zhí)行一段代碼.
當(dāng)你在一個(gè)對(duì)象上調(diào)用作用域方法, 提供一個(gè)lambda表達(dá)式, 會(huì)形成一個(gè)臨時(shí)的scope, 在這個(gè)scope里, 訪問該對(duì)象可以不用它的名字.
作用域方法沒有引入什么新的技術(shù)能力, 它們只是簡化了代碼.
作用域函數(shù)的區(qū)別
作用域函數(shù)主要的不同有三點(diǎn):
- 訪問上下文對(duì)象的方式:
this還是it. - 返回值: 是上下文對(duì)象還是lambda結(jié)果.
- 是否是擴(kuò)展函數(shù).
上下文對(duì)象:
- 使用
this的:run,with,apply. 對(duì)象作為lambda的receiver.
(this可以被省略). - 使用
it的:let和also. 對(duì)象作為lambda的argument. 也可以提供自定義的名字, 不提供的話, 默認(rèn)是it.
舉例:
val str: String? = "Hello"
// this
str?.run {
println("run: The receiver string's length is $length")
// println("run: The receiver string's length is ${this.length}") // does the same
}
// it
str?.let {
println("let: The receiver string's length is ${it.length}")
}
返回值:
-
apply和also返回上下文對(duì)象自己. (可以記憶為a開頭的兩個(gè)方法返回自己.) -
let,run和with返回lambda的結(jié)果.
是否是擴(kuò)展函數(shù):
-
with不是擴(kuò)展函數(shù). -
run有擴(kuò)展函數(shù)和非擴(kuò)展函數(shù)兩種形式. -
let,also,apply都是擴(kuò)展函數(shù).
使用建議
-
let: 在非空的值上執(zhí)行一段代碼 ->?.let; 在一個(gè)較小作用域內(nèi)引入局部變量.
比如有數(shù)據(jù)結(jié)構(gòu):
data class Person(val name: String, var pet: Pet? = null)
data class Pet(var name: String? = null, var age: Int? = null, var type: String? = null)
let的非空判斷可以級(jí)聯(lián):
person?.pet?.name?.let { println("pet name is: $it") }
可以結(jié)合?:來設(shè)置為空時(shí)做什么:
person?.pet?.name?.let { println("pet name is: $it") } ?: println("there is no pet name")
這樣不論是person還是pet還是name為空, 都會(huì)打印出"there is no pet name".
-
with: 需要在上下文對(duì)象上運(yùn)行代碼, 不需要返回值; 對(duì)對(duì)象進(jìn)行一組函數(shù)調(diào)用. -
run: 對(duì)象配置, 并計(jì)算一個(gè)結(jié)果返回. -
apply: 對(duì)象配置. 比如Android中常見的Fragment和Intent的創(chuàng)建和參數(shù)設(shè)置.
val bundle = Bundle().apply {
putString("ARG_XXX", value)
}
MyFragment().apply {
arguments = bundle
})
上面這段代碼也可以直接嵌套起來, 但是有的convention可能不推薦, 因?yàn)闀?huì)增加理解成本. 所以要看團(tuán)隊(duì)意見.
Intent().apply {
action = Intent.ACTION_VIEW
data = Uri.parse("some-uri")
}
-
also: 做一些不改變對(duì)象本身的額外操作, 比如打印log.
注意有些使用場景是重合的, 所以可以自己根據(jù)實(shí)際情況選用.
注意不要過度使用:
- 可能會(huì)降低可讀性;
- 避免嵌套使用作用域函數(shù);
- 鏈?zhǔn)绞褂玫臅r(shí)候要注意上下文對(duì)象的值.
作用域函數(shù)和takeIf, takeUnless結(jié)合使用很方便.
