在本地 Swift 软件包中使用 Kotlin
- 拥有包含本地 SwiftPM 模块的 iOS 应用。
- 已经在本地计算机上设置了面向 iOS 的 Kotlin Multiplatform 项目。
- 现有的 iOS 项目采用静态链接类型。
在本教程中,您将学习如何使用 Swift 软件包管理器 (SwiftPM) 将 Kotlin Multiplatform 项目中的 Kotlin 框架集成到本地软件包中。
要设置该集成,您将在项目的构建设置中添加一个特殊脚本,该脚本使用 embedAndSignAppleFrameworkForXcode Gradle 任务作为预备操作 (pre-action)。为了让公共代码中所做的更改反映在 Xcode 项目中,您只需重新构建 Kotlin Multiplatform 项目即可。
与常规的直接集成方法(将脚本添加到构建阶段,并且需要重新构建 Kotlin Multiplatform 和 iOS 项目才能获取公共代码的更改)相比,通过这种方式,您可以轻松在本地 Swift 软件包中使用 Kotlin 代码。
如果您还不熟悉 Kotlin Multiplatform,请先了解如何设置环境并从头开始创建跨平台应用程序。
设置项目
该功能从 Kotlin 2.0.0 开始提供。
要检查 Kotlin 版本,请导航至 Kotlin Multiplatform 项目根目录下的 build.gradle(.kts) 文件。您可以在文件顶部的 plugins {} 代码块中查看当前版本。
或者,查看 gradle/libs.versions.toml 文件中的版本目录 (version catalog)。
本教程假设您的项目在项目的构建阶段中使用了带有 embedAndSignAppleFrameworkForXcode 任务的直接集成方式。如果您是通过 CocoaPods 插件或带有 binaryTarget 的 Swift 软件包连接 Kotlin 框架,请先进行迁移。
从 SwiftPM binaryTarget 集成迁移
要从包含 binaryTarget 的 SwiftPM 集成迁移:
- 在 Xcode 中,使用 Product | Clean Build Folder 或通过快捷键 Cmd + Shift + K 清理构建目录。
- 在每个
Package.swift文件中,移除对包含 Kotlin 框架的软件包的依赖项,以及对产物的目标依赖项。
从 CocoaPods 插件迁移
如果您在 cocoapods {} 代码块中对其他 Pod 存在依赖,则必须采用 CocoaPods 集成方式。目前,在多模块 SwiftPM 项目中无法同时依赖 Pod 和 Kotlin 框架。
要从 CocoaPods 插件迁移:
在 Xcode 中,使用 Product | Clean Build Folder 或快捷键 Cmd + Shift + K 清理构建目录。
在包含 Podfile 的目录中,运行以下命令:
nonepod deintegrate从
build.gradle(.kts)文件中移除cocoapods {}代码块。删除
.podspec文件和 Podfile。
将框架连接到您的项目
目前不支持集成到 swift build 中。
为了能够在本地 Swift 软件包中使用 Kotlin 代码,请将多平台项目生成的 Kotlin 框架连接到您的 Xcode 项目:
在 Xcode 中,转到 Product | Scheme | Edit scheme,或点击顶部栏中的 scheme 图标并选择 Edit scheme:

选择 Build | Pre-actions 项,然后点击 + | New Run Script Action:

调整以下脚本并将其添加为一个操作:
bashcd "<Path to the root of the multiplatform project>" ./gradlew :<Shared module name>:embedAndSignAppleFrameworkForXcode- 在
cd命令中,指定 Kotlin Multiplatform 项目根目录的路径,例如$SRCROOT/..。 - 在
./gradlew命令中,指定共享模块的名称,例如:shared或:sharedLogic。
- 在
在 Provide build settings from 部分中选择您应用的目标 (target):

现在,您可以将共享模块导入本地 Swift 软件包并使用 Kotlin 代码。
在 Xcode 中,导航至您的本地 Swift 软件包,并定义一个导入了该模块的函数,例如:
Swiftimport Shared public func greetingsFromSpmLocalPackage() -> String { return Greeting.greet() }
在 iOS 项目的
ContentView.swift文件中,您现在可以通过导入本地软件包来使用该函数:Swiftimport SwiftUI import SpmLocalPackage struct ContentView: View { var body: some View { Vstack { Image(systemName: "globe") .imageScale(.large) .foregroundStyle(.tint) Text(greetingsFromSpmLocalPackage()) } .padding() } } #Preview { ContentView() }在 Xcode 中构建项目。如果一切配置正确,项目将成功构建。
还有几个因素值得考虑:
- 如果您使用的是与默认的
Debug或Release不同的自定义构建配置,请在 Build Settings 选项卡上的 User-Defined 下添加KOTLIN_FRAMEWORK_BUILD_TYPE设置,并将其设为Debug或Release。 - 如果您遇到脚本沙盒错误,请通过双击项目名称打开 iOS 项目设置,然后在 Build Settings 选项卡上的 Build Options 下禁用 User Script Sandboxing。
