在本地 Swift 包中使用 Kotlin

设置项目

这个功能从 Kotlin 2.0.0 开始可用.

tip

要查看 Kotlin 的版本, 请打开你的 Kotlin Multiplatform 项目根目录中的 build.gradle(.kts) 文件. 你可以在文件最上方的 plugins {} 代码块中看到当前版本.

或者, 查看 gradle/libs.versions.toml 文件中的版本目录(Version Catalog).

本教程假定你的项目在项目构建阶段使用 embedAndSignAppleFrameworkForXcode Task 的 直接集成 方式. 如果你通过 CocoaPods Plugin 或通过使用 binaryTarget 的 Swift 包连接到 Kotlin Framework, 请先进行迁移.

将框架连接到你的项目

note

目前不支持集成到 swift build.

要在本地 Swift 包中使用 Kotlin 代码 , 需要将从跨平台项目生成的 Kotlin Framework 连接到你的 Xcode 项目:

1. 在 Xcode 中, 选择 Product | Scheme | Edit scheme, 或点击上方工具栏中的 schemes 图标, 并选择 Edit scheme:

   

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

   

3. 修改下面的脚本, 并添加为一个 action:

   cd "<跨平台项目的根目录路径>"
   ./gradlew :<共用的模块名称>:embedAndSignAppleFrameworkForXcode

   • 在 cd 命令中, 指定你的 Kotlin Multiplatform 项目的根目录路径, 例如, $SRCROOT/...

   • 在 ./gradlew 命令中, 指定共用的模块名称, 例如, :shared or :composeApp.

4. 在 Provide build settings from 中选择你的 App 的 target:

   

5. 现在, 你可以将共用的模块导入到你的本地 Swift 包, 并使用 Kotlin 代码. 例如, 定义下面的函数:

   import Shared
   
   public func greetingsFromSpmLocalPackage() -> String {
       return Greeting.greet()
   }

   

6. 在你的 iOS 项目的 ContentView.swift 文件中, 现在你可以到入本地包, 使用这个函数:

   import SwiftUI
   import SpmLocalPackage
   
   struct ContentView: View {
       var body: some View {
           Vstack {
               Image(systemName: "globe")
                   .imageScale(.large)
                   .foregroundStyle(.tint)
               Text(greetingsFromSpmLocalPackage())
           }
           .padding()
       }
   }
   
   #Preview {
       ContentView()
   }

7. 在 Xcode 中构建项目. 如果一切设置正确, 项目将会构建成功.

还有一些问题需要考虑:

• 如果你使用了与默认的 Debug 或 Release 不同的自定义构建配置, 请在 Build Settings 页, 在 User-Defined 之下添加 KOTLIN_FRAMEWORK_BUILD_TYPE 设置, 并将它设置为 Debug 或 Release.

• 如果你遇到与 script sandboxing 相关的错误, 请双击项目名称, 打开 iOS 项目设置, 然后在 Build Settings 页, 禁用 Build Options 之下的 User Script Sandboxing.

下一步做什么

• 选择你的集成方法

• 学习如何设置 Swift 包导出