新增 iOS 依賴項

Apple SDK 依賴項（例如 Foundation 或 Core Bluetooth）在 Kotlin 多平台專案中以一組預建函式庫的形式提供。它們不需要任何額外配置。

您也可以在您的 iOS 原始碼集中重複使用 iOS 生態系統中的其他函式庫和框架。如果其 API 透過 @objc 屬性匯出到 Objective-C，Kotlin 支援與 Objective-C 依賴項和 Swift 依賴項的互通性。純 Swift 依賴項尚不支援。

為了在 Kotlin 多平台專案中處理 iOS 依賴項，您可以透過 cinterop 工具 管理它們，或使用 CocoaPods 依賴項管理器（不支援純 Swift pods）。

透過 cinterop

您可以使用 cinterop 工具為 Objective-C 或 Swift 宣告建立 Kotlin 繫結。這將允許您從 Kotlin 程式碼中呼叫它們。

針對 函式庫 和 框架，步驟略有不同，但一般工作流程如下：

1. 下載您的依賴項。
2. 建置它以取得其二進位檔案。
3. 建立一個特殊的 .def 定義檔案，用以向 cinterop 描述此依賴項。
4. 調整您的建置指令碼，以在建置期間生成繫結。

新增函式庫

1. 下載函式庫原始碼並將其放置在您可以從專案中引用它的位置。

2. 建置函式庫（函式庫作者通常會提供如何操作的指南），並取得二進位檔案的路徑。

3. 在您的專案中，建立一個 .def 檔案，例如 DateTools.def。

4. 在此檔案中新增第一行字串：language = Objective-C。如果您想使用純 C 依賴項，請省略 language 屬性。

5. 提供兩個強制屬性的值：

   • headers 描述哪些標頭將由 cinterop 處理。
   • package 設定這些宣告應放入的套件名稱。

例如：

```none
headers = DateTools.h
package = DateTools
```

6. 將與此函式庫的互通性資訊新增到建置指令碼中：

   • 傳遞 .def 檔案的路徑。如果您的 .def 檔案與 cinterop 同名並放置在 src/nativeInterop/cinterop/ 目錄中，則可以省略此路徑。
   • 使用 includeDirs 選項告知 cinterop 在哪裡尋找標頭檔案。
   • 配置與函式庫二進位檔案的連結。
   KotlinGroovy

   kotlin {
       iosArm64() {
           compilations.getByName("main") {
               val DateTools by cinterops.creating {
                   // .def 檔案的路徑
                   definitionFile.set(project.file("src/nativeInterop/cinterop/DateTools.def"))
   
                   // 標頭搜尋的目錄（等同於 -I<path> 編譯器選項）
                   includeDirs("include/this/directory", "path/to/another/directory")
               }
               val anotherInterop by cinterops.creating { /* ... */ }
           }
   
           binaries.all {
               // 連結到函式庫所需的連結器選項。
               linkerOpts("-L/path/to/library/binaries", "-lbinaryname")
           }
       }
   }

   kotlin {
       iosArm64 {
           compilations.main {
               cinterops {
                   DateTools {
                       // .def 檔案的路徑
                       definitionFile = project.file("src/nativeInterop/cinterop/DateTools.def")
   
                       // 標頭搜尋的目錄（等同於 -I<path> 編譯器選項）
                       includeDirs("include/this/directory", "path/to/another/directory")
                   }
                   anotherInterop { /* ... */ }
               }
           }
   
           binaries.all {
               // 連結到函式庫所需的連結器選項。
               linkerOpts "-L/path/to/library/binaries", "-lbinaryname"
           }
       }
   }

7. 建置專案。

現在您可以在您的 Kotlin 程式碼中使用此依賴項。為此，請匯入您在 .def 檔案的 package 屬性中設定的套件。以上述範例來說，它會是：

import DateTools.*

請參閱使用 cinterop 工具和 libcurl 函式庫 的範例專案。

新增框架

1. 下載框架原始碼並將其放置在您可以從專案中引用它的位置。

2. 建置框架（框架作者通常會提供如何操作的指南），並取得二進位檔案的路徑。

3. 在您的專案中，建立一個 .def 檔案，例如 MyFramework.def。

4. 在此檔案中新增第一行字串：language = Objective-C。如果您想使用純 C 依賴項，請省略 language 屬性。

5. 提供這兩個強制屬性的值：

   • modules – 應由 cinterop 處理的框架名稱。
   • package – 這些宣告應放入的套件名稱。

   例如：

   modules = MyFramework
   package = MyFramework

6. 將與框架的互通性資訊新增到建置指令碼中：

   • 傳遞 .def 檔案的路徑。如果您的 .def 檔案與 cinterop 同名並放置在 src/nativeInterop/cinterop/ 目錄中，則可以省略此路徑。
   • 使用 -framework 選項將框架名稱傳遞給編譯器和連結器。使用 -F 選項將框架原始碼和二進位檔案的路徑傳遞給編譯器和連結器。
   KotlinGroovy

   kotlin {
       iosArm64() {
           compilations.getByName("main") {
               val DateTools by cinterops.creating {
                   // .def 檔案的路徑
                   definitionFile.set(project.file("src/nativeInterop/cinterop/DateTools.def"))
   
                   compilerOpts("-framework", "MyFramework", "-F/path/to/framework/")
               }
               val anotherInterop by cinterops.creating { /* ... */ }
           }
   
           binaries.all {
               // 告知連結器框架所在的位置。
               linkerOpts("-framework", "MyFramework", "-F/path/to/framework/")
           }
      }
   }

   kotlin {
       iosArm64 {
           compilations.main {
               cinterops {
                   DateTools {
                       // .def 檔案的路徑
                       definitionFile = project.file("src/nativeInterop/cinterop/MyFramework.def")
   
                       compilerOpts("-framework", "MyFramework", "-F/path/to/framework/")
                   }
                   anotherInterop { /* ... */ }
               }
           }
   
           binaries.all {
               // 告知連結器框架所在的位置。
               linkerOpts("-framework", "MyFramework", "-F/path/to/framework/")
           }
       }
   }

7. 建置專案。

現在您可以在您的 Kotlin 程式碼中使用此依賴項。為此，請匯入您在 .def 檔案的 package 屬性中設定的套件。以上述範例來說，它會是：

import MyFramework.*

了解更多關於 Swift/Objective-C 互通性 和 從 Gradle 配置 cinterop。

透過 CocoaPods

1. 執行 初始 CocoaPods 整合設定。

2. 透過在專案的 build.gradle(.kts) 中包含 pod() 函式呼叫，新增對您想使用的來自 CocoaPods 儲存庫的 Pod 函式庫的依賴。

   KotlinGroovy

   kotlin {
       cocoapods {
           version = "2.0"
           //..
           pod("SDWebImage") {
               version = "5.20.0"
           }
       }
   }

   kotlin {
       cocoapods {
           version = '2.0'
           //..
           pod('SDWebImage') {
               version = '5.20.0'
           }
       }
   }

您可以新增對 Pod 函式庫的以下依賴：

• 來自 CocoaPods 儲存庫
• 在本地儲存的函式庫上
• 來自自訂 Git 儲存庫
• 來自自訂 Podspec 儲存庫
• 帶有自訂 cinterop 選項

3. 在 IntelliJ IDEA 中執行 Build | Reload All Gradle Projects（或在 Android Studio 中執行 File | Sync Project with Gradle Files）以重新匯入專案。

若要在您的 Kotlin 程式碼中使用此依賴項，請匯入套件 cocoapods.<library-name>。以上述範例來說，它會是：

import cocoapods.SDWebImage.*

• 請參閱在 Kotlin 專案中設定了 不同 Pod 依賴項的範例專案。
• 查看一個 具有多個目標的 Xcode 專案依賴於 Kotlin 函式庫的範例專案。

接下來呢？

查看關於在多平台專案中新增依賴項的其他資源，並了解更多關於：

• 連接平台函式庫
• 新增對多平台函式庫或其他多平台專案的依賴項
• 新增 Android 依賴項