高效的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对实现中的某些中间状态进行检查。
requirecheck的共同特点是,在所给条件未满足的情况下,它们都会抛出异常(分别是IllegalArgumentException和IllegalStateException),这为我们提供了合适的异常条件,帮助我们修改代码中存在的问题与漏洞。核心思想在于,避免错误的状态的进一步传播,尽早通过requirecheck等检测把异常状态暴露出来,而不是最后得到一个错误的结果后,再去反推、追踪问题之所在。

良好的副作用——smart casting

requirecheck除了起到检查的作用外,还有一个良好的副作用——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,作用就不多解释了,看代码猜也能猜到是啥意思。
扯远了,总之,requirecheck也有类似的功能,能提供额外的类型推断能力:

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
    //...
}

方便起见,标准库还有相应的requireNotNullcheckNotNull方法。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容