Добавьте Kotlin Multiplatform в существующий проект

Чтобы создать многоплатформенный модуль Kotlin (KMP) в проекте Android, используйте шаблон общего многоплатформенного модуля Kotlin , доступный в Android Studio Meerkat и плагине Android Gradle версии 8.8.0 и выше.

Шаблон модуля автоматизирует создание нового модуля с минимальной конфигурацией для платформ Android и iOS.

Примечание. Если вы хотите создать приложение для iOS, вам понадобится компьютер MacOS с установленным Xcode . Для запуска приложения вам также необходимо установить симулятор iOS или подготовить iPhone к разработке .

Настройте общий модуль KMP

Чтобы создать общий модуль KMP, выполните следующие действия:

1. Выберите «Файл» > «Создать» > «Новый модуль».
2. Выберите шаблон общего многоплатформенного модуля Kotlin на панели «Шаблоны» :

Рисунок 1. Создание нового модуля KMP.

Поля в шаблоне следующие:

• Имя модуля — определяет имя модуля Gradle, а также имя платформы iOS (можно изменить позже).
• Имя пакета – определяет имя пакета для файлов в этом модуле.
  1. Нажмите «Готово» и разрешите Gradle синхронизироваться с проектом. Вам также может быть предложено добавить вновь созданные файлы модулей в систему контроля версий.

Примечание. Сгенерированный модуль включает в себя некоторые основные функции-заполнители и тесты. Эти функции-заполнители обеспечивают успешную компиляцию и работу модуля.

После завершения в представлении проекта Android Studio отображается новый общий модуль вместе с набором исходного кода для каждой платформы.

Рис. 2. Представление проекта, показывающее новые общие модули.

Свяжите общий модуль с приложением Android

Мастер модулей не добавляет вновь созданный модуль в качестве зависимости к какому-либо существующему модулю. В качестве следующего шага вам необходимо связать общий модуль с одним из существующих модулей Gradle аналогично другим зависимостям Android.

dependencies {
    ...
    implementation(project(":shared"))
}

Примечание. Если в вашем проекте включена функция доступа к типобезопасному проекту Gradle, вы можете получить доступ к общему модулю с помощью project.shared.

После включения вы сможете получить доступ к коду как обычно. Из приложения Android вы можете получить доступ к коду, который доступен либо в androidMain, либо в commonMain.

Для получения дополнительной информации о структуре многоплатформенного проекта Kotlin см. основы структуры многоплатформенного проекта Kotlin.

Настройте общий модуль для приложения iOS.

Swift не может использовать модули Kotlin напрямую и требует создания скомпилированной двоичной среды.

Примечание. Плагин Kotlin Gradle также поддерживает интеграцию Swift Package Manager или интеграцию Cocoapods для совместного использования и использования общего кода, созданного для Kotlin & Native (iOS).

Новый шаблон модуля в Android Studio настраивает общий модуль для создания платформы для каждой архитектуры iOS. Вы можете найти следующий код в файле build.gradle.kts общего модуля:

val xcfName = "sharedKit"

iosX64 {
  binaries.framework {
    baseName = xcfName
  }
}

iosArm64 {
  binaries.framework {
    baseName = xcfName
  }
}

iosSimulatorArm64 {
  binaries.framework {
    baseName = xcfName
  }
}

См. «Иерархическая структура проекта» для получения информации об определении других типов архитектуры.

Примечание. Платформа вывода по умолчанию называется SharedKit, как определено в файле build.gradle.kts общего модуля. В своем собственном проекте вы можете переименовать его по мере необходимости, управляя переменной xcfName.

Свяжите общую библиотеку с проектом iOS.

Чтобы обеспечить доступ к общему коду из проекта iOS, добавьте этап сценария для создания платформы Kotlin перед компиляцией исходных кодов Swift:

Примечание. Вы также можете открыть проект Xcode, дважды щелкнув файл xcodeproj в Finder.

1. Щелкните правой кнопкой мыши файл в Android Studio и выберите «Открыть в» и «Открыть в связанном приложении» . Это откроет приложение iOS в Xcode.

Рисунок 3. Открытие в связанном приложении

1. Откройте настройки проекта, дважды щелкнув имя проекта в навигаторе проекта.

Рисунок 4. Диалоговое окно настроек проекта Xcode

1. Измените имя запуска сценария по умолчанию на Compile Kotlin Framework, чтобы лучше понять, что делает этот этап. Дважды щелкните заголовок «Выполнить сценарий», чтобы отредактировать его.
2. Разверните этап сборки и в текстовом поле «Оболочка» введите следующий код сценария:

Рисунок 5. Запуск этапа сборки сценария

Примечание. cd "$SRCROOT/.." перемещает сценарий в корневую папку проекта KMP Gradle, которая в данном случае является родительской папкой. Если в вашем случае проект iOS находится на другом пути, вам нужно настроить его здесь.

1. Перетащите этап «Выполнить сценарий» перед этапом «Компиляция исходных кодов» .

   

   Рис. 6. Запустите этап сборки скрипта перед компиляцией исходных кодов.

2. Создайте проект в Xcode, нажав ⌘B или перейдя в меню «Продукт» и выбрав «Сборка» .

Когда сборка завершится успешно, вы увидите следующий значок.

Рисунок 7. Успешная сборка

Получите доступ к общему коду в приложении iOS.

Чтобы убедиться, что приложение iOS может успешно получить доступ к коду из общего модуля, выполните следующие действия:

1. В проекте iOS откройте файл ContentView.swift по адресу: Sources/View/ContentView.swift
2. Добавьте import sharedKit в начало файла.
3. Измените представление «Текст», включив в отображаемую строку информацию Platform_iosKt.platform() следующим образом:

Примечание. Интерполяция строк в Swift использует синтаксис (кода).

Это обновление проверяет, может ли приложение вызывать функцию platform() из общего модуля, которая должна возвращать «iOS» при работе на платформе iOS.

Рисунок 8. Симулятор Xcode, на котором работает приложение iOS.

Дополнительные ресурсы

Если вы новичок в разработке KMP, дополнительные руководства см. в официальной документации KMP . Если вы новичок в разработке iOS, см. документацию Swift Basics ..