Kotlin 中的中缀函数

2025-01-14

1、什么是中缀函数

中缀函数是 Kotlin 中的一种特殊函数，它允许你使用更自然、更接近自然语言的方式来调用函数。通过使用中缀函数，你可以将函数名放置在两个参数之间，就像数学运算符一样，从而使代码更加简洁易读。

2、中缀函数的定义

要将一个函数定义为中缀函数，需要满足以下条件：

序号	条件	描述
1	成员函数或扩展函数	中缀函数必须是某个类的成员函数或者某个类型的扩展函数。
2	单个参数	中缀函数只能有一个参数。
3	infix 关键字	函数声明前必须使用 infix 关键字标记。

3、标准库中缀函数

Kotlin 的标准库和一些第三方库中包含了许多实用的中缀函数，这些函数能使代码更加简洁和易读。下面列举一些常见的例子：

3.1 标准库中的中缀函数

to 函数：用于创建 Pair 对象。例如：

1	val pair = "key" to "value"

in 运算符：用于判断一个元素是否在集合中。例如：

val list = listOf(1, 2, 3)
if (2 in list) {
    // ...  
}

rangeTo 函数：用于创建 IntRange 或 LongRange 对象。例如：

1
2
3

for (i in 1..10) {
    // ...
}

until 函数：用于创建不包含结束值的 IntRange 或 LongRange 对象。例如：

1
2
3

for (i in 0 until 10) {
    // ...
}

3.2 集合操作中的中缀函数

plus 函数：用于将两个集合合并。例如：

1
2
3

val list1 = listOf(1, 2)
val list2 = listOf(3, 4)
val combinedList = list1 + list2

minus 函数：用于从一个集合中移除元素。例如：

1 2	val list = listOf(1, 2, 3) val newList = list - listOf(2)

3.3 其他库中的中缀函数

Kotlinx.coroutines : launch、async 等用于启动协程。
Kotlinx.serialization : 用于序列化和反序列化 JSON、Protobuf 等格式的数据。

4、自定义中缀函数

除了标准库提供的函数，你还可以自定义中缀函数来满足特定的需求。例如，你可以为自定义数据类定义一个 + 操作符来实现自定义的加法运算。

4.1 数学运算符

infix fun Int.plus(other: Int): Int {
    return this + other * 2
}

fun main() {
    val result = 3 plus 5 // 等同于 3 + 5 * 2
    println(result)
}

在上面的示例中：

plus 函数被定义为 Int 类的扩展函数，并且使用了 infix 关键字。
由于 plus 是中缀函数，我们可以直接在 Int 和 Int 之间使用 plus，而不需要使用点号和括号。

4.2 构建器模式

data class User(val name: String, val age: Int)

infix fun String.named(age: Int) = User(this, age)

fun main() {
    val user = "Alice" named 30
}

在上面的示例中：

named 函数被定义为 String 类的扩展函数，并且使用了 infix 关键字。
由于 named 是中缀函数，并且接收 age 构造一个 User 实体，我们可以直接在 String 和 "Int" 之间使用 named 来构造一个实体。

4.3 成员中缀函数

class Person(val name: String) {
    infix fun likes(thing: String) {
        println("$name likes $thing")
    }
}

fun main() {
    val person = Person("Alice")
    person likes "Kotlin" // 等同于 person.likes("Kotlin")
}

在这个例子中：

Person 类有一个成员函数 likes。
likes 函数被标记为 infix，因此可以像运算符一样使用。
在 main 函数中，我们创建了一个 Person 对象，并使用 likes 中缀函数来表达 “Alice likes Kotlin”。

4.4 扩展中缀函数

class Person(val name: String)

infix fun Person.likes(thing: String) {
    println("$name likes $thing")
}

fun main() {
    val person = Person("Alice")
    person likes "Kotlin" // 等同于 person.likes("Kotlin")
}

在上面的示例中：

likes 函数被定义为 Person 类的扩展函数，并且使用了 infix 关键字。
由于 likes 是中缀函数，我们可以直接在 person 和 "Kotlin" 之间使用 likes，而不需要使用点号和括号。

5、中缀函数的优势

提高代码可读性： 中缀函数使代码更接近自然语言，更容易理解。
简化代码： 可以减少代码的冗余，使代码更简洁。
创建 DSL： 可以用来创建领域特定语言 (DSL)，使代码更具表达力。

6、注意事项

滥用可能降低可读性： 过度使用中缀函数也可能导致代码难以理解，因此需要谨慎使用。
优先级和结合性： 中缀函数的优先级和结合性与其他运算符相同，需要遵循运算符优先级的规则。