快速上手 Kotlin 開發系列之作用域函數(1)

本節介紹 Kotlin 中的作用域函數。

作用域函數是什麼

作用域函數是 Kotlin 內置的可以對數據做一系列變換的函數。它們與集合的操作符非常的相似，但是集合的操作符只能用於集合的數據變換，而作用域函數可以應用於所有對象，它可以對所有對象做一系列的操作。

在 Kotlin 中常用的作用域函數有五個：

run {...}
with(T) {...}
let {...}
apply {...}
also {...}

作用域函數的使用

還是以代碼示例的形式講述，開始前先做一個數據類 User：

data class User(var name: String)
fun main() {
    val user = User("Changer0")
    //...
}

let 與 run

let 與 run 都會返回閉包的執行結果，區別在於 let 有閉包參數，而 run 沒有閉包參數，其中 run 可以通過 this 來獲取是誰來調用 run 的，也就是說 this 指代了外層的調用對象。這是他們的唯一區別。

val letResult = user.let { user: User -> "let: ${user.name}" }
println(letResult)
val runResult = user.run {"let: ${this.name}" }
println(runResult)

特別的，對於 let 函數，根據 Kotlin 的 Lambda 規則如果只有一個參數時可以省略參數不寫，使用 it 來代替：

val letResult = user.let { "let: ${it.name}" }

also 與 apply

also 與 apply 都不返回閉包的執行結果，與上面類似，區別在於 also 有閉包參數，而 apply 沒有閉包參數。

user.also {
    println("also:${it.name}")
}
user.apply {
    println("apply:${this.name}")
}

那他們閉包的返回值結果是什麼呢？

打開該作用域函數的聲明發現，其實這個作用域函數是對泛型 T 做的擴展函數，對於 also/apply 返回的都是它本身：

public inline fun <T> T.also(block: (T) -> Unit): T {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    block(this)
    return this
}

也就是說，我們可以連續的去調用這個作用域函數，適合鏈式操作某個對象：

user.also {
    println("also:${it.name}")
}.apply {
    println("apply:${this.name}")
}.name

takeIf 與 takeUnless

takeIf 與 takeUnless 主要是用於判斷。

我們看下 takeIf 作用域函數，發現閉包只能返回一個 Boolean 類型的值，並且會根據你傳入的 Lambda 表達式的執行結果來做判斷，如果執行結果爲 true 則返回當前對象，否則會返回 null，這也就是爲什麼 takeIf 的返回值爲 T? 。

public inline fun <T> T.takeIf(predicate: (T) -> Boolean): T? {
    contract {
        callsInPlace(predicate, InvocationKind.EXACTLY_ONCE)
    }
    return if (predicate(this)) this else null
}

通常在使用時，在閉包後面使用 ?. 繼續執行該對象不爲空時的代碼，後面通過 ?: 執行該對象爲空時的代碼：

user.takeIf { it.name.length > 0}?.also { println("name:${it.name}") } ?: println("name 爲空")

takeUnless 則與 takeIf 完全相反，如果 Lambda 表達式執行結果爲 false 返回當前對象，否則返回 null：

public inline fun <T> T.takeUnless(predicate: (T) -> Boolean): T? {
    contract {
        callsInPlace(predicate, InvocationKind.EXACTLY_ONCE)
    }
    return if (!predicate(this)) this else null
}

repeat

repeat 函數在之前已經提到過，其實是對 for-in 形式的循環做的封裝，不再做具體的介紹：

public inline fun repeat(times: Int, action: (Int) -> Unit) {
    contract { callsInPlace(action) }

    for (index in 0 until times) {
        action(index)
    }
}

with

查看 with 函數發現與其他作用域函數不同，它不是擴展函數，而是一個頂級的函數，傳入參數 receiver 和 閉包 block，返回 receiver 執行閉包的結果，返回值類型爲泛型 R。

public inline fun <T, R> with(receiver: T, block: T.() -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return receiver.block()
}

with 一般用於對某個對象的整體賦值，這點在 Android 開發中尤其突出，例如對某個 View 屬性的整體賦值，可以使用 with。

with(user) {
    this.name = "Changer1007"
}

以上就是本節內容，歡迎大家關注~