平台相关声明

多平台项目是 Kotlin 1.2 和 1.3 中的实验性特性。本文档中描述的所有语言和工具功能都可能在将来的Kotlin版本中发生变更

Kotlin的多平台代码的主要功能之一是使通用代码依赖于特定于平台的声明的方式。 在其他语言中，通常可以通过在通用代码中构建一组接口并在特定于平台的模块中实现这些接口来实现。 但是，如果在其中一个平台上所需功已经有一个库，并且希望直接使用该库的API而无需额外的包装器，则这种方法并不适合。 另外，它要求将公共声明表示为接口，但并不能涵盖所有可能的情况。

作为替代，Kotlin提供了预期和实际声明的机制。 通过这种机制，公共模块可以定义期望的声明，而平台模块可以提供与期望的声明相对应的实际声明。 为了了解它是如何工作的，我们首先来看一个示例。 此代码是通用模块的一部分：

  1. package org.jetbrains.foo
  3. expect class Foo(bar: String) {
  4.     fun frob()
  5. }
  7. fun main() {
  8.     Foo("Hello").frob()
  9. }

这是对应 JVM 的模块：

  1. package org.jetbrains.foo
  3. actual class Foo actual constructor(val bar: String) {
  4.     actual fun frob() {
  5.         println("Frobbing the $bar")
  6.     }
  7. }

这里演示了一个重要的点：

  • 通用模块中的预期声明及其实际对应项始终具有完全相同的限定名称。

  • 预期的声明用 expect 关键字标记； 实际的声明中用 actual 关键字标记。

  • 与预期声明的任何部分匹配的所有实际声明都需要标记为 actual 。

  • 预期的声明绝不包含任何实现代码。

请注意，预期的声明不限于接口和接口成员。 在此示例中，期望的类具有构造函数，可以直接从通用代码创建。 还可以将 expect 修饰符应用于其他声明，包括顶级声明和注解：

  2. // Common
  3. expect fun formatString(source: String, vararg args: Any): String
  5. expect annotation class Test
  7. // JVM
  8. actual fun formatString(source: String, vararg args: Any) =
  9.     String.format(source, *args)
  11. actual typealias Test = org.junit.Test

编译器确保每个期望的声明在实现相应公共模块的所有平台模块中都有实际的声明，并在缺少任何实际的声明时报告错误。 IDE提供了可帮助创建缺少实际声明的工具。

如果您要在通用代码中使用特定平台的库，同时为另一个平台提供自己的实现，则可以为现有类提供类型别名作为实际的声明：

  1. expect class AtomicRef<V>(value: V) {
  2.   fun get(): V
  3.   fun set(value: V)
  4.   fun getAndSet(value: V): V
  5.   fun compareAndSet(expect: V, update: V): Boolean
  6. }
  8. actual typealias AtomicRef<V> = java.util.concurrent.atomic.AtomicReference<V>