直接集成
这是一种本地集成方法. 适用于以下情况:
你已经在本地机器上设置了 Kotlin Multiplatform 项目, 目标平台是 iOS.
你的 Kotlin Multiplatform 项目没有 CocoaPods 依赖项.
如果你想要通过共用代码来同时开发你的 Kotlin Multiplatform 项目和 iOS 项目, 你可以使用一段特别的脚本来设置直接集成.
这段脚本会自动化在 Xcode 中将 Kotlin 框架连接到 iOS 项目的过程:
这段脚本使用专门为 Xcode 环境设计的 Gradle 任务 embedAndSignAppleFrameworkForXcode
. 在设置过程中, 你要将它添加到 iOS App 构建的运行脚本阶段(Run Script Phase). 然后, 在运行 iOS App 构建之前, Kotlin artifact 会构建, 并包含在派生数据中.
一般来说, 这段脚本会:
将编译后的 Kotlin 框架复制到 iOS 项目结构的正确目录中.
处理内嵌框架的代码签名(code signing)过程.
确保 Kotlin 框架中发生变更的代码 Xcode 中的反应到 iOS App 中.
如果你目前在使用 CocoaPods plugin 来连接你的 Kotlin 框架, 首先请进行迁移. 如果你的项目没有 CocoaPods 依赖项, 请跳过这一步.
要从 CocoaPods plugin 迁移, 请进行以下步骤:
在 Xcode 中, 使用 Product | Clean Build Folder, 或使用 Cmd + Shift + K 快捷键, 清除构建目录.
在
Podfile
文件所在的目录中, 运行以下命令:pod deintegrate
从你的
build.gradle(.kts)
文件中删除cocoapods {}
代码块.删除
.podspec
和Podfile
文件.
要将从跨平台项目生成的 Kotlin 框架连接到你的 Xcode 项目, 请进行以下步骤:
只有声明过
binaries.framework
配置选项, 才会注册embedAndSignAppleFrameworkForXcode
task. 在你的 Kotlin Multiplatform 项目中, 在build.gradle.kts
文件中选择 iOS 编译目标声明.在 Xcode 中, 双击项目名称, 打开 iOS 项目设置.
在项目设置的 Build Phases 页, 点击 +, 并选择 New Run Script Phase.
调整下面的脚本, 并复制到运行脚本阶段(Run Script Phase):
cd "<跨平台项目的根目录路径>" ./gradlew :<共用的模块名称>:embedAndSignAppleFrameworkForXcode
在
cd
命令中, 指定你的 Kotlin Multiplatform 项目的根目录路径, 例如,$SRCROOT/..
.在
./gradlew
命令中, 指定共用的模块名称, 例如,:shared
或:composeApp
.
将 Run Script 阶段拖动到 Compile Sources 阶段之前.
在 Build Settings 页, 禁用 Build Options 之下的 User Script Sandboxing 选项:
tip
如果你没有先禁用 sandboxing 就构建了 iOS 项目, 这一步可能会要求重新启动你的 Gradle daemon. 请停止可能已经被沙箱化的 Gradle daemon 进程:
./gradlew --stop
在 Xcode 中构建项目. 如果一切设置正确, 项目将会构建成功.
note
如果你使用了与默认的
Debug
或Release
不同的自定义构建配置, 请在 Build Settings 页, 在 User-Defined 之下添加KOTLIN_FRAMEWORK_BUILD_TYPE
设置, 并将它设置为Debug
或Release
.
使用 Swift 包管理器时, 你也可以使用本地集成. 学习如何在本地包中添加 Kotlin 框架的依赖项.