高效的Kotlin——明确参数和状态的约束条件

明确参数和状态的约束条件(Specify your expectations on arguments and state)

这条的意思是说，对于函数传入的参数我们应该进行必要地验证，尽早地阻止错误参数执行进一步的运算；并且在函数执行过程中检验必要的状态，状态错误时也应该及时反馈而不是进一步向下执行。而所谓“明确”与“反馈”通常有以下几种方式：

1. require-通用的对参数的条件约束。
2. check-通用的对状态的条件约束。
3. assert-通用断言，断言某条件为TRUE，在JVM上只在test模式下才执行。
4. Elvis(?:)操作符，return或者throw。

例如：

// Part of Stack<T>
fun pop(num: Int = 1): List<T> {
    require(num <= size) {
        "Cannot remove more elements than current size"
    }
    check(isOpen) { "Cannot pop from closed stack" }
    val collection = innerCollection ?: return emptyList()
    val ret = collection.take(num)
    innerCollection = collection.drop(num)
    assert(ret.size == num)
    return ret
}

一般而言，require用于对函数的入参做检查，保证入参满足函数的要求，并且require代码块一般会放在函数开头的显著位置，这不仅有利于明确函数对于入参的要求，而且可以肯定，require之后的代码入参必然是满足要求的。
check用于对状态做检查，当我们怀疑调用者可能违反了某种约定/规范时，我们可以使用check进行检查，一种常见的情形是，调用某个函数之前必须先调用另外一个函数，或者不能调用另外一个函数，与其相信调用者会遵守规范，我们更应该使用check进行必要的检查；此外，当我们不确定代码的某种实现是否正确时，也可以使用check对实现中的某些中间状态进行检查。
require和check的共同特点是，在所给条件未满足的情况下，它们都会抛出异常（分别是IllegalArgumentException和IllegalStateException），这为我们提供了合适的异常条件，帮助我们修改代码中存在的问题与漏洞。核心思想在于，避免错误的状态的进一步传播，尽早通过require，check等检测把异常状态暴露出来，而不是最后得到一个错误的结果后，再去反推、追踪问题之所在。

良好的副作用——smart casting

require和check除了起到检查的作用外，还有一个良好的副作用——smart casting。来看一下require的定义：

public inline fun require(value: Boolean, lazyMessage: () -> Any): Unit {
    contract {
        returns() implies value
    }
    if (!value) {
        val message = lazyMessage()
        throw IllegalArgumentException(message.toString())
    }
}

除了一目了然的功能之外，还有个不明所以的contract，这是Kotlin 1.3新增的功能，目的在于给编译器提供额外的信息，方便编译器做出更好的类型推断等。给另外一个更常用的例子你就明白了。在Kotlin 1.3之前

fun foo(bar: String?) {
    if (!bar.isNullOrEmpty()) {
        bar.toUpperCase() //ERROR! 虽然我们知道bar必然是非空的了，但是编译器不知道，类型推断不成立
        bar!!.toUpperCase() //OK!
    }
    //或者不使用isNullOrEmpty
    if (bar != null && bar.length != 0) {
        bar.toUpperCase() //OK!
    }
}

在Kotlin 1.3之后

fun foo(bar: String?) {
    if (!bar.isNullOrEmpty()) {
        bar.toUpperCase() //OK! 编译器知道bar必然非空
    }
}

之所以有这样的差别就是因为Kotlin 1.3增加了名为契约（contract）的特性。以下是isNullOrEmpty1.3之后的定义：

public inline fun CharSequence?.isNullOrEmpty(): Boolean {
    contract {
        returns(false) implies (this@isNullOrEmpty != null)
    }

    return this == null || this.length == 0
}

多了contract，作用就不多解释了，看代码猜也能猜到是啥意思。
扯远了，总之，require和check也有类似的功能，能提供额外的类型推断能力：

fun changeDress(person: Person) {
    require(person.outfit is Dress)
    val dress: Dress = person.outfit
    //...
}

fun sendEmail(person: Person, title: String, text: String) {
    require(person.email != null)
    val email: String = person.email
    //...
}

方便起见，标准库还有相应的requireNotNull和checkNotNull方法。