引言
什么是作用域函數(shù)？肯定有不少人不知道這玩意兒是啥六孵，但是了解過kotlin基礎(chǔ)知識的話基本上都知道kotlin的空安全思杯，那么在處理空安全時有這么一段例子代碼，大家應(yīng)該都看過掌桩。
val listWithNulls: List<String?> = listOf("Kotlin", null)
for (item in listWithNulls) {
item?.let { println(it) } // 輸出 Kotlin 并忽略 null
}
// 輸出結(jié)果
// Kotlin
for循環(huán)中的let就是我們今天主角：作用域函數(shù)
簡介
引用一下官方文檔對作用域函數(shù)的描述：
The Kotlin standard library contains several functions whose sole purpose is to execute a block of code within the context of an object. When you call such a function on an object with a lambda expression provided, it forms a temporary scope. In this scope, you can access the object without its name. Such functions are called scope functions. There are five of them:
let,run,with,apply, andalso.大致是下面的意思：
Kotlin標(biāo)準(zhǔn)庫包含幾個函數(shù)，它們的唯一目的是在對象的上下文中執(zhí)行代碼塊姑食。當(dāng)您對提供lambda表達(dá)式的對象調(diào)用這樣一個函數(shù)時波岛，它將形成一個臨時作用域。在這個范圍內(nèi)音半，您可以訪問沒有名稱的對象则拷。這些函數(shù)稱為作用域函數(shù)。常見的五個如下: let曹鸠、run煌茬、with、apply和also彻桃。
說了這么多大家估計大家還是有點懵逼坛善，到底有啥用？
舉個栗子的時候到了邻眷。
栗子
// 創(chuàng)建畫筆眠屎，并設(shè)置一些基礎(chǔ)屬性
val mRangTextPaint = Paint()
mRangTextPaint.isAntiAlias = true
mRangTextPaint.color = Color.parseColor("#999999")
mRangTextPaint.textSize = sp(8f).toFloat()
// apply作用域函數(shù)來優(yōu)化一下
val mRangTextPaint = Paint().apply {
isAntiAlias = true
color = Color.parseColor("#999999")
textSize = sp(8f).toFloat()
}
從上面的栗子中可以看出使用了apply后的優(yōu)點：
- 省略了冗余的
mRangTextPaint.(想想一下，我們要設(shè)置七八個屬性, 是不是省了不少...) - 代碼一目了然耗溜，很容易就能看出
{}中的代碼是給mRangTextPaint設(shè)置屬性的
詳細(xì)介紹
作用域函數(shù)猛地一看很相似组力，但是他們有以下兩個主要區(qū)別：
- 引用上下文對象的方式
- 返回值
| 作用域函數(shù) | Object reference | Return value |
|---|---|---|
| run | this | Lambda result |
| with | this | Lambda result |
| apply | this | 上下文對象 |
| let | it | Lambda result |
| also | it | 上下文對象 |
引用方式
在作用域函數(shù)的lambda表達(dá)式內(nèi)，上下文對象可以使用一個簡短的引用來使用（不使用上下文對象實際的變量名）抖拴。作用域函數(shù)使用以下兩種方法之一來訪問上下文對象：作為lambda接收器（this）或作為lambda參數(shù)（it）燎字。
this
run、with 和 apply 將上下文對象作為lambda表達(dá)式的receiver（通過關(guān)鍵字this）阿宅。因此在lambda表達(dá)式中候衍，上下文對象就像在普通的類函數(shù)中一樣可用。大多數(shù)情況下洒放，當(dāng)你訪問上下文對象的屬性或者方法時是可以直接省略this關(guān)鍵字蛉鹿，從而使代碼看著更加的簡短。
但是要注意的是往湿，忽略了this關(guān)鍵字妖异，就很難區(qū)分接收方成員和外部對象或函數(shù)（這里可能有點難理解惋戏，下面舉個栗子就能明白了）。
fun main() {
val person = Person("tom")
Person(name = "洛城夜雨").apply {// this:Person
age = 26
person.age = 28
city = "洛陽"
print(person)
}.also {// it:Person
print(it)
}
}
data class Person(val name: String, var age: Int = 20, var city: String = "北京")
上面的栗子他膳，apply函數(shù)中的 person.age = 28响逢、 print(person) 這兩句話其實跟調(diào)用apply的上下文對象完全沒關(guān)系，但是看起來相當(dāng)?shù)幕靵y棕孙。
因此舔亭，這里建議將上下文對象作為接收者（this）的這類作用域函數(shù)用于 調(diào)用其函數(shù) 或者 賦值屬性。
it
let 和 also 函數(shù)讓上下文對象作為lambda表達(dá)式的參數(shù)蟀俊。當(dāng)參數(shù)名沒有指定時钦铺，則可以通過隱式默認(rèn)參數(shù)名稱來訪問上下文對象。劃重點：當(dāng)使用 it 調(diào)用上下文對象的函數(shù)或操作屬性時肢预，不能像 this 那樣可以忽略關(guān)鍵字矛洞。
舉個栗子：
fun main() {
Person(name = "洛城夜雨").also {
print(it)
}
// 將上下文對象作為參數(shù)時，您可以為范圍內(nèi)的上下文對象提供自定義名稱烫映。
Person(name = "湯姆").also { tom ->
print(tom)
}
}
返回值
作用域函數(shù)的返回值分一下兩種：
- 上下文對象本身
- lambda表達(dá)式的結(jié)果
舉個栗子
fun main() {
val tom = Person(name = "Tom").apply {
age = 29
city = "New York"
}
println(tom)
val p = Person(name = "Tom").run {
age = 29
city = "New York"
"$name $age $city"
}
println(p)
}
輸出結(jié)果：
Person(name=Tom, age=29, city=New York)
Tom 29 New York
總結(jié)
-
apply和also的返回值是上下文對象本身缚甩，因此他們可以實現(xiàn)鏈?zhǔn)秸{(diào)用。 -
let窑邦、run和with的返回值是Lambda表達(dá)式的結(jié)果，因此他們更加靈活壕探，不僅可以返回其他變量冈钦，也可以通過返回this來實現(xiàn)返回上下文對象本身。 -
let李请、run和with不指定返回值時瞧筛，返回值其實是kotlin.Unit類型
函數(shù)使用場景
很多人接觸到作用域函數(shù)的時候，最頭疼的問題不是不會用导盅，而是不知道如何選擇合適的作用域函數(shù)较幌。之所以出現(xiàn)這種情況，是因為其實作用域函數(shù)在多數(shù)情況下是可以互換的白翻，因此官方文檔也給我們推薦了各個函數(shù)常見的使用場景乍炉。
函數(shù)選擇
栗子代碼
package com.zy
val students = run {
// 頂級初始化
mutableListOf<Person>().apply {
add(Person("Abel"))
add(Person("Ben"))
add(Person("Colin"))
add(Person("Denny"))
add(Person("Frank"))
}
}
fun main() {
// 鏈?zhǔn)秸{(diào)用
students.apply {
// 對象配置
add(Person(name = "Cecil", city = "LuoYang"))
}.filter {
it.name.startsWith("C")
}.also {
// 附加操作
println("名字以字母C開頭的學(xué)生人數(shù)為${it.size}")
}.forEach { person ->
val separator = if (person.city == null) "\n" else ""
print("name = ${person.name} $separator")
person.city?.let {
// 空檢查
print(", city = ${it.toLowerCase()}")
}
}
println()
students.last().let { lastStudent ->
// 上下文對象以lastStudent為參數(shù)名，作為局部范圍中的變量引入
val name = if (lastStudent.name.length < 10) "[${lastStudent.name}]" else lastStudent.name
println("列表中最后一個學(xué)生是：$name")
}
students.run {
// 對象配置 + 結(jié)果運(yùn)算
add(Person(name = "Mark", city = "Boston"))
"students.size = $size"
}.also(::println)
// 調(diào)用列表中最后一個學(xué)生的 sayHello 和 introduceYourself 方法
with(students.last()){
sayHello()
introduceYourself()
}
}
class Person(val name: String, var city: String? = null) {
fun sayHello() {
println("Hello everyone!")
}
fun introduceYourself() {
println("My name is $name and I'm from $city.")
}
}
