Skip to content

Latest commit

 

History

History
504 lines (370 loc) · 13.9 KB

idioms.md

File metadata and controls

504 lines (370 loc) · 13.9 KB
Raw
type layout category title url
doc
reference
Basics
Идиомы

Идиомы

Набор различных часто используемых идиом в языке Kotlin. Если у вас есть любимая идиома, вы можете поделиться ею здесь. Для этого нужно создать pull request.

Создание DTO (он же POJO или POCO)

data class Customer(val name: String, val email: String)

создаёт класс Customer, обладающий следующими возможностями:

  • геттеры (и сеттеры в случае var) для всех свойств,
  • метод equals(),
  • метод hashCode(),
  • метод toString(),
  • метод copy(),
  • методы component1(), component2(), и т.д. для всех свойств (см. Классы данных)

Значения по умолчанию для параметров функций

fun foo(a: Int = 0, b: String = "") { ... }

Фильтрация списка

val positives = list.filter { x -> x > 0 }

Или короче:

val positives = list.filter { it > 0 }

Узнайте разницу между фильтрацией в Java и Kotlin.

Проверка наличия элемента в коллекции

if ("[email protected]" in emailsList) { ... }

if ("[email protected]" !in emailsList) { ... }

Форматирование строк

println("Name $name")

Узнайте разницу между конкатенация строк в Java и Kotlin.

Проверка объекта на принадлежность к определённому классу

when (x) {
    is Foo -> ...
    is Bar -> ...
    else   -> ...
}

Read-only список

val list = listOf("a", "b", "c")

Read-only ассоциативный список (map)

val map = mapOf("a" to 1, "b" to 2, "c" to 3)

Обращение к ассоциативному списку

println(map["key"])
map["key"] = value

Итерация по ассоциативному списку или списку пар

for ((k, v) in map) {
    println("$k -> $v")
}

k и v могут быть любыми удобными именами, такими как name и age.

Итерация по диапазону

for (i in 1..100) { ... }  // закрытый диапазон: включает 100
for (i in 1 until 100) { ... } // полуоткрытый диапазон: не включает 100
for (x in 2..10 step 2) { ... }
for (x in 10 downTo 1) { ... }
(1..10).forEach { ... }

Ленивые свойства

val p: String by lazy {
    // compute the string
}

Функции-расширения

fun String.spaceToCamelCase() { ... }

"Convert this to camelcase".spaceToCamelCase()

Создание синглтона

object Resource {
    val name = "Name"
}

Создание экземпляра абстрактного класса

abstract class MyAbstractClass {
    abstract fun doSomething()
    abstract fun sleep()
}

fun main() {
    val myObject = object : MyAbstractClass() {
        override fun doSomething() {
            // ...
        }

        override fun sleep() { // ...
        }
    }
    myObject.doSomething()
}

Сокращение для "Если не null"

val files = File("Test").listFiles()

println(files?.size) // размер выводится, если размер файлов не равен null

Сокращение для "Если не null, иначе"

val files = File("Test").listFiles()

println(files?.size ?: "empty") // если файл равен null, выводится "empty"

// Чтобы вычислить резервное значение в блоке кода, используйте команду `run`
val filesSize = files?.size ?: run { 
    return someSize 
}
println(filesSize)

Выброс исключения при равенстве null

val values = ...
val email = values["email"] ?: throw IllegalStateException("Email is missing!")

Получение первого элемента, возможно, пустой коллекции

val emails = ... // может быть пустой
val mainEmail = emails.firstOrNull() ?: ""

Узнайте разницу между получения первого элемента в Java и Kotlin.

Выполнение при неравенстве null

val value = ...

value?.let {
    ... // этот блок выполняется, если value не равен null
}

Маппинг nullable значение при неравенстве null

val value = ...

val mapped = value?.let { transformValue(it) } ?: defaultValue 
// возвращается defaultValue, если значение или результат преобразования равны null

Return с оператором when

fun transform(color: String): Int {
    return when (color) {
        "Red" -> 0
        "Green" -> 1
        "Blue" -> 2
        else -> throw IllegalArgumentException("Invalid color param value")
    }
}

Выражение try-catch

fun test() {
    val result = try {
        count()
    } catch (e: ArithmeticException) {
        throw IllegalStateException(e)
    }

    // Working with result
}

Выражение if

val y = if (x == 1) {
    "one"
} else if (x == 2) {
    "two"
} else {
    "other"
}

Builder-style использование методов, возвращающих Unit

fun arrayOfMinusOnes(size: Int): IntArray {
    return IntArray(size).apply { fill(-1) }
}

Функции, состоящие из одного выражения

fun theAnswer() = 42

Что равносильно этому:

fun theAnswer(): Int {
    return 42
}

Для сокращения кода их можно эффективно совмещать с другими идиомами. Например, с when:

fun transform(color: String): Int = when (color) {
    "Red" -> 0
    "Green" -> 1
    "Blue" -> 2
    else -> throw IllegalArgumentException("Invalid color param value")
}

Вызов нескольких методов объекта (with)

class Turtle {
    fun penDown()
    fun penUp()
    fun turn(degrees: Double)
    fun forward(pixels: Double)
}

val myTurtle = Turtle()
with(myTurtle) { // нарисует квадрат размером 100 pix
    penDown()
    for (i in 1..4) {
        forward(100.0)
        turn(90.0)
    }
    penUp()
}

Конфигурация свойств объекта (apply)

val myRectangle = Rectangle().apply {
    length = 4
    breadth = 5
    color = 0xFAFAFA
}

Это полезно для конфигурации свойств, которых нет в конструкторе объектов.

try-with-resources из Java 7

val stream = Files.newInputStream(Paths.get("/some/file.txt"))
stream.buffered().reader().use { reader ->
    println(reader.readText())
}

Обобщённая функция, требующая информацию об обобщённом типе

//  public final class Gson {
//     ...
//     public <T> T fromJson(JsonElement json, Class<T> classOfT) throws JsonSyntaxException {
//     ...

inline fun <reified T: Any> Gson.fromJson(json: JsonElement): T = this.fromJson(json, T::class.java)

Nullable Boolean

val b: Boolean? = ...
if (b == true) {
    ...
} else {
    // `b` is false or null
}

Обмен значений переменных

var a = 1
var b = 2
a = b.also { b = a }

Обозначение кода как незаконченного (TODO)

В стандартной библиотеке Kotlin есть функция TODO(), которая всегда выдает ошибку NotImplementedError. Её возвращаемый тип - Nothing, поэтому её можно использовать независимо от ожидаемого типа. Существует также перегрузка этой функции, которая принимает параметр причины.

fun calcTaxes(): BigDecimal = TODO("Waiting for feedback from accounting")

Плагин от IntelliJ IDEA понимает семантику TODO() и автоматически добавляет указатель кода в окно инструмента TODO.

Что дальше?