将 Kotlin Multiplatform 添加到现有项目

如需在 Android 项目中创建 Kotlin Multiplatform (KMP) 模块，请使用 Kotlin Multiplatform 共享模块模板，该模板在 Android Studio Meerkat 和 Android Gradle 插件 8.8.0 及更高版本中提供。

该模块模板会自动创建一个新模块，其中包含针对 Android 和 iOS 平台的最低配置。KMP 还支持其他目标平台，例如桌面设备和 Web，您稍后可以将其添加到模块中。如需查看完整列表，请参阅受支持平台的稳定性。如需声明目标，请参阅多平台 Gradle DSL 参考文档中的目标。

注意 ：如果您想构建 iOS 应用，则需要一台安装了 Xcode 的 macOS 机器。您还需要安装 iOS 模拟器，或准备好用于开发的 iPhone，以便运行应用。

设置共享 KMP 模块

如需创建共享 KMP 模块，请按以下步骤操作：

1. 依次选择 File > New > New Module
2. 在 Templates 面板中选择 Kotlin Multiplatform Shared Module 模板：

图 1. 创建新的 KMP 模块

该模板中的字段如下：

• Module name - 定义 Gradle 模块名称以及 iOS 框架名称（稍后可以更改）
• Package name - 定义此模块中文件的软件包名称
  1. 点击 Finish，并允许 Gradle 与项目同步。系统可能还会提示您将新创建的模块文件添加到源代码控制工具中。

注意： 生成的模块包含一些基本的占位函数和测试。 这些占位函数可确保模块成功编译和运行。

完成后，Android Studio 项目视图会显示新的共享模块以及每个平台的源代码集。

图 2. 显示新共享模块的项目视图

将共享模块与 Android 应用相关联

模块向导不会将新创建的模块作为依赖项添加到任何现有模块。接下来，您需要将共享模块关联到某个现有 Gradle 模块，就像关联其他 Android 依赖项一样：

dependencies {
    ...
    implementation(project(":shared"))
}

注意： 如果您的项目启用了 Gradle 的类型安全项目访问器功能，您可以使用 projects.shared 访问共享模块。

启用后，您可以照常访问代码。在 Android 应用中，您可以访问 androidMain 或 commonMain 中的代码。

如需详细了解 Kotlin Multiplatform 项目结构，请参阅 Kotlin Multiplatform 项目结构基础知识

将共享模块设置为 iOS 应用

Swift 无法直接使用 Kotlin 模块，而是需要生成已编译的二进制框架。

注意： Kotlin Gradle 插件还支持 Swift Package Manager 集成或 Cocoapods 集成，以便共享和使用为 Kotlin 和原生 (iOS) 构建的通用代码。

Android Studio 中的新模块模板会将共享模块配置为针对每个 iOS 架构生成框架。您可在共享模块的 build.gradle.kts 文件中找到以下代码：

val xcfName = "sharedKit"

iosX64 {
  binaries.framework {
    baseName = xcfName
  }
}

iosArm64 {
  binaries.framework {
    baseName = xcfName
  }
}

iosSimulatorArm64 {
  binaries.framework {
    baseName = xcfName
  }
}

如需了解如何定义其他架构类型，请参阅分层项目结构。

注意： 默认情况下，输出框架名为 sharedKit，如共享模块的 build.gradle.kts 文件中所定义。在您自己的项目中，您可以根据需要重命名它，以控制 xcfName 变量。

在 iOS 项目中关联共享库

如需允许从 iOS 项目访问共享代码，请添加一个脚本阶段，以便在编译 Swift 源代码之前生成 Kotlin 框架：

注意： 您也可以在 Finder 中双击 xcodeproj 文件来打开 Xcode 项目。

1. 在 Android Studio 中右键点击该文件，然后依次选择 Open In 和 Open in Associated Application。这会在 Xcode 中打开 iOS 应用。

图 3. 在关联的应用中打开

1. 在项目导航器中双击项目名称，打开项目设置

图 4. Xcode 项目设置对话框

1. 将默认的 Run Script 名称更改为 Compile Kotlin Framework，以便更好地了解此阶段的作用。双击 Run Script 标题以进行修改。
2. 展开 build 阶段，然后在 Shell 文本字段中输入以下脚本代码：

图 5. 运行脚本构建阶段

注意： cd "$SRCROOT/.." 会将脚本导航到 KMP Gradle 项目的根文件夹，在本例中为父文件夹。如果您的 iOS 项目位于其他路径，则需要在此处进行调整。

1. 将 Run Script 阶段拖到 Compile Sources 阶段之前。

   

   图 6.在编译源代码之前运行脚本构建阶段

2. 在 Xcode 中构建项目，方法是点击 ⌘B 或前往 Product 菜单并选择 Build。

构建成功后，您会看到以下图标。

图 7. 构建成功

在 iOS 应用中访问共享代码

如需验证 iOS 应用能否成功访问共享模块中的代码，请执行以下操作：

1. 在 iOS 项目中，打开位于以下位置的 ContentView.swift 文件： Sources/View/ContentView.swift
2. 在文件顶部添加 import sharedKit。
3. 修改 Text 视图，以在显示的字符串中包含 Platform_iosKt.platform() 信息，如下所示：

注意： Swift 中的字符串插值类型使用的是 (code) 语法。

此更新会检查应用是否可从共享模块调用 platform() 函数，该函数在 iOS 平台上运行时应返回“iOS”。

图 8. 运行 iOS 应用的 Xcode 模拟器

其他资源

• 如果您刚开始接触 KMP 开发，请参阅官方 KMP 文档，了解更多指南。
• 如果您是 iOS 开发新手，请参阅 Swift 基础知识文档。
• 如需了解常见的 KMP 设置问题，请参阅 KMP 快速入门中的问题排查。
• 如需查看示例应用，请参阅 Android Kotlin Multiplatform 示例。