Kolin中的作用域函數(shù)

原文:Kotlin官方

Kotlin中的作用域函數(shù)共有以下五種:letrunwith叉趣、apply 以及 also唤崭。

這些函數(shù)并沒有做什么特殊的操作屋彪,只是將對當前對象的操作都集中到了一個代碼塊中來溃肪,寫出來和看起來更加干凈了而已均牢。

不同的是這個對象在塊中如何使用,以及整個表達式的結(jié)果是什么曹货。

區(qū)別

上下文對象(this/it) 返回值
let it lambda 表達式結(jié)果
run this(隱式訪問) lambda 表達式結(jié)果
with this(隱式訪問) lambda 表達式結(jié)果
apply this(隱式訪問) 上下文
also it 上下文

let

上下文對象作為 lambda 表達式的參數(shù)(it來訪問咆繁。返回值是 lambda 表達式的結(jié)果

Person("Alice", 20, "Amsterdam").let {
    println(it)
    it.moveTo("London")
    it.incrementAge()
    println(it)
}

let 經(jīng)常用于僅使用非空值執(zhí)行代碼塊控乾。如需對非空對象執(zhí)行操作么介,可對其使用安全調(diào)用操作符 ?. 并調(diào)用 let 在 lambda 表達式中執(zhí)行操作。

val str: String? = "Hello" 
//processNonNullString(str)       // 編譯錯誤:str 可能為空
val length = str?.let { 
    println("let() called on $it")
    processNonNullString(it)      // 編譯通過:'it' 在 '?.let { }' 中必不為空
    it.length
}

使用 let 的另一種情況是引入作用域受限的局部變量以提高代碼的可讀性蜕衡。如需為上下文對象定義一個新變量壤短,可提供其名稱作為 lambda 表達式參數(shù)來替默認的 it

val numbers = listOf("one", "two", "three", "four")
val modifiedFirstItem = numbers.first().let { firstItem ->
    println("The first item of the list is '$firstItem'")
    if (firstItem.length >= 5) firstItem else "!" + firstItem + "!"
}.toUpperCase()
println("First item after modifications: '$modifiedFirstItem'")

with

一個非擴展函數(shù):上下文對象作為參數(shù)傳遞慨仿,但是在 lambda 表達式內(nèi)部久脯,它可以作為接收者(this使用。 返回值是 lambda 表達式結(jié)果镰吆。

我們建議使用 with 來調(diào)用上下文對象上的函數(shù)帘撰,而不使用 lambda 表達式結(jié)果。 在代碼中万皿,with 可以理解為“對于這個對象摧找,執(zhí)行以下操作。

val numbers = mutableListOf("one", "two", "three")
with(numbers) {
    println("'with' is called with argument $this")
    println("It contains $size elements")
}

with 的另一個使用場景是引入一個輔助對象牢硅,其屬性或函數(shù)將用于計算一個值蹬耘。

val numbers = mutableListOf("one", "two", "three")
val firstAndLast = with(numbers) {
    "The first element is ${first()}," +
    " the last element is ${last()}"
}
println(firstAndLast)

run

上下文對象 作為接收者(this來訪問。 返回值 是 lambda 表達式結(jié)果减余。

run和with做一樣的事综苔,不過調(diào)用的方式和let一樣。

當 lambda 表達式同時包含對象初始化和返回值的計算時位岔,run 很有用如筛。

val service = MultiportService("https://example.kotlinlang.org", 80)

val result = service.run {
    port = 8080
    query(prepareRequest() + " to port $port")
}

// 同樣的代碼如果用 let() 函數(shù)來寫:
val letResult = service.let {
    it.port = 8080
    it.query(it.prepareRequest() + " to port ${it.port}")
}

除了在接收者對象上調(diào)用 run 之外,還可以將其用作非擴展函數(shù)抒抬。 非擴展 run 可以使你在需要表達式的地方執(zhí)行一個由多個語句組成的塊杨刨。

val hexNumberRegex = run {
    val digits = "0-9"
    val hexDigits = "A-Fa-f"
    val sign = "+-"

    Regex("[$sign]?[$digits$hexDigits]+")
}

for (match in hexNumberRegex.findAll("+1234 -FFFF not-a-number")) {
    println(match.value)
}

apply

上下文對象 作為接收者(this來訪問。 返回值 是上下文對象本身擦剑。

apply 的常見情況是對象配置拭嫁。這樣的調(diào)用可以理解為“將以下賦值操作應用于對象”。

val adam = Person("Adam").apply {
    age = 32
    city = "London"        
}
println(adam)

also

上下文對象作為 lambda 表達式的參數(shù)(it來訪問抓于。 返回值是上下文對象本身做粤。

also 對于執(zhí)行一些將上下文對象作為參數(shù)的操作很有用。 對于需要引用對象而不是其屬性與函數(shù)的操作捉撮,或者不想屏蔽來自外部作用域的 this 引用時怕品,請使用 also

當你在代碼中看到 also 時巾遭,可以將其理解為“并且用該對象執(zhí)行以下操作”肉康。

val numbers = mutableListOf("one", "two", "three")
numbers
    .also { println("The list elements before adding new one: $it") }
    .add("four")

函數(shù)選擇

為了幫助你選擇合適的作用域函數(shù)闯估,我們提供了它們之間的主要區(qū)別表。

函數(shù) 對象引用 返回值 是否是擴展函數(shù)
let it Lambda 表達式結(jié)果
run this Lambda 表達式結(jié)果
run - Lambda 表達式結(jié)果 不是:調(diào)用無需上下文對象
with this Lambda 表達式結(jié)果 不是:把上下文對象當做參數(shù)
apply this 上下文對象
also it 上下文對象

以下是根據(jù)預期目的選擇作用域函數(shù)的簡短指南:

  • 對一個非空(non-null)對象執(zhí)行 lambda 表達式:let
  • 將表達式作為變量引入為局部作用域中:let
  • 對象配置:apply
  • 對象配置并且計算結(jié)果:run
  • 在需要表達式的地方運行語句:非擴展的 run
  • 附加效果:also
  • 一個對象的一組函數(shù)調(diào)用:with

不同函數(shù)的使用場景存在重疊吼和,你可以根據(jù)項目或團隊中使用的特定約定選擇函數(shù)涨薪。

盡管作用域函數(shù)是使代碼更簡潔的一種方法,但請避免過度使用它們:這會降低代碼的可讀性并可能導致錯誤炫乓。避免嵌套作用域函數(shù)刚夺,同時鏈式調(diào)用它們時要小心:此時很容易對當前上下文對象及 thisit 的值感到困惑。

takeIftakeUnless

除了作用域函數(shù)外末捣,標準庫還包含函數(shù) takeIftakeUnless侠姑。這倆函數(shù)使你可以將對象狀態(tài)檢查嵌入到調(diào)用鏈中。

當以提供的謂詞在對象上進行調(diào)用時箩做,若該對象與謂詞匹配莽红,則 takeIf 返回此對象。否則返回 null邦邦。因此安吁,takeIf 是單個對象的過濾函數(shù)。反之燃辖,takeUnless如果不匹配謂詞鬼店,則返回對象,如果匹配則返回 null郭赐。該對象作為 lambda 表達式參數(shù)(it)來訪問。

val number = Random.nextInt(100)

val evenOrNull = number.takeIf { it % 2 == 0 }
val oddOrNull = number.takeUnless { it % 2 == 0 }
println("even: $evenOrNull, odd: $oddOrNull")

當在 takeIftakeUnless 之后鏈式調(diào)用其他函數(shù)确沸,不要忘記執(zhí)行空檢查或安全調(diào)用(?.)捌锭,因為他們的返回值是可為空的。

val str = "Hello"
val caps = str.takeIf { it.isNotEmpty() }?.toUpperCase()
//val caps = str.takeIf { it.isNotEmpty() }.toUpperCase() // 編譯錯誤
println(caps)

takeIftakeUnless 與作用域函數(shù)一起特別有用罗捎。 一個很好的例子是用 let 鏈接它們观谦,以便在與給定謂詞匹配的對象上運行代碼塊。 為此桨菜,請在對象上調(diào)用 takeIf豁状,然后通過安全調(diào)用(?.)調(diào)用 let。對于與謂詞不匹配的對象倒得,takeIf 返回 null泻红,并且不調(diào)用 let

fun displaySubstringPosition(input: String, sub: String) {
    input.indexOf(sub).takeIf { it >= 0 }?.let {
        println("The substring $sub is found in $input.")
        println("Its start position is $it.")
    }
}

displaySubstringPosition("010000011", "11")
displaySubstringPosition("010000011", "12")

沒有標準庫函數(shù)時霞掺,相同的函數(shù)看起來是這樣的:

fun displaySubstringPosition(input: String, sub: String) {
    val index = input.indexOf(sub)
    if (index >= 0) {
        println("The substring $sub is found in $input.")
        println("Its start position is $index.")
    }
}

displaySubstringPosition("010000011", "11")
displaySubstringPosition("010000011", "12")
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末谊路,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子菩彬,更是在濱河造成了極大的恐慌缠劝,老刑警劉巖潮梯,帶你破解...
    沈念sama閱讀 222,946評論 6 518
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異惨恭,居然都是意外死亡秉馏,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,336評論 3 399
  • 文/潘曉璐 我一進店門脱羡,熙熙樓的掌柜王于貴愁眉苦臉地迎上來萝究,“玉大人,你說我怎么就攤上這事轻黑『簦” “怎么了?”我有些...
    開封第一講書人閱讀 169,716評論 0 364
  • 文/不壞的土叔 我叫張陵氓鄙,是天一觀的道長馆揉。 經(jīng)常有香客問我,道長抖拦,這世上最難降的妖魔是什么升酣? 我笑而不...
    開封第一講書人閱讀 60,222評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮态罪,結(jié)果婚禮上噩茄,老公的妹妹穿的比我還像新娘。我一直安慰自己复颈,他們只是感情好绩聘,可當我...
    茶點故事閱讀 69,223評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著耗啦,像睡著了一般凿菩。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上帜讲,一...
    開封第一講書人閱讀 52,807評論 1 314
  • 那天衅谷,我揣著相機與錄音,去河邊找鬼似将。 笑死获黔,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的在验。 我是一名探鬼主播玷氏,決...
    沈念sama閱讀 41,235評論 3 424
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼腋舌!你這毒婦竟也來了预茄?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 40,189評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎耻陕,沒想到半個月后拙徽,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,712評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡诗宣,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,775評論 3 343
  • 正文 我和宋清朗相戀三年膘怕,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片召庞。...
    茶點故事閱讀 40,926評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡岛心,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出篮灼,到底是詐尸還是另有隱情忘古,我是刑警寧澤,帶...
    沈念sama閱讀 36,580評論 5 351
  • 正文 年R本政府宣布诅诱,位于F島的核電站髓堪,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏娘荡。R本人自食惡果不足惜干旁,卻給世界環(huán)境...
    茶點故事閱讀 42,259評論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望炮沐。 院中可真熱鬧争群,春花似錦、人聲如沸大年。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,750評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽翔试。三九已至轻要,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間遏餐,已是汗流浹背伦腐。 一陣腳步聲響...
    開封第一講書人閱讀 33,867評論 1 274
  • 我被黑心中介騙來泰國打工赢底, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留失都,地道東北人。 一個月前我還...
    沈念sama閱讀 49,368評論 3 379
  • 正文 我出身青樓幸冻,卻偏偏與公主長得像粹庞,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子洽损,可洞房花燭夜當晚...
    茶點故事閱讀 45,930評論 2 361

推薦閱讀更多精彩內(nèi)容