Обзор CocoaPods и настройка

Настройка среды для работы с CocoaPods

Установите менеджер зависимостей CocoaPods с помощью любого удобного вам инструмента установки:

sudo gem install cocoapods

Если во время установки возникнут проблемы, обратитесь к разделу Возможные проблемы и их решения.

Создание проекта

После настройки среды CocoaPods можно настроить проект Kotlin Multiplatform для работы с Pod. Ниже описаны шаги настройки только что созданного проекта:

1. Создайте новый проект для Android и iOS с помощью плагина Kotlin Multiplatform для IDE или веб-мастера Kotlin Multiplatform. Если вы используете веб-мастер, распакуйте архив и импортируйте проект в IDE.

2. Добавьте плагин Kotlin CocoaPods Gradle в каталог версий (файл gradle/libs.versions.toml):

   [plugins]
   kotlinCocoapods = { id = "org.jetbrains.kotlin.native.cocoapods", version.ref = "kotlin" }
   

3. Перейдите к корневому файлу проекта build.gradle.kts и добавьте следующий псевдоним в блок plugins {}:

   alias(libs.plugins.kotlinCocoapods) apply false
   

4. Откройте модуль, в который нужно интегрировать CocoaPods, например модуль sharedLogic, и добавьте следующий псевдоним в блок plugins {} файла build.gradle.kts:

   alias(libs.plugins.kotlinCocoapods)
   

Теперь можно настроить CocoaPods в проекте Kotlin Multiplatform.

Настройка проекта

Чтобы настроить плагин Kotlin CocoaPods Gradle в многоплатформенном проекте, выполните следующие действия:

1. В файле build.gradle(.kts) общего модуля проекта примените плагин CocoaPods, а также плагин Kotlin Multiplatform.

   plugins {
       kotlin("multiplatform") version "2.4.20"
       kotlin("native.cocoapods") version "2.4.20"
   }
   

2. Настройте version, summary, homepage и baseName файла Podspec в блоке cocoapods:

   plugins {
       kotlin("multiplatform") version "2.4.20"
       kotlin("native.cocoapods") version "2.4.20"
   }
   
   kotlin {
       cocoapods {
           // Required properties
           // Specify the required Pod version here
           // Otherwise, the Gradle project version is used
           version = "1.0"
           summary = "Some description for a Kotlin/Native module"
           homepage = "Link to a Kotlin/Native module homepage"
   
           // Optional properties
           // Configure the Pod name here instead of changing the Gradle project name
           name = "MyCocoaPod"
   
           framework {
               // Required properties              
               // Framework name configuration. Use this property instead of deprecated 'frameworkName'
               baseName = "MyFramework"
   
               // Optional properties
               // Specify the framework linking type. It's dynamic by default. 
               isStatic = false
               // Dependency export
               // Uncomment and specify another project module if you have one:
               // export(project(":<your other KMP module>"))
               transitiveExport = false // This is default.
           }
   
           // Maps custom Xcode configuration to NativeBuildType
           xcodeConfigurationToNativeBuildType["CUSTOM_DEBUG"] = NativeBuildType.DEBUG
           xcodeConfigurationToNativeBuildType["CUSTOM_RELEASE"] = NativeBuildType.RELEASE
       }
   }
   

3. В IntelliJ IDEA выберите Сборка | Перезагрузить все проекты Gradle (или в Android Studio — Файл | Синхронизировать проект с файлами Gradle), чтобы повторно импортировать проект.

4. Создайте оболочку Gradle, чтобы избежать проблем совместимости при сборке в Xcode.

После применения плагин CocoaPods выполняет следующие действия:

• Добавляет фреймворки debug и release в качестве выходных бинарных файлов для всех целевых платформ macOS, iOS, tvOS и watchOS.

• Создает задачу podspec, которая генерирует файл Podspec для проекта.

Файл Podspec содержит путь к выходному фреймворку и этапы скрипта, автоматизирующие сборку этого фреймворка в процессе сборки проекта Xcode.

Обновление Podfile для Xcode

Чтобы импортировать проект Kotlin в проект Xcode:

1. В части проекта Kotlin для iOS внесите изменения в Podfile:

   • Если в проекте есть зависимости от Git, HTTP или пользовательских репозиториев Podspec, укажите путь к Podspec в Podfile.

     Например, если вы добавляете зависимость от podspecWithFilesExample, укажите путь к Podspec в Podfile:

     target 'ios-app' do
        # ... other dependencies ...
        pod 'podspecWithFilesExample', :path => 'cocoapods/externalSources/url/podspecWithFilesExample' 
     end
     

     В :path должен быть указан путь к Pod.

   • Если вы добавляете библиотеку из пользовательского репозитория Podspec, укажите расположение спецификаций в начале Podfile:

     source 'https://github.com/Kotlin/kotlin-cocoapods-spec.git'
     
     target 'kotlin-cocoapods-xcproj' do
         # ... other dependencies ...
         pod 'example'
     end
     

2. Выполните pod install в каталоге проекта.

   При первом выполнении pod install создается файл .xcworkspace. Этот файл содержит исходный .xcodeproj и проект CocoaPods.

3. Закройте .xcodeproj и вместо него откройте новый файл .xcworkspace. Это поможет избежать проблем с зависимостями проекта.

4. В IntelliJ IDEA выберите Сборка | Перезагрузить все проекты Gradle (или в Android Studio — Файл | Синхронизировать проект с файлами Gradle), чтобы повторно импортировать проект.

Если не внести эти изменения в Podfile, задача podInstall завершится с ошибкой, а плагин CocoaPods выведет сообщение об ошибке в журнал.

Возможные проблемы и их решения

pod("NearbyMessages") {
    version = "1.1.1"
    headers = "GNSMessages.h"
}

./gradlew podInstall
open iosApp/iosApp.xcworkspace

Что дальше

• Добавление зависимостей от библиотеки Pod в проект Kotlin

• Настройка зависимостей между проектом Kotlin и проектом Xcode

• Полный справочник DSL плагина CocoaPods Gradle