Kotlin (二十)——内联函数

Kotlin

版本：1
作者：李颖

内联函数(Inline Function)

使用 高阶函数 在运行时会带来一些不利: 每个函数都是一个对象, 而且它还要捕获一个闭包, 也就是, 在函数体内部访问的那些外层变量.
内存占用(函数对象和类都会占用内存) 以及虚方法调用都会带来运行时的消耗.

但在很多情况下, 通过将 Lambda 表达式内联在使用处, 可以消除这些运行时消耗.
上文中的那些函数就是很好的例子. 也就是说, lock() 函数可以很容易地内联在调用处.
看看下面的例子:

lock(l) { foo() }

编译器可以直接产生下面的代码, 而不必为参数创建函数对象, 然后再调用这个参数指向的函数:

l.lock()
try {
  foo()
}
finally {
  l.unlock()
}

这不就是我们最初期望的东西吗?

为了让编译器做到这点, 我们需要使用 inline 修饰符标记 lock() 函数:

inline fun lock<T>(lock: Lock, body: () -> T): T {
  // ...
}

inline 修饰符既会影响到函数本身, 也影响到传递给它的 Lambda 表达式: 这两者都会被内联到调用处.

函数内联也许会导致编译产生的代码尺寸变大, 但如果我们使用合理(不要内联太大的函数), 可以换来性能的提高, 尤其是在循环内发生的 "megamorphic" 函数调用. (译注: megamorphic 意义不明)

noinline

如果一个内联函数的参数中有多个 Lambda 表达式, 而你只希望内联其中的一部分, 你可以对函数的一部分参数添加 noinline 标记:

inline fun foo(inlined: () -> Unit, noinline notInlined: () -> Unit) {
  // ...
}

可内联的 Lambda 表达式只能在内联函数内部调用, 或者再作为可内联的参数传递给其他函数, 但 noinline 的 Lambda 表达式可以按照我们喜欢的方式任意使用: 可以保存在域内, 也可以当作参数传递, 等等.

注意. 如果一个内联函数不存在可以内联的函数类型参数, 而且没有 实体化的类型参数, 编译器将会产生一个警告, 因为将这样的函数内联不太可能带来任何益处(如果你确信需要内联, 可以关闭这个警告).

非局部返回(Non-local return)

在 Kotlin 中, 使用无限定符的通常的 return 语句, 只能用来退出一个有名称的函数, 或匿名函数.
这就意味着, 要退出一个 Lambda 表达式, 我们必须使用一个 标签, 无标签的 return 在 Lambda 表达式内是禁止使用的, 因为 Lambda 表达式不允许强制包含它的函数返回:

fun foo() {
  ordinaryFunction {
     return // 错误: 这里不允许让 `foo` 函数返回
  }
}

但是, 如果 Lambda 表达式被传递去的函数是内联函数, 那么 return 语句也可以内联, 因此 return 是允许的:

fun foo() {
  inlineFunction {
    return // OK: 这里的 Lambda 表达式是内联的
  }
}

这样的 return 语句(位于 Lambda 表达式内部, 但是退出包含 Lambda 表达式的函数) 成为 非局部(non-local) 返回. 我们在循环中经常用到这样的结构, 而循环也常常就是包含内联函数的地方:

fun hasZeros(ints: List<Int>): Boolean {
  ints.forEach {
    if (it == 0) return true // 从 hasZeros 函数返回
  }
  return false
}

注意, 有些内联函数可能并不在自己的函数体内直接调用传递给它的 Lambda 表达式参数, 而是通过另一个执行环境来调用, 比如通过一个局部对象, 或者一个嵌套函数. 这种情况下, 在 Lambda 表达式内, 非局部的控制流同样是禁止的. 为了标识这一点, Lambda 表达式参数需要添加 crossinline 修饰符:

inline fun f(crossinline body: () -> Unit) {
    val f = object: Runnable {
        override fun run() = body()
    }
    // ...
}

在内联的 Lambda 表达式中目前还不能使用 break 和 continue, 但我们计划将来支持它们

实体化的类型参数(Reified type parameter)

有些时候我们需要访问作为参数传递来的类型:

fun <T> TreeNode.findParentOfType(clazz: Class<T>): T? {
    var p = parent
    while (p != null && !clazz.isInstance(p)) {
        p = p?.parent
    }
    @Suppress("UNCHECKED_CAST")
    return p as T
}

这里, 我们向上遍历一颗树, 然后使用反射来检查节点是不是某个特定的类型. 这些都没问题, 但这个函数的调用代码不太漂亮:

myTree.findParentOfType(MyTreeNodeType::class.java)

我们真正需要的, 只是简单地将一个类型传递给这个函数, 也就是说, 象这样调用它:

myTree.findParentOfType<MyTreeNodeType>()

为了达到这个目的, 内联函数支持 实体化的类型参数(reified type parameter), 使用这个功能我们可以将代码写成:

inline fun <reified T> TreeNode.findParentOfType(): T? {
    var p = parent
    while (p != null && p !is T) {
        p = p?.parent
    }
    return p as T
}

我们给类型参数添加了 reified 修饰符, 现在, 它可以在函数内部访问了, 就好象它是一个普通的类一样. 由于函数是内联的, 因此不必使用反射, 通常的操作符, 比如 !is 和 as 都可以正常工作了. 此外, 我们可以象前面提到的那样来调用这个函数: myTree.findParentOfType<MyTreeNodeType>().

虽然很多情况下并不需要, 但我们仍然可以对一个实体化的类型参数使用反射:

inline fun <reified T> membersOf() = T::class.members
fun main(s: Array<String>) {
  println(membersOf<StringBuilder>().joinToString("\n"))
}

通常的函数(没有使用 inline 标记的) 不能够使用实体化的类型参数.
一个没有运行时表现的类型(比如, 一个没有实体化的类型参数, 或者一个虚拟类型, 比如 Nothing) 不可以用作实体化的类型参数.

关于实体化类型参数的更底层的介绍, 请参见 规格文档.