预期声明与实际声明

预期函数与实际函数

你可以定义一个 Identity 类型, 和一个工厂函数 buildIdentity(), 这个函数在共通源代码集中声明, 并在平台源代码集中以不同的方式实现:

1. 在 commonMain 中, 声明一个简单的类型, 以及预期的工厂函数:

   package identity
   
   class Identity(val userName: String, val processID: Long)
   
   expect fun buildIdentity(): Identity

2. 在 jvmMain 源代码集中, 使用 Java 标准库实现:

   package identity
   
   import java.lang.System
   import java.lang.ProcessHandle
   
   actual fun buildIdentity() = Identity(
       System.getProperty("user.name") ?: "None",
       ProcessHandle.current().pid()
   )

3. 在 nativeMain 源代码集中, 使用原生依赖项, 通过 POSIX 实现:

   package identity
   
   import kotlinx.cinterop.toKString
   import platform.posix.getlogin
   import platform.posix.getpid
   
   actual fun buildIdentity() = Identity(
       getlogin()?.toKString() ?: "None",
       getpid().toLong()
   )

这里, 平台函数返回平台相关的 Identity 实例.

note

从 Kotlin 1.9.0 开始, 使用 getlogin() 和 getpid() 函数需要标注 @OptIn 注解.

接口加上预期函数与实际函数

如果工厂函数变得太大, 可以考虑使用共通的 Identity 接口, 并在不同平台上以不同方式实现它.

buildIdentity() 工厂函数应该返回 Identity, 但这次它是一个实现共通接口的对象:

1. 在 commonMain 中, 定义 Identity 接口和 buildIdentity() 工厂函数:

   // 在 commonMain 源代码集中:
   expect fun buildIdentity(): Identity
   
   interface Identity {
       val userName: String
       val processID: Long
   }

2. 创建平台相关的接口实现, 这里不需要额外的使用预期声明和实际声明:

   // 在 jvmMain 源代码集中:
   actual fun buildIdentity(): Identity = JVMIdentity()
   
   class JVMIdentity(
       override val userName: String = System.getProperty("user.name") ?: "none",
       override val processID: Long = ProcessHandle.current().pid()
   ) : Identity

   // 在 nativeMain 源代码集中:
   actual fun buildIdentity(): Identity = NativeIdentity()
   
   class NativeIdentity(
       override val userName: String = getlogin()?.toKString() ?: "None",
       override val processID: Long = getpid().toLong()
   ) : Identity

这些平台函数返回平台相关的 Identity 实例, 这些实例通过 JVMIdentity 和 NativeIdentity 平台类型来实现.

// 在 commonMain 源代码集中:
expect val identity: Identity

interface Identity {
    val userName: String
    val processID: Long
}

// 在 jvmMain 源代码集中:
actual val identity: Identity = JVMIdentity()

class JVMIdentity(
    override val userName: String = System.getProperty("user.name") ?: "none",
    override val processID: Long = ProcessHandle.current().pid()
) : Identity

// 在 nativeMain 源代码集中:
actual val identity: Identity = NativeIdentity()

class NativeIdentity(
    override val userName: String = getlogin()?.toKString() ?: "None",
    override val processID: Long = getpid().toLong()
) : Identity

// 在 commonMain 源代码集中:
expect object IdentityBuilder {
    fun build(): Identity
}

class Identity(
    val userName: String,
    val processID: Long
)

// 在 jvmMain 源代码集中:
actual object IdentityBuilder {
    actual fun build() = Identity(
        System.getProperty("user.name") ?: "none",
        ProcessHandle.current().pid()
    )
}

// 在 nativeMain 源代码集中:
actual object IdentityBuilder {
    actual fun build() = Identity(
        getlogin()?.toKString() ?: "None",
        getpid().toLong()
    )
}

预期类与实际类

warning

预期类与实际类功能处于 Beta 版. 这个功能已经基本稳定, 但将来可能需要进行一些手动的源代码迁移工作. 我们会尽力减少你需要进行的代码变更.

你可以使用预期类与实际类来实现相同的解决方案:

// 在 commonMain 源代码集中:
expect class Identity() {
    val userName: String
    val processID: Int
}

// 在 jvmMain 源代码集中:
actual class Identity {
    actual val userName: String = System.getProperty("user.name") ?: "None"
    actual val processID: Long = ProcessHandle.current().pid()
}

// 在 nativeMain 源代码集中:
actual class Identity {
    actual val userName: String = getlogin()?.toKString() ?: "None"
    actual val processID: Long = getpid().toLong()
}

你可能已经在演示材料中看到过这样方案. 但是, 对于简单的情况, 例如使用接口已经足够的情况, 不推荐 使用类.

使用接口, 你的设计不会限制为每个目标平台一个实现. 而且, 在测试中替换一个假的实现要简单得多, 在单个平台上提供多个实现也很容易.

作为一般性原则, 应该尽可能依赖标准的语言结构, 而不要使用预期声明和实际声明.

如果你决定使用预期类和实际类, Kotlin 编译器会示警告你, 这个功能处于 Beta 状态. 要压制这个警告, 请在你的 Gradle 构建文件中添加以下编译器选项:

kotlin {
    compilerOptions {
        // 共通的编译器选项, 应用于所有的 Kotlin 源代码集
        freeCompilerArgs.add("-Xexpect-actual-classes")
    }
}

open class Identity {
    val login: String = System.getProperty("user.name") ?: "none"
    val pid: Long = ProcessHandle.current().pid()
}

// 在框架代码库的 commonMain 中:
expect abstract class CommonIdentity() {
    val userName: String
    val processID: Long
    abstract val displayName: String
}

// 在框架代码库的 nativeMain 中:
actual abstract class CommonIdentity {
    actual val userName = getlogin()?.toKString() ?: "None"
    actual val processID = getpid().toLong()
    actual abstract val displayName: String
}

// 在框架代码库的 jvmMain 中:
actual abstract class CommonIdentity : Identity() {
    actual val userName = login
    actual val processID = pid
    actual abstract val displayName: String
}

// 在使用者代码库的 commonMain 中:
class MyCommonIdentity : CommonIdentity() {
    override val displayName = "Admin"
}

使用类型别名(type alias) 实现实际声明

实际声明的实现不一定需要从头编写. 它可以是一个既有的类型, 例如由第三方库提供的一个类.

你可以使用这个类型, 只要它满足与预期声明相关的所有要求. 例如, 考虑下面两个预期声明:

expect enum class Month {
    JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY,
    AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
}

expect class MyDate {
    fun getYear(): Int
    fun getMonth(): Month
    fun getDayOfMonth(): Int
}

在 JVM 模块中, java.time.Month 枚举可以用来实现第一个预期声明, java.time.LocalDate 类可以实现第二个. 但是, 无法直接向这些类型添加 actual 关键字.

相反, 你可以使用 类型别名 来连接预期声明和平台相关的类型:

actual typealias Month = java.time.Month
actual typealias MyDate = java.time.LocalDate

这种情况下, 请在与预期声明相同的包中定义 typealias 声明, 而在其它地方创建被引用的类.

note

由于 LocalDate 类型使用了 Month 枚举, 你需要在共通代码中将它们都声明为预期类.

在实际声明中扩大可见度

你可以让实际实现的可见度超过对应的预期声明. 如果你不想将你的 API 公开给一般用户, 这个功能会非常有用.

目前, Kotlin 对于可见度改变的情况会提示错误. 你可以压制这个错误, 方法是向实际类型的别名声明标注 @Suppress("ACTUAL_WITHOUT_EXPECT") 注解. 从 Kotlin 2.0 开始, 不会再有这个限制.

例如, 如果你在共通源代码集中声明下面的预期声明:

internal expect class Messenger {
    fun sendMessage(message: String)
}

你也可以在平台相关的源代码集中使用下面的实际实现:

@Suppress("ACTUAL_WITHOUT_EXPECT")
public actual typealias Messenger = MyMessenger

这里, 预期类的可见度为 internal, 通过类型别名, 它的实际实现是既有的 MyMessenger 类, 可见度为 public.

在实际声明中增加枚举值

如果在共通源代码集中使用 expect 声明了一个枚举类, 每个平台模块都应该有一个对应的 actual 声明. 这些声明必须包含相同的枚举值常数, 但也可以包含额外的枚举值常数.

如果你使用既有的平台枚举类来实现预期的枚举类时, 这个功能会非常有用. 例如, 考虑共通源代码集中的以下枚举类:

// 在 commonMain 源代码集中:
expect enum class Department { IT, HR, Sales }

当你在平台源代码集中为 Department 提供实际声明时, 你可以添加额外的枚举值常数:

// 在 jvmMain 源代码集中:
actual enum class Department { IT, HR, Sales, Legal }

// 在 nativeMain 源代码集中:
actual enum class Department { IT, HR, Sales, Marketing }

但是, 对于这样的情况, 平台源代码集中的这些额外的枚举值常数与共通代码中的枚举值常数不能匹配. 因此, 编译器要求你处理所有的其他情况.

实现 Department 上的 when 构造的函数, 需要 else 分支:

// 需要 else 分支:
fun matchOnDepartment(dept: Department) {
    when (dept) {
        Department.IT -> println("The IT Department")
        Department.HR -> println("The HR Department")
        Department.Sales -> println("The Sales Department")
        else -> println("Some other department")
    }
}

预期注解类

预期声明和实际声明可以与注解一起使用. 例如, 你可以声明一个 @XmlSerializable 注解, 它在每个平台源代码集中需要存在对应的实际声明:

@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
expect annotation class XmlSerializable()

@XmlSerializable
class Person(val name: String, val age: Int)

对于重用特定平台上的既有类型, 这个功能可能很有用. 例如, 在 JVM 上, 你可以使用 JAXB 标准 中的既有类型来定义你的注解:

import javax.xml.bind.annotation.XmlRootElement

actual typealias XmlSerializable = XmlRootElement

将 expect 与注解类一起使用时, 还有一个额外的因素需要考虑. 注解用来向代码添加元数据, 并且它不会成为签名中的类型. 在没有使用这个注解的平台上, 预期注解不一定需要拥有实际类.

你只需要在使用注解的平台上提供 actual 声明. 这个行为默认不启用, 而且它要求对类型标注 OptionalExpectation 注解.

对上面声明的 @XmlSerializable 注解, 添加 OptionalExpectation:

@OptIn(ExperimentalMultiplatform::class)
@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
@OptionalExpectation
expect annotation class XmlSerializable()

在没有使用这个注解的平台上, 如果缺少实际声明, 编译器不会产生错误.