添加 Pod 库依赖项

要添加一个位于 CocoaPods 仓库中的 Pod 库的依赖项, 请执行以下步骤:

1. 在 pod() 函数内指定 Pod 库名称.

   在配置代码段中, 可以使用 version 参数指定库的版本. 要使用库的最新版本, 可以完全省略这个参数.

   note

   也可以添加对 subspecs 的依赖项.

2. 指定 Pod 库的部署目标(deployment target)最小版本.

   kotlin {
       iosArm64()
   
       cocoapods {
           version = "2.0"
           summary = "CocoaPods test library"
           homepage = "https://github.com/JetBrains/kotlin"
           ios.deploymentTarget = "16.0"
   
           pod("SDWebImage") {
               version = "5.20.0"
           }
       }
   }

3. 在 IntelliJ IDEA 中, 运行 Build | Reload All Gradle Projects (如果是 Android Studio, 请运行 File | Sync Project with Gradle Files), 重新导入项目.

要在 Kotlin 代码中使用这些依赖项, 需要导入 cocoapods.<library-name> 包:

import cocoapods.SDWebImage.*

要添加一个本地保存的 Pod 库的依赖项, 请执行以下步骤:

1. 在 pod() 函数内指定 Pod 库名称.

   在配置代码段中, 指定本地 Pod 库的路径: 在 source 参数值中使用 path() 函数.

   note

   也可以添加本地 subspecs 的依赖项. cocoapods {} 代码段可以同时包含保存在本地的 Pod 库的依赖项, 以及 CocoaPods 仓库的 Pod 库的依赖项.

2. 指定 Pod 库的部署目标(deployment target)最小版本.

   kotlin {
       iosArm64()
   
       cocoapods {
           version = "2.0"
           summary = "CocoaPods test library"
           homepage = "https://github.com/JetBrains/kotlin"
           ios.deploymentTarget = "16.0"
   
           pod("pod_dependency") {
               version = "1.0"
               extraOpts += listOf("-compiler-option")
               source = path(project.file("../pod_dependency"))
           }
           pod("subspec_dependency/Core") {
               version = "1.0"
               extraOpts += listOf("-compiler-option")
               source = path(project.file("../subspec_dependency"))
           }
           pod("SDWebImage") {
               version = "5.20.0"
           }
       }
   }

   note

   也可以在配置代码段中使用 version 参数指定库的版本. 要使用库的最新版本, 可以省略这个参数.

3. 在 IntelliJ IDEA 中, 运行 Build | Reload All Gradle Projects (如果是 Android Studio, 请运行 File | Sync Project with Gradle Files), 重新导入项目.

要在 Kotlin 代码中使用这些依赖项, 需要导入 cocoapods.<library-name> 包:

import cocoapods.pod_dependency.*
import cocoapods.subspec_dependency.*
import cocoapods.SDWebImage.*

要添加一个自定义的 Git 仓库中的 Pod 库的依赖项, 请执行以下步骤:

1. 在 pod() 函数内指定 Pod 库名称.

   在配置代码段中, 指定 git 仓库路径: 在 source 参数中使用 git() 函数.

   此外, 还可以在 git() 之后的代码段中指定以下参数:

   • commit – 使用仓库中特定的 commit

   • tag – 使用仓库中特定的 tag

   • branch – 使用仓库中特定的 branch

   git() 函数的参数优先级顺序如下: commit, tag, branch. 如果不指定参数, Kotlin plugin 使用 master branch 中的 HEAD.

   note

   可以组合 branch, commit, 和 tag 参数来得到 Pod 库的特定版本.

2. 指定 Pod 库的部署目标(deployment target)最小版本.

   kotlin {
       iosArm64()
   
       cocoapods {
           version = "2.0"
           summary = "CocoaPods test library"
           homepage = "https://github.com/JetBrains/kotlin"
           ios.deploymentTarget = "16.0"
   
           pod("SDWebImage") {
               source = git("https://github.com/SDWebImage/SDWebImage") {
                   tag = "5.20.0"
               }
           }
   
           pod("JSONModel") {
               source = git("https://github.com/jsonmodel/jsonmodel.git") {
                   branch = "key-mapper-class"
               }
           }
   
           pod("CocoaLumberjack") {
               source = git("https://github.com/CocoaLumberjack/CocoaLumberjack.git") {
                   commit = "3e7f595e3a459c39b917aacf9856cd2a48c4dbf3"
               }
           }
       }
   }

3. 在 IntelliJ IDEA 中, 运行 Build | Reload All Gradle Projects (如果是 Android Studio, 请运行 File | Sync Project with Gradle Files), 重新导入项目.

要在 Kotlin 代码中使用这些依赖项, 需要导入 cocoapods.<library-name> 包:

import cocoapods.SDWebImage.*
import cocoapods.JSONModel.*
import cocoapods.CocoaLumberjack.*

要添加自定义的 Podspec 仓库中的 Pod 库依赖项, 请执行以下步骤:

1. 在 specRepos {} 代码段之内, 调用 url() 函数, 指定自定义 Podspec 仓库的地址.

2. 在 pod() 函数内指定 Pod 库名称.

3. 指定 Pod 库的部署目标(deployment target)最小版本.

   kotlin {
       iosArm64()
   
       cocoapods {
           version = "2.0"
           summary = "CocoaPods test library"
           homepage = "https://github.com/JetBrains/kotlin"
           ios.deploymentTarget = "16.0"
   
           specRepos {
               url("https://github.com/Kotlin/kotlin-cocoapods-spec.git")
           }
           pod("example")
       }
   }

4. 在 IntelliJ IDEA 中, 运行 Build | Reload All Gradle Projects (如果是 Android Studio, 请运行 File | Sync Project with Gradle Files), 重新导入项目.

note

要与 Xcode 协同工作, 请在你的 Podfile 文件的最开始指定 spec 的位置:

source 'https://github.com/Kotlin/kotlin-cocoapods-spec.git'

要在 Kotlin 代码中使用这些依赖项, 需要导入 cocoapods.<library-name> 包:

import cocoapods.example.*

要使用自定义的 cinterop 选项添加 Pod 库依赖项, 请执行以下步骤:

1. 在 pod() 函数内指定 Pod 库名称.

2. 在配置代码段中, 添加以下选项:

   • extraOpts – 指定对 Pod 库的选项列表. 例如, extraOpts = listOf("-compiler-option").

     note

     如果你遇到与 clang 模块相关的问题, 请添加 -fmodules 选项.

   • packageName – 通过 import <packageName>, 使用包名称直接导入这个库.

3. 指定 Pod 库的部署目标(deployment target)最小版本.

   kotlin {
       iosArm64()
   
       cocoapods {
           version = "2.0"
           summary = "CocoaPods test library"
           homepage = "https://github.com/JetBrains/kotlin"
           ios.deploymentTarget = "16.0"
   
           pod("FirebaseAuth") {
               packageName = "FirebaseAuthWrapper"
               version = "11.7.0"
               extraOpts += listOf("-compiler-option", "-fmodules")
           }
       }
   }

4. 在 IntelliJ IDEA 中, 运行 Build | Reload All Gradle Projects (如果是 Android Studio, 请运行 File | Sync Project with Gradle Files), 重新导入项目.

要在 Kotlin 代码中使用这些依赖项, 需要导入 cocoapods.<library-name> 包:

import cocoapods.FirebaseAuth.*

如果使用了 packageName 参数, 那么可以使用包这个名称导入这个库 import <packageName>:

import FirebaseAuthWrapper.Auth
import FirebaseAuthWrapper.User

kotlin {
    iosArm64()

    cocoapods {
        version = "2.0"
        summary = "CocoaPods test library"
        homepage = "https://github.com/JetBrains/kotlin"
        ios.deploymentTarget = "16.0"

        pod("PodName") {
            version = "1.0.0"
            extraOpts = listOf("-compiler-option", "-fmodules")
        }
    }
}

// pod("WebImage") 的 cinterop:
fun loadImage(): WebImage

// pod("Info") 的 cinterop:
fun printImageInfo(image: WebImage)

// 你的代码:
printImageInfo(loadImage())

• 设置 Kotlin 项目和 Xcode 项目之间的依赖项

• 阅读完整的 CocoaPods Gradle plugin DSL 参考文档