# 内联函数 [TOC] 使用[高阶函数](http://www.kotlincn.net/docs/reference/lambdas.html)会带来一些运行时的效率损失：**每一个函数都是一个对象，并且会捕获一个闭包。即那些在函数体内会访问到的变量。内存分配（对于函数对象和类）和虚拟调用会引入运行时间开销**。 但是在许多情况下通过内联化 lambda 表达式可以消除这类的开销。下述函数是这种情况的很好的例子。即 `lock()` 函数可以很容易地在调用处内联。 考虑下面的情况： ```kotlin lock(l) { foo() } ``` 编译器没有为参数创建一个函数对象并生成一个调用。取而代之，编译器可以生成以下代码： ```kotlin l.lock() try { foo() } finally { l.unlock() } ``` 这个不是我们从一开始就想要的吗？为了让编译器这么做，我们需要使用 `inline` 修饰符标记 `lock()` 函数： ```kotlin inline fun <T> lock(lock: Lock, body: () -> T): T { …… } ``` `inline` 修饰符影响函数本身和传给它的 lambda 表达式：所有这些都将内联到调用处。 内联可能导致生成的代码增加；不过如果我们使用得当（即避免内联过大函数），性能上会有所提升，尤其是在循环中的“超多态（megamorphic）”调用处。 ## 禁用内联 **如果希望只内联一部分传给内联函数的 lambda 表达式参数，那么可以用 `noinline` 修饰符标记不希望内联的函数参数**： ```kotlin inline fun foo(inlined: () -> Unit, noinline notInlined: () -> Unit) { …… } ``` 可以内联的 lambda 表达式只能在内联函数内部调用或者作为可内联的参数传递，但是 **`noinline` 的可以以任何我们喜欢的方式操作：存储在字段中、传送它等等**。 >[success]需要注意的是，如果一个内联函数没有可内联的函数参数并且没有[具体化的类型参数](http://www.kotlincn.net/docs/reference/inline-functions.html#%E5%85%B7%E4%BD%93%E5%8C%96%E7%9A%84%E7%B1%BB%E5%9E%8B%E5%8F%82%E6%95%B0)，编译器会产生一个警告，因为内联这样的函数很可能并无益处（如果你确认需要内联，则可以用`@Suppress("NOTHING_TO_INLINE")` 注解关掉该警告）。 ## 非局部返回 一般在 Kotlin 中，我们可以只使用一个正常的、非限定的 `return` 来退出一个命名或匿名函数。 这意味着要退出一个 lambda 表达式，我们必须使用一个[标签](http://www.kotlincn.net/docs/reference/returns.html#%E6%A0%87%E7%AD%BE%E5%A4%84%E8%BF%94%E5%9B%9E)，并且在 lambda 表达式内部禁止使用裸 `return`，因为 lambda 表达式不能使包含它的函数返回： ```kotlin fun ordinaryFunction(block: () -> Unit) { println("hi!") } fun foo() { ordinaryFunction { return // 错误：不能使 `foo` 在此处返回 } } fun main() { foo() } ``` 运行结果 ``` 'return' is not allowed here ``` 但是**如果 lambda 表达式传给的函数是内联的，该 return 也可以内联，所以它是允许的**： ```kotlin fun foo() { inlined { return // OK：该 lambda 表达式是内联的 } } fun main() { foo() } ``` 运行结果 ``` hi! ``` 这种返回（位于 lambda 表达式中，但退出包含它的函数）称为**非局部返回**。 我们习惯了在循环中用这种结构，其内联函数通常包含： ```kotlin fun hasZeros(ints: List<Int>): Boolean { ints.forEach { if (it == 0) return true // 从 hasZeros 返回 } return false } ``` 请注意，一些内联函数可能调用传给它们的不是直接来自函数体、而是来自另一个执行上下文的 lambda 表达式参数，例如来自局部对象或嵌套函数。**在这种情况下，该 lambda 表达式中也不允许非局部控制流**。为了标识这种情况，该 lambda 表达式参数需要用 `crossinline` 修饰符标记： ```kotlin inline fun f(crossinline body: () -> Unit) { val f = object: Runnable { override fun run() = body() } // …… } ``` >[info] `break` 和 `continue` 在**内联的 lambda 表达式中还不可用**，但我们也计划支持它们。 ## 具体化的类型参数 有时候我们需要访问一个作为参数传给我们的一个类型： ```kotlin 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? } ``` 在这里我们向上遍历一棵树并且检测每个节点是不是特定的类型。这都没有问题，但是调用处不是很优雅： ```kotlin treeNode.findParentOfType(MyTreeNode::class.java) ``` 我们真正想要的只是传一个类型给该函数，即像这样调用它： ```kotlin treeNode.findParentOfType<MyTreeNode>() ``` 为能够这么做，**内联函数支持具体化的类型参数**，于是我们可以这样写： ```kotlin inline fun <reified T> TreeNode.findParentOfType(): T? { var p = parent while (p != null && p !is T) { p = p.parent } return p as T? } ``` 我们使用 `reified` 修饰符来限定类型参数T，现在可以在函数内部访问它了，几乎就像是一个普通的类一样。由于函数是内联的，不需要反射，正常的操作符如 `!is`和 `as` 现在都能用了。此外，我们还可以按照上面提到的方式调用它：`myTree.findParentOfType<MyTreeNodeType>()`。 虽然在许多情况下可能不需要反射，但我们仍然可以对一个具体化的类型参数使用它： ```kotlin inline fun <reified T> membersOf() = T::class.members fun main(s: Array<String>) { println(membersOf<StringBuilder>().joinToString("\n")) } ``` **普通的函数（未标记为内联函数的一些函数）不能有具体化参数**。 **不具有运行时表示的类型（例如非具体化的类型参数或者类似于`Nothing`的虚构类型）不能用作具体化的类型参数的实参**。 相关底层描述，请参见[规范文档](https://github.com/JetBrains/kotlin/blob/master/spec-docs/reified-type-parameters.md)。 ## 内联属性（自 1.1 起） `inline` 修饰符可用于没有幕后字段的属性的访问器get/set函数(方法)。你可以标注独立的属性访问器： ```kotlin val foo: Foo inline get() = Foo() var bar: Bar get() = …… inline set(v) { …… } ``` 你也可以标注整个属性，将它的两个访问器都标记为内联： ```kotlin inline var bar: Bar get() = …… set(v) { …… } ``` 在调用处，内联访问器如同内联函数一样内联。 ## 公有 API 内联函数的限制 当一个内联函数是 `public` 或 `protected` 而不是 `private` 或 `internal` 声明的一部分时，就会认为它是一个[模块级](http://www.kotlincn.net/docs/reference/visibility-modifiers.html#%E6%A8%A1%E5%9D%97)的公有 API。**可以在其他模块中调用它，并且也可以在调用处内联这样的调用**。 这带来了一些由模块做这样变更时导致的二进制兼容的风险——声明一个内联函数但调用它的模块在它修改后并没有重新编译。 为了消除这种由**非公有 API**变更引入的不兼容的风险，**公有 API 内联函数体内不允许使用非公有声明**，即，不允许使用 `private` 与 `internal` 声明以及其部件。 **一个 `internal` 声明可以由 `@PublishedApi` 标注，这会允许它在公有 API 内联函数中使用。当一个 `internal` 内联函数标记有 `@PublishedApi` 时，也会像公有函数一样检测其函数体**。