Добавление зависимостей iOS
Зависимости Apple SDK (такие как Foundation или Core Bluetooth) доступны в виде набора предварительно скомпилированных библиотек в проектах Kotlin Multiplatform Mobile. Они не требуют дополнительной конфигурации.
Вы также можете повторно использовать другие библиотеки и фреймворки из экосистемы iOS в ваших наборах исходного кода для iOS. Kotlin поддерживает взаимодействие с зависимостями Objective-C и Swift, если их API экспортированы в Objective-C с помощью атрибута @objc. Чисто Swift-зависимости пока не поддерживаются.
Интеграция с менеджером зависимостей CocoaPods также поддерживается с тем же ограничением — вы не можете использовать чисто Swift-пакеты.
Мы рекомендуем использовать CocoaPods для управления зависимостями iOS в проектах Kotlin Multiplatform Mobile. Управление зависимостями вручную необходимо только если вы хотите настроить процесс взаимодействия или у вас есть другие веские причины для этого.
С CocoaPods
-
Добавьте зависимость от библиотеки Pod из репозитория CocoaPods, которую вы хотите использовать, включив вызов функции
pod()вbuild.gradle.kts(build.gradle) вашего проекта.kotlin { cocoapods { //.. pod("AFNetworking") { version = "~> 4.0.1" } } }kotlin { cocoapods { //.. pod('AFNetworking') { version = '~> 4.0.1' } } }Вы можете добавить следующие зависимости от библиотеки Pod:
Переимпортируйте проект.
Чтобы использовать зависимость в вашем коде Kotlin, импортируйте пакет cocoapods.<library-name>. В приведённом примере это:
import cocoapods.AFNetworking.*
Без CocoaPods
Если вы не хотите использовать CocoaPods, вы можете использовать инструмент cinterop для создания Kotlin-связей для объявлений Objective-C или Swift. Это позволит вам вызывать их из кода Kotlin.
Шаги немного отличаются для библиотек и фреймворков, но идея остаётся той же.
Скачайте свою зависимость.
Скомпилируйте её, чтобы получить её двоичные файлы.
Создайте специальный файл
.def, который описывает эту зависимость для cinterop.Отредактируйте свой скрипт сборки, чтобы сгенерировать связи во время сборки.
Добавление библиотеки без CocoaPods
Скачайте исходный код библиотеки и поместите его в место, откуда вы сможете ссылаться на него из своего проекта.
Скомпилируйте библиотеку (авторы библиотек обычно предоставляют руководство о том, как это сделать) и получите путь к двоичным файлам.
В вашем проекте создайте файл
.def, напримерDateTools.def.Добавьте первую строку в этот файл:
language = Objective-C. Если вы хотите использовать чисто C-зависимость, опустите свойство языка.-
Укажите значения для двух обязательных свойств:
headersописывает, какие заголовки будут обработаны cinterop.packageустанавливает имя пакета, в который должны быть помещены эти объявления.
Например:
headers = DateTools.h package = DateTools
-
Добавьте информацию о взаимодействии с этой библиотекой в скрипт сборки:
Укажите путь к файлу
.def. Этот путь можно опустить, если ваш файл.defимеет то же имя, что и cinterop, и расположен в каталогеsrc/nativeInterop/cinterop/.Укажите cinterop, где искать заголовочные файлы, используя опцию
includeDirs.Настройте связывание с двоичными файлами библиотеки.
kotlin { iosX64() { compilations.getByName("main") { val DateTools by cinterops.creating { // Path to .def file defFile("src/nativeInterop/cinterop/DateTools.def") // Directories for header search (an analogue of the -I<path> compiler option) includeDirs("include/this/directory", "path/to/another/directory") } val anotherInterop by cinterops.creating { /* ... */ } } binaries.all { // Linker options required to link to the library. linkerOpts("-L/path/to/library/binaries", "-lbinaryname") } } }kotlin { iosX64 { compilations.main { cinterops { DateTools { // Path to .def file defFile("src/nativeInterop/cinterop/DateTools.def") // Directories for header search (an analogue of the -I<path> compiler option) includeDirs("include/this/directory", "path/to/another/directory") } anotherInterop { /* ... */ } } } binaries.all { // Linker options required to link to the library. linkerOpts "-L/path/to/library/binaries", "-lbinaryname" } } } Соберите проект.
Теперь вы можете использовать эту зависимость в своём коде Kotlin. Для этого импортируйте пакет, который вы настроили в свойстве package в файле .def. В приведённом примере это будет:
import DateTools.*
Добавление фреймворка без CocoaPods
Скачайте исходный код фреймворка и поместите его в место, откуда вы сможете ссылаться на него из своего проекта.
Соберите фреймворк (авторы фреймворков обычно предоставляют руководство о том, как это сделать) и получите путь к двоичным файлам.
В вашем проекте создайте файл
.def, напримерMyFramework.def.Добавьте первую строку в этот файл:
language = Objective-C. Если вы хотите использовать чисто C-зависимость, опустите свойство языка.-
Укажите значения для этих двух обязательных свойств:
modules— имя фреймворка, который должен обрабатываться cinterop.package— имя пакета, в который должны быть помещены эти объявления. Например:
modules = MyFramework package = MyFramework
-
Добавьте информацию о взаимодействии с фреймворком в скрипт сборки:
Укажите путь к файлу .def. Этот путь можно опустить, если ваш файл
.defимеет то же имя, что и cinterop, и расположен в каталогеsrc/nativeInterop/cinterop/.Укажите имя фреймворка компилятору и линковщику, используя опцию
-framework. Укажите путь к исходным файлам и двоичным файлам фреймворка компилятору и линковщику, используя опцию-F.
kotlin { iosX64() { compilations.getByName("main") { val DateTools by cinterops.creating { // Path to .def file defFile("src/nativeInterop/cinterop/DateTools.def") compilerOpts("-framework", "MyFramework", "-F/path/to/framework/") } val anotherInterop by cinterops.creating { /* ... */ } } binaries.all { // Tell the linker where the framework is located. linkerOpts("-framework", "MyFramework", "-F/path/to/framework/") } } }kotlin { iosX64 { compilations.main { cinterops { DateTools { // Path to .def file defFile("src/nativeInterop/cinterop/MyFramework.def") compilerOpts("-framework", "MyFramework", "-F/path/to/framework/") } anotherInterop { /* ... */ } } } binaries.all { // Tell the linker where the framework is located. linkerOpts("-framework", "MyFramework", "-F/path/to/framework/") } } } Соберите проект.
Теперь вы можете использовать эту зависимость в своём коде Kotlin. Для этого импортируйте пакет, который вы настроили в свойстве package в файле .def . В приведённом примере это будет:
import MyFramework.*
Подробнее о взаимодействии Objective-C и Swift и настройке cinterop из Gradle.
Решение для включения поддержки IDE для общего iOS-набора исходных кодов
Из-за известной проблемы, вы не сможете использовать функции IDE, такие как автодополнение и подсветка кода, для общего iOS-набора исходных кодов в многоплатформенном проекте с поддержкой иерархической структуры, если ваш проект зависит от:
Многоплатформенных библиотек, которые не поддерживают иерархическую структуру.
Библиотек iOS сторонних разработчиков, за исключением платформенных библиотек, которые поддерживаются по умолчанию. Эта проблема относится только к общему iOS-набору исходных кодов. IDE будет правильно поддерживать остальной код.
Чтобы включить поддержку IDE в этих случаях, вы можете обойти проблему, добавив следующий код в build.gradle.(kts) в каталоге shared вашего проекта:
val iosTarget: (String, KotlinNativeTarget.() -> Unit) -> KotlinNativeTarget =
if (System.getenv("SDK_NAME")?.startsWith("iphoneos") == true)
::iosArm64
else
::iosX64
iosTarget("ios")
def iosTarget
if (System.getenv("SDK_NAME")?.startsWith("iphoneos")) {
iosTarget = kotlin.&iosArm64
} else {
iosTarget = kotlin.&iosX64
}
В этом примере конфигурация iOS-целей зависит от переменной среды SDK_NAME, которая управляется Xcode. Для каждого сборки будет только одна iOS-цель с именем ios, которая использует iosMain набор исходных кодов. Не будет иерархии iosMain, iosArm64, и iosX64 наборов исходных кодов.
В качестве альтернативы, вы можете включить поддержку платформ зависимых библиотек в общих наборах исходных кодов. В дополнение к платформенным библиотекам, поставляемым с Kotlin/Native, этот подход также может обрабатывать пользовательские cinterop библиотеки, делая их доступными в общих наборах исходных кодов. Для включения этой функции добавьте свойство kotlin.mpp.enableCInteropCommonization=true в gradle.properties:
kotlin.mpp.enableCInteropCommonization=true
Что дальше?
Ознакомьтесь с другими ресурсами по добавлению зависимостей в многоплатформенных проектах и узнайте больше о:
© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/docs/multiplatform-mobile-ios-dependencies.html