Kotlin编码窍门之操作符重载（Operator overloading）

Kotlin允许我们为我们的类型的预定义的操作符集提供实现。这些操作符有固定的标识（如+或*）和固定的优先级。为了实现这样的操作符，我们需要为目标类型（即双目操作符左侧的类型和一元操作符的参数类型）提供一个具有固定名称的成员函数或扩展函数。重载操作符的函数需要使用operator修饰符标记。

此外，我们还描述了规范不同运算符运算符重载的约定。

一元操作（Unary operations）

一元前缀操作符（Unary prefix operators）

Expression	Translated to
+a	a.unaryPlus()
-a	a.unaryMinus()
!a	a.not()

上表是说，当编译器处理如＋a的表达式时，它将执行以下步骤：

1. 确定a的类型，令其为T
2. 对接收者T查找被operator修饰的无参函数unaryPlus(),即成员函数或扩展函数
3. 如果函数不存在或不明确，则导致编译错误
4. 如果函数存在且返回类型为R，则表达式+a具有类型R

注意，这些操及所有其他操作都针对基本类型做了优化，不会为它们引入函数调用的开销。

如下示例如何重载一元减运算符：

data class Point(val x: Int, val y: Int)

operator fun Point.unaryMinus() = Point(-x, -y)

val point = Point(10, 20)
println(-point)  // prints "(-10, -20)"

递增和递减（Increments and decrements）

Expression	Translated to
a++	a.inc()+ see below()
a--	a.dex()+ see below()

函数inc()和dec()必须返回一个值，将分配给使用++或 -- 操作的变量。

当编译器解析后缀操作符，如a++的时候，将会执行以下步骤：

1. 确定a的类型，令其为T
2. 查找一个接收者为类型T的，带有operator操作符修饰的无参函数inc（）
3. 检查函数的返回值类型是否是T的子类

计算表达是的步骤是：

1. 把a的值存储到临时存储a0中
2. 把a.inc()的结果赋值给a
3. 把a0作为表达式的结果返回

对于a--，步骤是完全类似的。

对于前缀形式的++a和--a，其步骤是：

1. 把a.inc()结果赋值给a
2. 把a的新值作为表达式结果返回

双目操作符（Binary operations）

算术运算符（Arithmetic operators）

Expression	Translated to
a+b	a.plus(b)
a-b	a.minus(b)
a*b	a.times(b)
a/b	a.div(b)
a%b	a.re(b),a.mod(b)后者已过时
a..b	a.rangeTo(b)

对于上表中的操作符，编译器只是对应解析为列中的表达式。

注意：Kotlin1.1开始支持rem操作，mod操作在Kotlin1.1中被弃用。

例子

下面是一个从给定值开始的计数器的例子，它可以使用+运算符来增加计数：

data class Counter(var dayIndex: Int) {
    operator fun plus(increment: Int): Counter {
        return Counter(dayIndex + increment)
    }
}

in操作符（'In' operator）

Expression	Translated to
a in b	b.contains(a)
a !in b	!b.contains(a)

操作符in和！in的步骤是相同的，但参数的顺序是相反的。

索引访问操作符（Indexed access operator）

Expression	Translated to
a[i]	a.get(i)
a[i,j]	a.get(i,j)
a[i_1,...,i_n]	a.get(i_1,...,i_n)
a[i] = b	a.set(i,b)
a[i,j] = b	a.set(i,j,b)
a[i_1,...,i_n] = b	a.set(i_1,...,i_n,b)

方括号转换为调用带有适当数量参数的get和set函数。

调用操作符（Invoke operator）

Expression	Translated to
a()	a.invoke()
a(i)	a.invoke(i)
a(i,j)	a.invoke(i,j)
a(i_1,...,i_n)	a.invoke(i_1,...,i_n)

圆括号转换为调用带有适当数量参数的invoke。

广义赋值，运算赋值符（Augmented assignments）

Expression	Translated to
a += b	a.plusAssign(b)
a -= b	a.minusAssign(b)
a *= b	a.timesAssign(b)
a /= b	a.divAssgin(b)
a %= b	a.modAssign(b)

对于赋值操作，如a += b,编译器将执行以下步骤：

1. 如果右列的函数可用
   • 如果相应的二元算术函数也可用，将报错（模糊）
   • 确保其返回值类型是Unit，否则报错
   • 生成a.plusAssign(b)的代码
2. 否则，尝试生成a = a + b的代码（这里包含类型检查：a + b的类型必须是a的子类型）

注意：在Kotlin中，赋值不是表达式（即整体不能代表一个值）

相等和不等操作符（Equality and inequality operators）

Expression	Translated to
a == b	a?.equals(b) ?: (b === null)
a != b	!(a?.equals(b) ?: (b === null))

注意：===和！==（同一性检查）不可重载，因此不存在对它们的约定。

操作符==比较特殊，它被译为一个屏蔽null的复杂的表达式。null==null总是true，对于非null的x，x==null总是false，且不会再调用x.equals().

比较操作符（Comparison operators）

Expression	Translated to
a > b	a.compareTo(b)>0
a < b	a.compareTo(b)<0
a >= b	a.compareTo(b) >=0
a <= b	a.compareTo(b) <=0

所有的比较都转换为compareTo函数的调用，该函数需要返回Int值。

命名函数的中缀调用（Infix calls for named functions）

通过中缀函数的调用，可以模拟自定义中缀操作符。