Null 安全性
在初學者導覽中,你學習了如何在程式碼中處理 null 值。本章節將介紹 Null 安全性功能的常見使用案例,以及如何充分利用它們。
智慧轉換與安全轉換
Kotlin 有時可以在沒有明確宣告的情況下推論出型別。當你指示 Kotlin 將變數或物件視為屬於特定型別時,這個過程稱為型別轉換 (casting)。當型別被自動轉換時(例如在推論出型別時),這被稱為智慧轉換 (smart casting)。
is 與 !is 運算子
在我們探索轉換如何運作之前,讓我們先看看如何檢查物件是否具有特定型別。為此,你可以將 is 與 !is 運算子與 when 或 if 條件運算式搭配使用:
is檢查物件是否屬於該型別,並傳回布林值。!is檢查物件是否不屬於該型別,並傳回布林值。
例如:
fun printObjectType(obj: Any) {
when (obj) {
is Int -> println("It's an Integer with value $obj")
!is Double -> println("It's NOT a Double")
else -> println("Unknown type")
}
}
fun main() {
val myInt = 42
val myDouble = 3.14
val myList = listOf(1, 2, 3)
// 型別為 Int
printObjectType(myInt)
// It's an Integer with value 42
// 型別為 List,因此它不是 Double。
printObjectType(myList)
// It's NOT a Double
// 型別為 Double,因此觸發了 else 分支。
printObjectType(myDouble)
// Unknown type
}你已經在 Open 與其他特殊類別 章節中看過如何將 when 條件運算式與 is 及 !is 運算子搭配使用的範例。
as 與 as? 運算子
若要明確將物件轉換為任何其他型別,請使用 as 運算子。這包括從可為 null 的型別轉換為其不可為 null 的對應型別。如果無法轉換,程式會在執行期當機。這就是為什麼它被稱為不安全轉換運算子。
fun main() {
val a: String? = null
val b = a as String
// 在執行期觸發錯誤
print(b)
}若要明確將物件轉換為不可為 null 的型別,但在失敗時傳回 null 而非拋出錯誤,請使用 as? 運算子。由於 as? 運算子在失敗時不會觸發錯誤,因此它被稱為安全運算子。
fun main() {
val a: String? = null
val b = a as? String
// 傳回 null 值
print(b)
// null
}你可以將 as? 運算子與 Elvis 運算子 ?: 結合,將多行程式碼縮減為一行。例如,以下 calculateTotalStringLength() 函式計算混合清單中所提供的所有字串的總長度:
fun calculateTotalStringLength(items: List<Any>): Int {
var totalLength = 0
for (item in items) {
totalLength += if (item is String) {
item.length
} else {
0 // 非 String 項目則加上 0
}
}
return totalLength
}該範例:
- 使用
totalLength變數作為計數器。 - 使用
for迴圈逐一查看清單中的每個項目。 - 使用
if和is運算子檢查當前項目是否為字串:- 如果是,則將該字串的長度加到計數器中。
- 如果不是,則計數器不遞增。
- 傳回
totalLength變數的最終值。
這段程式碼可以縮減為:
fun calculateTotalStringLength(items: List<Any>): Int {
return items.sumOf { (it as? String)?.length ?: 0 }
}該範例使用 .sumOf() 擴充函式,並提供一個 Lambda 運算式,該運算式:
- 針對清單中的每個項目,使用
as?安全轉換為String。 - 若該呼叫未傳回
null值,則使用安全呼叫?.來存取length屬性。 - 若安全呼叫傳回
null值,則使用 Elvis 運算子?:傳回0。
Null 值與集合
在 Kotlin 中,處理集合通常涉及處理 null 值並篩選掉不需要的元素。Kotlin 提供了實用的函式,讓你在使用 List、Set、Map 及其他類型的集合時,能夠編寫出乾淨、高效且具備 Null 安全性的程式碼。
若要從清單中篩選掉 null 值,請使用 filterNotNull() 函式:
fun main() {
val emails: List<String?> = listOf("alice@example.com", null, "bob@example.com", null, "carol@example.com")
val validEmails = emails.filterNotNull()
println(validEmails)
// [alice@example.com, bob@example.com, carol@example.com]
}如果你希望在建立清單時直接篩選掉 null 值,請使用 listOfNotNull() 函式:
fun main() {
val serverConfig = mapOf(
"appConfig.json" to "App Configuration",
"dbConfig.json" to "Database Configuration"
)
val requestedFile = "appConfig.json"
val configFiles = listOfNotNull(serverConfig[requestedFile])
println(configFiles)
// [App Configuration]
}在這兩個範例中,如果所有項目都是 null 值,則會傳回一個空清單。
Kotlin 也提供了可用於在集合中尋找值的函式。如果找不到值,它們會傳回 null 值,而不是觸發錯誤:
maxOrNull()尋找最大值。如果不存在,則傳回null值。minOrNull()尋找最小值。如果不存在,則傳回null值。
例如:
fun main() {
// 一週內記錄的溫度
val temperatures = listOf(15, 18, 21, 21, 19, 17, 16)
// 尋找該週的最高溫度
val maxTemperature = temperatures.maxOrNull()
println("Highest temperature recorded: ${maxTemperature ?: "No data"}")
// Highest temperature recorded: 21
// 尋找該週的最低溫度
val minTemperature = temperatures.minOrNull()
println("Lowest temperature recorded: ${minTemperature ?: "No data"}")
// Lowest temperature recorded: 15
}此範例使用 Elvis 運算子 ?:,在函式傳回 null 值時輸出替代陳述式。
maxOrNull() 和 minOrNull() 函式專為不包含 null 值的集合所設計。否則,你將無法區分是函式找不到所需的值,還是它找到了 null 值。
你可以將 singleOrNull() 函式與 Lambda 運算式搭配使用,以尋找符合條件的單一項目。如果不存在或有多個相符的項目,該函式將傳回 null 值:
fun main() {
// 一週內記錄的溫度
val temperatures = listOf(15, 18, 21, 21, 19, 17, 16)
// 檢查是否剛好只有一天為 30 度
val singleHotDay = temperatures.singleOrNull{ it == 30 }
println("Single hot day with 30 degrees: ${singleHotDay ?: "None"}")
// Single hot day with 30 degrees: None
}singleOrNull() 函式專為不包含 null 值的集合所設計。
某些函式使用 Lambda 運算式來轉換集合,並在無法達成目的時傳回 null 值。
若要使用 Lambda 運算式轉換集合並傳回第一個非 null 的值,請使用 firstNotNullOfOrNull() 函式。如果不存在此類值,該函式將傳回 null 值:
fun main() {
data class User(val name: String?, val age: Int?)
val users = listOf(
User(null, 25),
User("Alice", null),
User("Bob", 30)
)
val firstNonNullName = users.firstNotNullOfOrNull { it.name }
println(firstNonNullName)
// Alice
}若要使用 Lambda 運算式依序處理集合中的每個項目並產生累加值(或者在集合為空時傳回 null 值),請使用 reduceOrNull() 函式:
fun main() {
// 購物車中商品的價格
val itemPrices = listOf(20, 35, 15, 40, 10)
// 使用 reduceOrNull() 函式計算總價
val totalPrice = itemPrices.reduceOrNull { runningTotal, price -> runningTotal + price }
println("Total price of items in the cart: ${totalPrice ?: "No items"}")
// Total price of items in the cart: 120
val emptyCart = listOf<Int>()
val emptyTotalPrice = emptyCart.reduceOrNull { runningTotal, price -> runningTotal + price }
println("Total price of items in the empty cart: ${emptyTotalPrice ?: "No items"}")
// Total price of items in the empty cart: No items
}此範例同樣使用 Elvis 運算子 ?:,在函式傳回 null 值時輸出替代陳述式。
reduceOrNull() 函式專為不包含 null 值的集合所設計。
探索 Kotlin 的標準程式庫,以尋找更多可用於讓程式碼更安全的函式。
提早回傳與 Elvis 運算子
在初學者導覽中,你學習了如何使用提早回傳來停止函式在特定點之後繼續執行。你可以將 Elvis 運算子 ?: 與提早回傳搭配使用,以檢查函式中的前置條件。這種方法是保持程式碼簡潔的絕佳方式,因為你不需要使用巢狀檢查。降低程式碼的複雜度也能使其更易於維護。例如:
data class User(
val id: Int,
val name: String,
// 好友使用者 ID 清單
val friends: List<Int>
)
// 取得使用者好友數量的函式
fun getNumberOfFriends(users: Map<Int, User>, userId: Int): Int {
// 檢索使用者,若未找到則傳回 -1
val user = users[userId] ?: return -1
// 傳回好友數量
return user.friends.size
}
fun main() {
// 建立一些範例使用者
val user1 = User(1, "Alice", listOf(2, 3))
val user2 = User(2, "Bob", listOf(1))
val user3 = User(3, "Charlie", listOf(1))
// 建立使用者的 Map
val users = mapOf(1 to user1, 2 to user2, 3 to user3)
println(getNumberOfFriends(users, 1))
// 2
println(getNumberOfFriends(users, 2))
// 1
println(getNumberOfFriends(users, 4))
// -1
}在此範例中:
- 有一個
User資料類別,包含使用者的id、name以及好友清單屬性。 getNumberOfFriends()函式:- 接受一個包含
User執行個體的 Map 以及一個整數型別的使用者 ID。 - 使用提供的使用者 ID 存取
User執行個體 Map 中的值。 - 若 Map 中的值為
null,則使用 Elvis 運算子提早結束函式並傳回值-1。 - 將從 Map 中找到的值指派給
user變數。 - 透過使用
size屬性傳回使用者好友清單中的好友數量。
- 接受一個包含
main()函式:- 建立三個
User執行個體。 - 建立這些
User執行個體的 Map 並將其指派給users變數。 - 在
users變數上呼叫getNumberOfFriends()函式並傳入值1和2,分別為"Alice"傳回兩位好友,為"Bob"傳回一位好友。 - 在
users變數上呼叫getNumberOfFriends()函式並傳入值4,這會觸發提早回傳值-1。
- 建立三個
你可能會注意到,如果不使用提早回傳,程式碼可以更為簡潔。然而,這種做法需要多個安全呼叫,因為 users[userId] 可能會傳回 null 值,進而使程式碼的可讀性略微降低:
fun getNumberOfFriends(users: Map<Int, User>, userId: Int): Int {
// 檢索使用者,若未找到則傳回 -1
return users[userId]?.friends?.size ?: -1
}雖然這個範例只使用 Elvis 運算子檢查了一個條件,但你可以新增多個檢查來涵蓋任何關鍵的錯誤路徑。搭配 Elvis 運算子的提早回傳可以避免程式執行不必要的工作,並在偵測到 null 值或無效情況時立即停止,從而使程式碼更安全。
如需深入了解如何在程式碼中使用 return,請參閱返回與跳轉。
練習
使用安全轉換與 Elvis 運算子驗證使用者資料
你正在為一個應用程式開發通知系統,使用者可以在其中啟用或停用不同類型的通知。請完成 getNotificationPreferences() 函式,以達到以下要求:
validUser變數使用as?運算子檢查user是否為User類別的執行個體。如果不是,則傳回一個空清單。userName變數使用 Elvis?:運算子,確保使用者名稱若為null則預設為"Guest"。- 最終的 return 陳述式使用
.takeIf()函式,僅在啟用電子郵件與簡訊通知偏好設定時才將其包含進去。 main()函式成功執行並印出預期的輸出。
takeIf() 函式會在給定條件為 true 時傳回原始值,否則傳回 null。例如:
fun main() {
// 使用者已登入
val userIsLoggedIn = true
// 使用者擁有有效的工作階段
val hasSession = true
// 若使用者已登入且擁有有效的工作階段,
// 則授予存取儀表板的權限
val canAccessDashboard = userIsLoggedIn.takeIf { hasSession }
println(canAccessDashboard ?: "Access denied")
// true
}data class User(val name: String?)
fun getNotificationPreferences(user: Any, emailEnabled: Boolean, smsEnabled: Boolean): List<String> {
val validUser = // 在此處編寫你的程式碼
val userName = // 在此處編寫你的程式碼
return listOfNotNull( /* 在此處編寫你的程式碼 */)
}
fun main() {
val user1 = User("Alice")
val user2 = User(null)
val invalidUser = "NotAUser"
println(getNotificationPreferences(user1, emailEnabled = true, smsEnabled = false))
// [Email Notifications enabled for Alice]
println(getNotificationPreferences(user2, emailEnabled = false, smsEnabled = true))
// [SMS Notifications enabled for Guest]
println(getNotificationPreferences(invalidUser, emailEnabled = true, smsEnabled = true))
// []
}範例解答 {...}
data class User(val name: String?)
fun getNotificationPreferences(user: Any, emailEnabled: Boolean, smsEnabled: Boolean): List<String> {
val validUser = user as? User ?: return emptyList()
val userName = validUser.name ?: "Guest"
return listOfNotNull(
"Email Notifications enabled for $userName".takeIf { emailEnabled },
"SMS Notifications enabled for $userName".takeIf { smsEnabled }
)
}
fun main() {
val user1 = User("Alice")
val user2 = User(null)
val invalidUser = "NotAUser"
println(getNotificationPreferences(user1, emailEnabled = true, smsEnabled = false))
// [Email Notifications enabled for Alice]
println(getNotificationPreferences(user2, emailEnabled = false, smsEnabled = true))
// [SMS Notifications enabled for Guest]
println(getNotificationPreferences(invalidUser, emailEnabled = true, smsEnabled = true))
// []
}使用 singleOrNull() 尋找單一有效訂閱
你正在為一個訂閱制的串流服務工作,使用者可以擁有多個訂閱,但一次只能有一個處於有效狀態。請完成 getActiveSubscription() 函式,使其搭配述詞使用 singleOrNull() 函式,若存在多個有效訂閱,則傳回 null 值:
data class Subscription(val name: String, val isActive: Boolean)
fun getActiveSubscription(subscriptions: List<Subscription>): Subscription? = TODO("Replace the TODO() function")
fun main() {
val userWithPremiumPlan = listOf(
Subscription("Basic Plan", false),
Subscription("Premium Plan", true)
)
val userWithConflictingPlans = listOf(
Subscription("Basic Plan", true),
Subscription("Premium Plan", true)
)
println(getActiveSubscription(userWithPremiumPlan))
// Subscription(name=Premium Plan, isActive=true)
println(getActiveSubscription(userWithConflictingPlans))
// null
}範例解答 1 {...}
data class Subscription(val name: String, val isActive: Boolean)
fun getActiveSubscription(subscriptions: List<Subscription>): Subscription? {
return subscriptions.singleOrNull { subscription -> subscription.isActive }
}
fun main() {
val userWithPremiumPlan = listOf(
Subscription("Basic Plan", false),
Subscription("Premium Plan", true)
)
val userWithConflictingPlans = listOf(
Subscription("Basic Plan", true),
Subscription("Premium Plan", true)
)
println(getActiveSubscription(userWithPremiumPlan))
// Subscription(name=Premium Plan, isActive=true)
println(getActiveSubscription(userWithConflictingPlans))
// null
}範例解答 2 {...}
data class Subscription(val name: String, val isActive: Boolean)
fun getActiveSubscription(subscriptions: List<Subscription>): Subscription? =
subscriptions.singleOrNull { it.isActive }
fun main() {
val userWithPremiumPlan = listOf(
Subscription("Basic Plan", false),
Subscription("Premium Plan", true)
)
val userWithConflictingPlans = listOf(
Subscription("Basic Plan", true),
Subscription("Premium Plan", true)
)
println(getActiveSubscription(userWithPremiumPlan))
// Subscription(name=Premium Plan, isActive=true)
println(getActiveSubscription(userWithConflictingPlans))
// null
}使用 mapNotNull() 篩選活躍的使用者名稱
你正在為一個社群媒體平台工作,使用者擁有使用者名稱和帳號狀態。你希望查看目前處於活躍狀態的使用者名稱清單。請完成 getActiveUsernames() 函式,讓 mapNotNull() 函式 包含一個述詞:若使用者處於活躍狀態則傳回使用者名稱,若否則傳回 null 值:
data class User(val username: String, val isActive: Boolean)
fun getActiveUsernames(users: List<User>): List<String> {
return users.mapNotNull { /* 在此處編寫你的程式碼 */ }
}
fun main() {
val allUsers = listOf(
User("alice123", true),
User("bob_the_builder", false),
User("charlie99", true)
)
println(getActiveUsernames(allUsers))
// [alice123, charlie99]
}就像在練習 1 中一樣,你可以在檢查使用者是否處於活躍狀態時使用 takeIf() 函式。
範例解答 1 {...}
data class User(val username: String, val isActive: Boolean)
fun getActiveUsernames(users: List<User>): List<String> {
return users.mapNotNull { user ->
if (user.isActive) user.username else null
}
}
fun main() {
val allUsers = listOf(
User("alice123", true),
User("bob_the_builder", false),
User("charlie99", true)
)
println(getActiveUsernames(allUsers))
// [alice123, charlie99]
}範例解答 2 {...}
data class User(val username: String, val isActive: Boolean)
fun getActiveUsernames(users: List<User>): List<String> =
users.mapNotNull { user -> user.username.takeIf { user.isActive } }
fun main() {
val allUsers = listOf(
User("alice123", true),
User("bob_the_builder", false),
User("charlie99", true)
)
println(getActiveUsernames(allUsers))
// [alice123, charlie99]
}使用提早回傳與 Elvis 運算子驗證庫存
你正在為電子商務平台的庫存管理系統工作。在處理銷售之前,你需要根據可用庫存檢查所請求的商品數量是否有效。
請完成 validateStock() 函式,使其使用提早回傳與 Elvis 運算子(適用時)來檢查是否滿足以下情況:
requested變數為null。available變數為null。requested變數為負值。requested變數中的數量大於available變數中的數量。
在上述所有情況下,函式都必須提早回傳值 -1。
fun validateStock(requested: Int?, available: Int?): Int {
// 在此處編寫你的程式碼
}
fun main() {
println(validateStock(5,10))
// 5
println(validateStock(null,10))
// -1
println(validateStock(-2,10))
// -1
}範例解答 {...}
fun validateStock(requested: Int?, available: Int?): Int {
val validRequested = requested ?: return -1
val validAvailable = available ?: return -1
if (validRequested < 0) return -1
if (validRequested > validAvailable) return -1
return validRequested
}
fun main() {
println(validateStock(5,10))
// 5
println(validateStock(null,10))
// -1
println(validateStock(-2,10))
// -1
}