Создание библиотеки Kotlin Multiplatform — руководство

Настройка среды

Установите все необходимые инструменты и обновите их до последних версий.

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

1. В IntelliJ IDEA выберите Файл | Создать | Проект из системы контроля версий.

2. Введите URL-адрес проекта-шаблона мультиплатформенной библиотеки:

   https://github.com/Kotlin/multiplatform-library-template
   

3. Нажмите Клонировать.

Изучение структуры проекта

Проект-шаблон библиотеки Kotlin Multiplatform предоставляет базовую структуру для разработки мультиплатформенных библиотек Kotlin. Этот шаблон помогает создавать библиотеки, работающие на различных платформах.

В проекте-шаблоне library служит основным модулем и содержит основной исходный код и ресурсы сборки мультиплатформенной библиотеки.

Модуль library организован так, чтобы содержать как общий код, так и реализации для отдельных платформ. Вот обзор его исходного кода:

• commonMain: содержит код Kotlin, общий для всех целевых платформ. Здесь размещается код, который не зависит от API конкретных платформ.

• androidMain, iosMain, jvmMain и linuxX64Main: содержат код для платформ Android, iOS, JVM и Linux соответственно. Здесь реализуются функции, специфичные для этих платформ.

• commonTest, androidUnitTest, iosTest, jvmTest и linuxX64Test: содержат тесты общего кода commonMain и тесты для платформ Android, iOS, JVM и Linux соответственно.

Рассмотрим код library, общий для всех платформ. В каталоге src/commonMain/kotlin находится файл CustomFibi.kt с кодом Kotlin Multiplatform, в котором определена функция-генератор последовательности Фибоначчи:

package io.github.kotlin.fibonacci

// Defines the function to generate the Fibonacci sequence
fun generateFibi() = sequence {
    var a = firstElement
    yield(a)
    
    var b = secondElement
    yield(b)
    
    while (true) {
        val c = a + b
        yield(c)
        a = b
        b = c
    }
}

// Declares the expected values for `firstElement` and `secondElement`
expect val firstElement: Int
expect val secondElement: Int

Свойства firstElement и secondElement — это заглушки, которые может реализовать код для отдельных платформ. Каждая целевая платформа должна задать фактические значения с помощью ключевого слова actual в соответствующем наборе исходного кода.

Объявления expect сопоставляются с реализациями actual. Этот механизм полезен при написании кроссплатформенного кода, требующего поведения, зависящего от платформы.

В этом случае шаблон мультиплатформенной библиотеки включает реализации свойств firstElement и secondElement для отдельных платформ. Каталоги androidMain, iosMain, jvmMain и linuxX64Main содержат объявления actual, задающие значения этих свойств.

Например, вот реализация для Android из androidMain/kotlin/fibiprops.android.kt:

package io.github.kotlin.fibonacci

actual val firstElement: Int = 1
actual val secondElement: Int = 2

В остальных платформах используется тот же подход, но значения свойств firstElement и secondElement отличаются.

Добавление новой платформы

Теперь, когда вы знакомы с принципами работы общего и платформенного кода в шаблоне, расширим проект и добавим поддержку ещё одной платформы.

Настройте поддержку платформы Kotlin/Wasm с помощью механизма expect / actual, а затем реализуйте платформенную функциональность для свойств firstElement и secondElement.

Публикация библиотеки в локальном репозитории Maven

Мультиплатформенная библиотека готова к локальной публикации, чтобы её можно было использовать в других проектах на том же компьютере.

Для публикации библиотеки используйте плагин Gradle maven-publish следующим образом:

1. Найдите блок plugins { } в файле library/build.gradle.kts и примените плагин maven-publish:

      plugins {
          // ...
          // Add the following line:
          id("maven-publish")
      }
   

2. Найдите блок mavenPublishing {} и закомментируйте вызов signAllPublications(), чтобы указать, что публикация предназначена только для локального использования:

   mavenPublishing {
       // ...
       // Comment out the following call:
       // signAllPublications()
   }
   

3. Синхронизируйте файлы Gradle, нажав значок Синхронизировать изменения Gradle (), который появится в файле сборки. Также можно нажать кнопку обновления в окне инструмента Gradle.

4. В окне инструмента Gradle перейдите в раздел multiplatform-library-template | Задачи | publishing и запустите задачу Gradle publishToMavenLocal.

   

   Также можно выполнить в терминале следующую команду из корневого каталога multiplatform-library-template:

   ./gradlew publishToMavenLocal
   

Библиотека опубликована в локальном репозитории Maven.

Чтобы найти опубликованные артефакты, откройте в файловом менеджере или терминале каталог ~\.m2\repository\io\github\kotlin\library\1.0.0\.

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

После публикации мультиплатформенной библиотеки в локальном репозитории Maven её можно использовать в других проектах Kotlin на том же компьютере.

Добавьте в файл settings.gradle.kts проекта-потребителя параметр для поиска пакетов в локальном репозитории:

dependencyResolutionManagement {
    repositories {
        // ...
        mavenLocal()
    }
}

Добавьте зависимость от опубликованной библиотеки в файл build.gradle.kts модуля. Если вы добавляете её в другой мультиплатформенный проект, её можно добавить в общие или платформенные наборы исходного кода:

kotlin {
    //...
    sourceSets {
        // For all platforms
        commonMain.dependencies {
                implementation("io.github.kotlin:library:1.0.0")
        }
        // Or for a specific platforms
        wasmJsMain.dependencies {
            implementation("io.github.kotlin:library:1.0.0")
        }
    }
}

Вызов implementation() принимает группу, имя и версию библиотеки, указанные в её файле build.gradle.kts.

Синхронизируйте проект-потребитель и начните использовать библиотеку, например:

import io.github.kotlin.fibonacci.generateFibi

val seq = generateFibi()
println(seq.elementAt(3))

Что дальше

Рекомендуем продолжить изучение мультиплатформенной разработки:

• Опубликуйте библиотеку в Maven Central

• Ознакомьтесь с рекомендациями для авторов библиотек

Присоединяйтесь к сообществу:

• GitHub Compose Multiplatform: поставьте звезду репозиторию и внесите свой вклад

• Kotlin Slack: получите приглашение и присоединитесь к каналу #multiplatform

• Stack Overflow: подпишитесь на тег «kotlin-multiplatform»

• YouTube-канал Kotlin: подпишитесь и смотрите видео о Kotlin Multiplatform