Skip to content

Null安全 ​

初級ツアーでは、コード内で null 値を処理する方法を学びました。この章では、Null安全(Null safety)機能の一般的なユースケースと、それらを最大限に活用する方法について説明します。

スマートキャストと安全なキャスト ​

Kotlinでは、明示的に宣言しなくても型を推論できる場合があります。変数やオブジェクトを特定の型に属しているかのように扱うようKotlinに指示する処理を、キャスト(casting)と呼びます。型が推論された場合のように自動的にキャストされる場合、それはスマートキャスト(smart casting)と呼ばれます。

is および !is 演算子 ​

キャストがどのように機能するかを見る前に、オブジェクトが特定の型であるかどうかを確認する方法を見てみましょう。これには、when や if 条件式とともに is および !is 演算子を使用できます。

  • is は、オブジェクトがその型であるかどうかをチェックし、Boolean値を返します。
  • !is は、オブジェクトがその型ではないかどうかをチェックし、Boolean値を返します。

例:

kotlin
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
}

when 条件式を is および !is 演算子とともに使用する例は、オープンクラスとその他の特殊なクラスの章ですでに確認しました。

as および as? 演算子 ​

オブジェクトを別の型に明示的にキャストするには、as 演算子を使用します。これには、null許容型からその非null型へのキャストも含まれます。キャストが不可能な場合、プログラムは実行時(at runtime)にクラッシュします。そのため、これは安全ではない(unsafe)キャスト演算子と呼ばれます。

kotlin
fun main() {
    val a: String? = null
    val b = a as String

    // 実行時エラーが発生
    print(b)
}

オブジェクトを非null型に明示的にキャストしつつ、失敗時にエラーをスローする代わりに null を返したい場合は、as? 演算子を使用します。as? 演算子は失敗してもエラーを発生させないため、安全な(safe)演算子と呼ばれます。

kotlin
fun main() {
    val a: String? = null
    val b = a as? String

    // null 値を返す
    print(b)
    // null
}

as? 演算子をElvis演算子 ?: と組み合わせることで、複数行のコードを1行に短縮できます。たとえば、次の calculateTotalStringLength() 関数は、混在したリストに含まれるすべての文字列の長さの合計を計算します。

kotlin
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 変数の最終的な値を返します。

このコードは次のように短縮できます:

kotlin
fun calculateTotalStringLength(items: List<Any>): Int {
    return items.sumOf { (it as? String)?.length ?: 0 }
}

この例では .sumOf() 拡張関数を使用し、以下を行うラムダ式を渡しています:

  • リスト内の各要素に対して、as? を使用して String への安全なキャストを実行します。
  • 安全な呼び出し ?. を使用して、呼び出し結果が null でない場合に length プロパティにアクセスします。
  • 安全な呼び出しが null を返した場合に、Elvis演算子 ?: を使用して 0 を返します。

Null値とコレクション ​

Kotlinでは、コレクションを扱う際に null 値の処理や不要な要素のフィルタリングが必要になることがよくあります。Kotlinには、リスト、セット、マップなどのコレクションを操作する際に、クリーンで効率的かつNull安全なコードを書くための便利な関数が用意されています。

リストから null 値をフィルタリングするには、filterNotNull() 関数を使用します:

kotlin
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() 関数を使用します:

kotlin
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 値を返します。

例:

kotlin
fun main() {
    // 1週間にわたって記録された気温
    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
}

この例では、関数が null 値を返した場合に出力する文を指定するためにElvis演算子 ?: を使用しています。

maxOrNull() および minOrNull() 関数は、null 値を含まないコレクションで使用するように設計されています。そうでない場合、関数が目的の値を見つけられなかったのか、それとも null 値を見つけたのかを区別できないためです。

ラムダ式とともに singleOrNull() 関数を使用すると、条件に一致する単一の要素を検索できます。一致する要素が存在しないか、複数存在する場合、この関数は null 値を返します:

kotlin
fun main() {
    // 1週間にわたって記録された気温
    val temperatures = listOf(15, 18, 21, 21, 19, 17, 16)

    // ちょうど30度の日が1日だけあったかチェック
    val singleHotDay = temperatures.singleOrNull{ it == 30 }
    println("Single hot day with 30 degrees: ${singleHotDay ?: "None"}")
    // Single hot day with 30 degrees: None
}

singleOrNull() 関数は、null 値を含まないコレクションで使用するように設計されています。

一部の関数は、ラムダ式を使用してコレクションを変換し、目的を果たせない場合には null 値を返します。

ラムダ式でコレクションを変換し、null でない最初の値を返すには、firstNotNullOfOrNull() 関数を使用します。該当する値が存在しない場合、この関数は null 値を返します:

kotlin
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
}

ラムダ式を使用してコレクションの各要素を順次処理し、累積値を作成する(またはコレクションが空の場合は null 値を返す)には、reduceOrNull() 関数を使用します:

kotlin
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
}

この例でも、関数が null 値を返した場合に出力する文を指定するためにElvis演算子 ?: を使用しています。

reduceOrNull() 関数は、null 値を含まないコレクションで使用するように設計されています。

コードをより安全にするために使用できる関数については、Kotlinの標準ライブラリを調べてみてください。

アーリーリターンとElvis演算子 ​

初級ツアーでは、ある時点以降の関数の処理を停止するためにアーリーリターン(early return)を使用する方法を学びました。Elvis演算子 ?: をアーリーリターンと組み合わせて使用することで、関数内の事前条件をチェックできます。このアプローチはネストしたチェックを使用する必要がないため、コードを簡潔に保つ優れた方法です。コードの複雑さが軽減されるため、メンテナンスも容易になります。例:

kotlin
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))

    // ユーザーのマップを作成
    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
}

この例では:

  • ユーザーの id、name、および友達のリストのプロパティを持つ User データクラスがあります。
  • getNumberOfFriends() 関数は:
    • User インスタンスのマップと、整数としてのユーザーIDを受け取ります。
    • 指定されたユーザーIDで User インスタンスのマップの値にアクセスします。
    • マップの値が null 値である場合、Elvis演算子を使用して値 -1 で関数から早期リターン(アーリーリターン)します。
    • マップから見つかった値を user 変数に代入します。
    • size プロパティを使用して、ユーザーの友達リスト内の友達の数を返します。
  • main() 関数は:
    • 3つの User インスタンスを作成します。
    • これらの User インスタンスのマップを作成し、users 変数に代入します。
    • users 変数に対して値 1 および 2 で getNumberOfFriends() 関数を呼び出し、"Alice" には2人の友達、"Bob" には1人の友達を返します。
    • users 変数に対して値 4 で getNumberOfFriends() 関数を呼び出し、値 -1 で早期リターンをトリガーします。

アーリーリターンを使わなくてもコードをより簡潔に書けることに気づくかもしれません。しかし、そのアプローチでは users[userId] が null 値を返す可能性があるため、複数の安全な呼び出しが必要になり、コードがわずかに読みにくくなります:

kotlin
fun getNumberOfFriends(users: Map<Int, User>, userId: Int): Int {
    // ユーザーを取得、見つからない場合は -1 を返す
    return users[userId]?.friends?.size ?: -1
}

この例ではElvis演算子で1つの条件のみをチェックしていますが、クリティカルなエラーパスをカバーするために複数のチェックを追加することもできます。Elvis演算子を使用したアーリーリターンは、プログラムが不要な処理を行うのを防ぎ、null 値や無効なケースが検出されたらすぐに停止することで、コードをより安全にします。

コード内で return を使用する方法の詳細については、リターンとジャンプを参照してください。

演習 ​

安全なキャストとElvis演算子でユーザーデータを検証する

あなたは、ユーザーがさまざまな種類の通知を有効または無効にできるアプリの通知システムを開発しています。 次の条件を満たすように getNotificationPreferences() 関数を完成させてください:

  1. validUser 変数で as? 演算子を使用して、user が User クラスのインスタンスであるかどうかをチェックします。そうでない場合は、空のリストを返します。
  2. userName 変数でElvis ?: 演算子を使用して、ユーザーの名前が null の場合はデフォルトで "Guest" になるようにします。
  3. 最後のreturn文では、.takeIf() 関数を使用して、有効になっている場合にのみメールおよびSMSの通知設定を含めます。
  4. main() 関数が正常に実行され、期待される出力が表示されるようにします。

takeIf() 関数は、指定された条件がtrueの場合は元の値を返し、 そうでない場合は null を返します。例:

kotlin
fun main() {
    // ユーザーがログインしている
    val userIsLoggedIn = true
    // ユーザーにアクティブなセッションがある
    val hasSession = true

    // ユーザーがログインしており、かつアクティブなセッションがある場合に
    // ダッシュボードへのアクセスを許可する
    val canAccessDashboard = userIsLoggedIn.takeIf { hasSession }

    println(canAccessDashboard ?: "Access denied")
    // true
}

kotlin
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))
    // []
}
解答例 {...}
kotlin
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() を使用してアクティブなサブスクリプションを1つ見つける

あなたは、ユーザーが複数のサブスクリプションを持つことができるものの、同時にアクティブにできるのは1つだけであるサブスクリプション型ストリーミングサービスで作業しています。getActiveSubscription() 関数を完成させ、singleOrNull() 関数と述語(プレディケート)を使用して、アクティブなサブスクリプションが複数ある場合に null 値を返すようにしてください:

kotlin
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 {...}
kotlin
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 {...}
kotlin
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() を使用してアクティブなユーザー名をフィルタリングする

あなたは、ユーザーがユーザー名とアカウントステータスを持つソーシャルメディアプラットフォームで作業しています。現在アクティブなユーザー名のリストを確認したいと考えています。mapNotNull() 関数に述語を指定して、ユーザーがアクティブな場合はユーザー名を返し、そうでない場合は null 値を返すように getActiveUsernames() 関数を完成させてください:

kotlin
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 {...}
kotlin
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 {...}
kotlin
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演算子で在庫を検証する

あなたは、ECプラットフォームの在庫管理システムで作業しています。販売処理を行う前に、利用可能な在庫に基づいて製品の要求数量が有効であるかどうかを確認する必要があります。

アーリーリターンとElvis演算子(該当する場合)を使用して、以下をチェックするように validateStock() 関数を完成させてください:

  • requested 変数が null である。
  • available 変数が null である。
  • requested 変数が負の値である。
  • requested 変数の数量が available 変数の数量より大きい。

上記のいずれの場合でも、関数は値 -1 で早期リターンしなければなりません。

kotlin
fun validateStock(requested: Int?, available: Int?): Int {
    // ここにコードを書いてください
}

fun main() {
    println(validateStock(5,10))
    // 5
    println(validateStock(null,10))
    // -1
    println(validateStock(-2,10))
    // -1
}
解答例 {...}
kotlin
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
}