Spec-Zone.ru › Kotlin 1.8

Добавление зависимостей 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. Управлять зависимостями вручную следует только в том случае, если вы хотите настроить процесс взаимодействия или у вас есть другие веские причины.

При использовании сторонних библиотек iOS в многоплатформенных проектах с поддержкой иерархической структуры, например, с ярлыком целевого объекта, вы не сможете использовать возможности IDE, такие как автодополнение и подсветка кода, для общего набора исходного кода iOS.

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

Эта проблема не относится к библиотекам платформы, которые поддерживаются по умолчанию.

С использованием CocoaPods

  1. Выполните настройку начальной интеграции CocoaPods.

  2. Добавьте зависимость от библиотеки 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:

    • Из репозитория CocoaPods

    • Из локально сохраненной библиотеки

    • Из пользовательского репозитория Git

    • Из пользовательского репозитория Podspec

    • С пользовательскими параметрами cinterop

    • Из статической библиотеки Pod

  3. Переимпортируйте проект.

Для использования зависимости в вашем Kotlin-коде импортируйте пакет cocoapods.<library-name>. В приведенном выше примере это:

import cocoapods.AFNetworking.*

Без CocoaPods

Если вы не хотите использовать CocoaPods, вы можете использовать инструмент cinterop для создания Kotlin-связей для объявлений Objective-C или Swift. Это позволит вам вызывать их из Kotlin-кода.

Шаги немного отличаются для библиотек и фреймворков, но идея остается прежней.

  1. Скачайте свою зависимость.

  2. Скомпилируйте её, чтобы получить двоичные файлы.

  3. Создайте специальный файл .def, описывающий эту зависимость для cinterop.

  4. Отредактируйте скрипт сборки для генерации связей во время сборки.

Добавление библиотеки без CocoaPods

  1. Скачайте исходный код библиотеки и поместите его в место, откуда вы можете обратиться к нему из своего проекта.

  2. Скомпилируйте библиотеку (авторы библиотеки обычно предоставляют руководство по этому процессу) и получите путь к двоичным файлам.

  3. В вашем проекте создайте файл .def, например DateTools.def.

  4. Добавьте первую строку в этот файл: language = Objective-C. Если вы хотите использовать чистую C-зависимость, опустите свойство языка.

  5. Укажите значения для двух обязательных свойств:

    • headers описывает, какие заголовки будут обработаны cinterop.

    • package устанавливает имя пакета, в который должны быть помещены эти объявления.

    Например:

    headers = DateTools.h
    package = DateTools
    
  6. Добавьте информацию о взаимодействии с этой библиотекой в скрипт сборки:

    • Укажите путь к файлу .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"
            }
        }
    }
    
  7. Соберите проект.

Теперь вы можете использовать эту зависимость в своем Kotlin-коде. Для этого импортируйте пакет, который вы настроили в свойстве package в файле .def. В приведенном выше примере это будет:

import DateTools.*

Добавление фреймворка без CocoaPods

  1. Скачайте исходный код фреймворка и поместите его в место, откуда вы можете обратиться к нему из своего проекта.

  2. Скомпилируйте фреймворк (авторы фреймворка обычно предоставляют руководство по этому процессу) и получите путь к двоичным файлам.

  3. В вашем проекте создайте файл .def , например MyFramework.def.

  4. Добавьте первую строку в этот файл: language = Objective-C. Если вы хотите использовать чистую C-зависимость, опустите свойство языка.

  5. Укажите значения для этих двух обязательных свойств:

    • modules — имя фреймворка, который должен обрабатываться cinterop.

    • package — имя пакета, в который должны быть помещены эти объявления.

    Например:

    modules = MyFramework
    package = MyFramework
    
  6. Добавьте информацию о взаимодействии с фреймворком в скрипт сборки:

    • Укажите путь к файлу .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/")
            }
        }
    }
    
  7. Соберите проект.

Теперь вы можете использовать эту зависимость в своем Kotlin-коде. Для этого импортируйте пакет, который вы настроили в свойстве package в файле .def . В приведенном выше примере это будет:

import MyFramework.*

Узнайте больше о взаимодействии Objective-C и Swift и настройке cinterop из Gradle.

Решение для включения поддержки IDE для общего набора iOS-источников

Из-за известной проблемы, вы не сможете использовать возможности IDE, такие как автодополнение кода и подсветка, для общего набора iOS-источников в многоплатформенном проекте с поддержкой иерархической структуры, если ваш проект зависит от:

  • Многоплатформенных библиотек, которые не поддерживают иерархическую структуру.

  • Библиотек iOS сторонних разработчиков, за исключением платформенных библиотек, поддерживаемых по умолчанию.

Эта проблема относится только к общему набору iOS-источников. IDE будет корректно поддерживать остальную часть кода.

Все проекты, созданные с помощью мастера проектов Kotlin Multiplatform Mobile, поддерживают иерархическую структуру, что означает, что эта проблема затрагивает их.

Чтобы включить поддержку 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

Это временное решение. Если вы являетесь автором библиотеки, мы рекомендуем вам включить иерархическую структуру.

С этим решением Kotlin Multiplatform tooling анализирует ваш код только относительно одного активного целевого натива во время текущей сборки. Это может привести к различным ошибкам во время полной сборки со всеми целевыми платформами, и ошибки более вероятны, если ваш проект содержит другие целевые платформы помимо iOS.

Что дальше?

Просмотрите другие ресурсы по добавлению зависимостей в многоплатформенные проекты и узнайте больше о:

  • Добавление зависимостей от многоплатформенных библиотек или других многоплатформенных проектов

  • Добавление зависимостей Android

Последнее изменение: 10 января 2023 г.
Добавление зависимостей Android Запуск тестов с Kotlin Multiplatform

© 2010–2023 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API