Что такое ключевое слово infix?

Что такое ключевое слово infix в Kotlin?

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

Основная идея и синтаксис

Функция, объявленная с ключевым словом infix, может быть вызвана как объект функция аргумент, вместо традиционного объект.функция(аргумент).

Условия для использования infix:

• Функция должна быть членом класса или расширяющей функцией (extension function).
• Функция должна принимать строго один параметр (не допускаются параметры с дефолтными значениями или varargs).
• Функция не может быть оператором (операторы, такие как +, *, уже имеют свою особую форму вызова).

Пример объявления и использования

Рассмотрим простой пример для класса Point.

class Point(val x: Int, val y: Int) {
    // Объявляем infix функцию для вычисления расстояния до другой точки
    infix fun distanceTo(other: Point): Double {
        return Math.sqrt((x - other.x).toDouble().pow(2) + (y - other.y).toDouble().pow(2))
    }
}

fun main() {
    val pointA = Point(0, 0)
    val pointB = Point(3, 4)

    // Традиционный вызов функции
    val distTraditional = pointA.distanceTo(pointB)
    println(distTraditional) // Вывод: 5.0

    // Вызов с использованием infix синтаксиса
    val distInfix = pointA distanceTo pointB
    println(distInfix) // Вывод: 5.0
}

В строке val distInfix = pointA distanceTo pointB мы видим преимущество infix: код читается почти как английское предложение — "pointA distanceTo pointB".

Типичные случаи применения

1. Функции для DSL (Domain Specific Languages): infix широко используется при создании DSL, например, для описания графов, конфигураций или тестов.

   // Пример из KotlinTest DSL
   myList should containAll(listOf(1, 2, 3))
   

2. Математические или логические операции: Для функций, которые по своей сути являются бинарными операциями (но не являются стандартными операторами языка).

   infix fun Int.pow(exp: Int): Int { /* ... */ }
   val result = 2 pow 10 // Более естественно, чем 2.pow(10)
   

3. Функции-утилиты для улучшения читаемости: Например, проверка принадлежности диапазону.

   infix fun Int.until(end: Int): IntRange { /* ... */ }
   for (i in 1 until 10) { // Синтаксис, знакомый по стандартной библиотеке!
       // ...
   }
   

Важные ограничения и отличие от операторов

Ключевое слово infix не предназначено для переопределения или создания новых операторов (таких как +, -, *). Для этого в Kotlin используется механизм operator functions. infix лишь предоставляет альтернативный, более "гибкий" синтаксис вызова для существующих функций.

// Это operator функция, а не infix
operator fun Point.plus(other: Point): Point {
    return Point(x + other.x, y + other.y)
}
val pointC = pointA + pointB // Вызывается как оператор

// Это infix функция, но не оператор
infix fun Point.add(other: Point): Point {
    return Point(x + other.x, y + other.y)
}
val pointD = pointA add pointB // Вызывается через infix синтаксис

Резюме

Использование infix в Kotlin — это инструмент для повышения читаемости и выразительности кода в специфических случаях, когда функция представляет собой бинарное действие между объектом и её единственным аргументом. Он помогает создавать более естественные и интуитивно понятные API, особенно в контексте разработки DSL. Однако важно применять его judiciously, чтобы не нарушать привычные паттерны чтения кода и помнить о его ограничениях (один параметр, не оператор).