Kotlin Multiplatform--01：项目结构基础

- 引言
- [Common Code](#Common Code)
- Targets
- [Expected 和 actual](#Expected 和 actual)
- - - 1.使用函数
    - 2.使用接口

引言

以下为使用 Android Studio 创建的默认 Kotlin Multiplatform 的项目结构，本章将对项目结构进行简单介绍，让读者对 Kotlin Multiplatform 项目能够有一个大概的认识。

Common Code

Common Code 是指与平台无关的代码，比如业务逻辑等。在项目结构中对应 commonMain 文件夹。需要注意的是，Common Code 不能使用任何与平台相关的 API ，比如 java.io.File 等，也不能添加任何与平台相关的依赖库。但可以使用专门为 Kotlin Multiplatform 设计的 Kotlin 库，比如 kotlinx.coroutines 等。

Targets

Target 指需要将项目编译到哪个平台上，比如 JVM, JS, Android, iOS, or Linux 等。需要注意：平台相关的代码可以调用 Common Code，但 Common Code 中不能调用平台相关的代码。在 build.gradle.kts 文件中配置，如下所示：

kotlin 复制代码

kotlin {
	androidTarget() // Declares a target that corresponds to Android phones
    iosArm64() // Declares a target that corresponds to 64-bit iPhones
    macosArm64() // Declares a target that corresponds to Modern Apple Silicon-based Macs
}

声明编译目标后，还需要在项目中新建相应的文件夹和文件，命名规则为xxxMain，还需要在里面新建名为 kotlin 的子文件夹，放该平台相关的源代码。因为我在默认项目结构上额外声明了 macosArm64 的目标，所以需要新建一个 macosMain 文件夹，如下所示：

最后在 build.gradle.kts 中的 sourceSets 中可以配置不同目标的依赖库文件，如下所示：

kotlin 复制代码

    sourceSets {
        androidMain {
            //put your multiplatform dependencies here
            implementation("xxx")
        }
        commonMain.dependencies {
            //put your multiplatform dependencies here
            implementation("xxx")
        }
        iosMain.dependencies {
            //put your multiplatform dependencies here
            implementation("xxx")
        }
        macosMain.dependencies { 
            //put your multiplatform dependencies here
            implementation("xxx")
        }
    }

Expected 和 actual

有时候我们确实需要在 Common Code 中调用平台相关的代码，并在不同的平台下有不同的表现该如何处理呢？

1.使用函数

在 CommonMain 中声明一个 except 函数，供其他 Common Code 使用：

kotlin 复制代码

package identity

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

expect fun buildIdentity(): Identity

在不同平台中使用 actual 进行不同的实现，比如在 jvm 中进行以下实现：

kotlin 复制代码

package identity

import java.lang.System
import java.lang.ProcessHandle

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

在 POSIX 系统中进行以下实现：

kotlin 复制代码

package identity

import kotlinx.cinterop.toKString
import platform.posix.getlogin
import platform.posix.getpid

actual fun buildIdentity() = Identity(
    getlogin()?.toKString() ?: "None",
    getpid().toLong()
)

2.使用接口

在 CommonMain 中声明一个 Identity 接口和 buildIdentity 函数，供其他 Common Code 使用：

kotlin 复制代码

// In the commonMain source set:
expect fun buildIdentity(): Identity

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

在不同平台中使用 actual 进行不同的实现，比如在 jvm 中进行以下实现：

kotlin 复制代码

// In the jvmMain source set:
actual fun buildIdentity(): Identity = JVMIdentity()

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

在 POSIX 系统中进行以下实现：

kotlin 复制代码

// In the nativeMain source set:
actual fun buildIdentity(): Identity = NativeIdentity()

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