Kotlin中复合赋值（+=，-=，……）运算符重载

Posted 2020-09-30 落幕夜未央

本篇建立在已经了解了kotlin中运算符重载的理念以及如何实现的基础上。

来我们首先写一个简单的类，然后重载运算符+,+=,-,-=这个几个运算符。代码如下：

data class Point(var x: Int, var y: Int) {

    operator fun plus(point: Point): Point {
        return Point(this.x + point.x, this.y + point.y)
    }

    operator fun plusAssign(point: Point) {
        this.x += point.x
        this.y += point.y
    }

    operator fun minus(point: Point): Point {
        return Point(this.x + point.x, this.y + point.y)
    }

    operator fun minusAssign(point: Point) {
        this.x += point.x
        this.y += point.y
    }

}

我一开始没有仔细阅读文档，导致我习惯性的以为，重载+运算符就调用的是plus函数，重载+=运算符就调用的是plusAssign。但是当我写下如下代码之后，发现我又错了

fun main(args: Array<String>) {
    var point1 = Point(1, 2)
    var point2 = Point(3, 4)
    point1 += point2
    point1 -= point2

    val result = point1 + point2
    val result1 = point1 - point2
}

代码尚未编译，idea已经无情的在+=，-=的调用之处划上了红色波浪线。鼠标移到波浪线上，提示内容如下：

意思是当我们调用+=的时候，plus和plusAssign函数同时满足要求。那再来看看这是为什么，Kotlin in action一书中有这样的说明：

那我们怎么规避这个问题呢？有两种方法，再来看一段说明：

第一种方法就是：不用运算符，直接改成函数调用的形式，来我们用函数调用的方式吧上面代码出现的错误给解决掉：

fun main(args: Array<String>) {
    var point1 = Point(1, 2)
    var point2 = Point(3, 4)
    point1.plusAssign(point2)//改成函数调用形式
    point1.minusAssign(point2)//改成函数调用形式

    val result = point1 + point2
    val result1 = point1 - point2
}

这里问题解决了，但是这不是最优的解决方案。

所以第二种方案（也是推荐的方案）就是：不要同时提供两个版本的运算符重载，要么只提供+重载，要么只提供+=重载。

那为了+，和+=运算符还能同时使用，肯定要屏蔽掉plusAssign版本的，保留+的重载咯。（删了plus，那+就不能正常使用了。。）

 

还有其他的复合赋值运算符，-=，*=，/= 等等也遵循类似的道理。

 接下来上一点+=，-=的黑科技。先来看看如下代码：

fun main(args: Array<String>) {
    var numbers1 = listOf(1,2,3)
    numbers1 += 4
    numbers1 -= 5
}

首先不要惊奇在列表上使用了复合赋值运算符+=，-=，这是在给列表添加元素，删除元素，运算符重载的语法的小运用而已。

在你明白了上面一点之后你可能会疑惑不可变列表咋能添加删除元素呢？看看这里重载的实现：

public operator fun <T> Collection<T>.plus(element: T): List<T> {
    val result = ArrayList<T>(size + 1)
    result.addAll(this)
    result.add(element)
    return result
}

返回了一个新的列表而已，新列表包含了原有的元素，并且将新增的元素放到最末。-=也是类似，可自行查看源码。

既然返回的是一个新列表，那么var numbers1 = listOf(1,2,3),这里的var就万万不能换成val了，否则就不能再次赋值进行改变。

现在我们把不可变列表给改成可变列表，再来看看是啥情况：

fun main(args: Array<String>) {
    val numbers1 = mutableListOf(1,2,3)
    numbers1 += 4
    numbers1 -= 5
}

对于不可变列表，有没有看到我加粉的val？这里可万万不能写成var（跟上面的不可变列表恰恰相反……晕不晕？），为什么写成var不行？

因为kotlin中可变列表继承了不可变列表

而在不可变列表中重载了+运算符。在可变列表中重载了+=运算符。在列表申明为var的情况下如果同时提供了+，和+=的重载实现，那么+=在调用是编译器无法抉择的，两者都满足要求，所以会报错。

但是如果是val，则+的重载实现plus就不满足要求了，因为+返回的是一个新的列表，并赋值给变量。而val代表不可变，这自相矛盾了，而+=的实现只会改变列表自身，并不会改变变量的指向：

@kotlin.internal.InlineOnly
public inline operator fun <T> MutableCollection<in T>.plusAssign(element: T) {
    this.add(element)
}

所以可变列表中使用+=必须把列表申明为val。

-,-=在集合中也被重载了，原理类似，一看源码便知。