Безопасность при работе с null

Умные и безопасные приведения типов

Иногда Kotlin может определить тип без явного объявления. Когда вы указываете 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)
  
    // The type is Int
    printObjectType(myInt)
    // It's an Integer with value 42

    // The type is List, so it's NOT a Double.
    printObjectType(myList)
    // It's NOT a Double

    // The type is Double, so the else branch is triggered.
    printObjectType(myDouble)
    // Unknown type
}

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

    // Triggers an error at runtime
    print(b)
//sampleEnd
}

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

    // Returns null value
    print(b)
    // null
//sampleEnd
}

fun calculateTotalStringLength(items: List<Any>): Int {
    var totalLength = 0

    for (item in items) {
        totalLength += if (item is String) {
            item.length
        } else {
            0  // Add 0 for non-String items
        }
    }

    return totalLength
}

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

Значения null и коллекции

В Kotlin работа с коллекциями часто связана с обработкой значений null и отфильтровыванием ненужных элементов. В Kotlin есть полезные функции, которые позволяют писать чистый, эффективный и безопасный при работе с null код для списков, множеств, отображений и других типов коллекций.

Чтобы отфильтровать значения null из списка, используйте функцию filterNotNull():

fun main() {
//sampleStart
    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]
//sampleEnd
}

Если нужно отфильтровать значения null непосредственно при создании списка, используйте функцию listOfNotNull():

fun main() {
//sampleStart
    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]
//sampleEnd
}

В обоих примерах, если все элементы — значения null, возвращается пустой список.

В Kotlin также есть функции для поиска значений в коллекциях. Если значение не найдено, они возвращают значения null, а не вызывают ошибку:

• Функция maxOrNull() находит наибольшее значение. Если такого значения нет, возвращает значение null.

• Функция minOrNull() находит наименьшее значение. Если такого значения нет, возвращает значение null.

Например:

fun main() {
//sampleStart
    // Temperatures recorded over a week
    val temperatures = listOf(15, 18, 21, 21, 19, 17, 16)
  
    // Find the highest temperature of the week
    val maxTemperature = temperatures.maxOrNull()
    println("Highest temperature recorded: ${maxTemperature ?: "No data"}")
    // Highest temperature recorded: 21

    // Find the lowest temperature of the week
    val minTemperature = temperatures.minOrNull()
    println("Lowest temperature recorded: ${minTemperature ?: "No data"}")
    // Lowest temperature recorded: 15
//sampleEnd
}

В этом примере оператор Элвиса ?: используется для вывода сообщения, если функции возвращают значение null.

С помощью функции singleOrNull() и лямбда-выражения можно найти единственный элемент, соответствующий условию. Если такого элемента нет или условию соответствуют несколько элементов, функция возвращает значение null:

fun main() {
//sampleStart
    // Temperatures recorded over a week
    val temperatures = listOf(15, 18, 21, 21, 19, 17, 16)

    // Check if there was exactly one day with 30 degrees
    val singleHotDay = temperatures.singleOrNull{ it == 30 }
    println("Single hot day with 30 degrees: ${singleHotDay ?: "None"}")
    // Single hot day with 30 degrees: None
//sampleEnd
}

Некоторые функции преобразуют коллекцию с помощью лямбда-выражения и возвращают значения null, если не могут выполнить свою задачу.

Чтобы преобразовать коллекцию с помощью лямбда-выражения и вернуть первое значение, которое не является null, используйте функцию firstNotNullOfOrNull(). Если такого значения нет, функция возвращает значение null:

fun main() {
//sampleStart
    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
//sampleEnd
}

Чтобы последовательно обработать каждый элемент коллекции с помощью лямбда-выражения и получить накопленное значение (или вернуть значение null, если коллекция пуста), используйте функцию reduceOrNull():

fun main() {
//sampleStart
    // Prices of items in a shopping cart
    val itemPrices = listOf(20, 35, 15, 40, 10)

    // Calculate the total price using the reduceOrNull() function
    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
//sampleEnd
}

В этом примере также используется оператор Элвиса ?: для вывода сообщения, если функция возвращает значение null.

Изучите стандартную библиотеку Kotlin, чтобы найти другие функции, которые помогут сделать код безопаснее.

Досрочный возврат и оператор Элвиса

В вводном курсе вы узнали, как использовать досрочный возврат, чтобы функция не выполнялась дальше определённого места. Оператор Элвиса ?: можно использовать вместе с досрочным возвратом для проверки предусловий функции. Этот подход позволяет писать более лаконичный код, поскольку не нужно использовать вложенные проверки. Более простую структуру кода также легче поддерживать. Например:

data class User(
    val id: Int,
    val name: String,
    // List of friend user IDs
    val friends: List<Int>
)

// Function to get the number of friends for a user
fun getNumberOfFriends(users: Map<Int, User>, userId: Int): Int {
    // Retrieves the user or return -1 if not found
    val user = users[userId] ?: return -1
    // Returns the number of friends
    return user.friends.size
}

fun main() {
    // Creates some sample users
    val user1 = User(1, "Alice", listOf(2, 3))
    val user2 = User(2, "Bob", listOf(1))
    val user3 = User(3, "Charlie", listOf(1))

    // Creates a map of users
    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 и идентификатор пользователя в виде целого числа.

  • Получает значение из отображения экземпляров User по указанному идентификатору пользователя.

  • Использует оператор Элвиса для досрочного возврата из функции со значением -1, если значение в отображении равно null.

  • Присваивает найденное в отображении значение переменной user.

  • Возвращает количество друзей в списке друзей пользователя с помощью свойства size.

• Функция main():

  • Создаёт три экземпляра User.

  • Создаёт отображение этих экземпляров User и присваивает его переменной users.

  • Вызывает функцию getNumberOfFriends() для переменной users со значениями 1 и 2. Для "Alice" функция возвращает двух друзей, а для "Bob" — одного.

  • Вызывает функцию getNumberOfFriends() для переменной users со значением 4, что приводит к досрочному возврату со значением -1.

Возможно, вы заметили, что без досрочного возврата код можно сделать лаконичнее. Однако для такого подхода требуется несколько безопасных вызовов, поскольку users[userId] может вернуть значение null, из-за чего код становится немного сложнее для чтения:

fun getNumberOfFriends(users: Map<Int, User>, userId: Int): Int {
    // Retrieve the user or return -1 if not found
    return users[userId]?.friends?.size ?: -1
}

Хотя в этом примере оператор Элвиса проверяет только одно условие, можно добавить несколько проверок, охватывающих все критические сценарии ошибок. Досрочный возврат с оператором Элвиса позволяет программе не выполнять лишнюю работу и делает код безопаснее: выполнение останавливается сразу при обнаружении значения null или недопустимого случая.

Дополнительные сведения об использовании return в коде см. в разделе Возвраты и переходы.

Практика

data class User(val name: String?)

fun getNotificationPreferences(user: Any, emailEnabled: Boolean, smsEnabled: Boolean): List<String> {
    val validUser = // Write your code here
    val userName = // Write your code here

    return listOfNotNull( /* Write your code here */)
}

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 Subscription(val name: String, val isActive: Boolean)

fun getActiveSubscription(subscriptions: List<Subscription>): Subscription? // Write your code here

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
}

data class User(val username: String, val isActive: Boolean)

fun getActiveUsernames(users: List<User>): List<String> {
    return users.mapNotNull { /* Write your code here */ }
}

fun main() {
    val allUsers = listOf(
        User("alice123", true),
        User("bob_the_builder", false),
        User("charlie99", true)
    )

    println(getActiveUsernames(allUsers))
    // [alice123, charlie99]
}

fun validateStock(requested: Int?, available: Int?): Int {
    // Write your code here
}

fun main() {
    println(validateStock(5,10))
    // 5
    println(validateStock(null,10))
    // -1
    println(validateStock(-2,10))
    // -1
}