Обмен кодом между платформами

Использование сокращений для целей

В типичном многоплатформенном проекте с двумя целями, связанными с iOS – iosArm64 и iosX64, иерархическая структура включает промежуточный исходный набор (iosMain), который используется нативными исходными наборами, специфичными для платформы.

Плагин kotlin-multiplatform предоставляет сокращения для целей, для создания структур для общих комбинаций целей.

Все сокращения создают похожие иерархические структуры в коде. Например, сокращение ios создаёт следующую иерархическую структуру:

kotlin {
    sourceSets{
        val commonMain by sourceSets.getting
        val iosX64Main by sourceSets.getting
        val iosArm64Main by sourceSets.getting
        val iosMain by sourceSets.creating {
            dependsOn(commonMain)
            iosX64Main.dependsOn(this)
            iosArm64Main.dependsOn(this)
        }
    }
}

kotlin {
    sourceSets{
        iosMain {
            dependsOn(commonMain)
            iosX64Main.dependsOn(it)
            iosArm64Main.dependsOn(it)
        }
    }
}

kotlin {
    ios()
    // Add the ARM64 simulator target
    iosSimulatorArm64()
    
    val iosMain by sourceSets.getting
    val iosTest by sourceSets.getting
    val iosSimulatorArm64Main by sourceSets.getting
    val iosSimulatorArm64Test by sourceSets.getting
    
    // Set up dependencies between the source sets
    iosSimulatorArm64Main.dependsOn(iosMain)
    iosSimulatorArm64Test.dependsOn(iosTest)
}

kotlin {
    ios()
    // Add the ARM64 simulator target
    iosSimulatorArm64()
    
    // Set up dependencies between the source sets
    sourceSets {
        // ...
        iosSimulatorArm64Main {
            dependsOn(iosMain)
        }
        iosSimulatorArm64Test {
            dependsOn(iosTest)
        }
    }
}

Настройка иерархической структуры вручную

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

Например, если вы хотите обмениваться кодом между нативными целями Linux, Windows и macOS – linuxX64M, mingwX64, и macosX64:

1. Добавьте промежуточный исходный набор desktopMain, который содержит общую логику для этих целей.

2. Укажите иерархию исходных наборов, используя отношение dependsOn.

kotlin{
    sourceSets {
        val desktopMain by creating {
            dependsOn(commonMain)
        }
        val linuxX64Main by getting {
            dependsOn(desktopMain)
        }
        val mingwX64Main by getting {
            dependsOn(desktopMain)
        }
        val macosX64Main by getting {
            dependsOn(desktopMain)
        }
    }
}

kotlin {
    sourceSets {
        desktopMain {
            dependsOn(commonMain)
        }
        linuxX64Main {
            dependsOn(desktopMain)
        }
        mingwX64Main {
            dependsOn(desktopMain)
        }
        macosX64Main {
            dependsOn(desktopMain)
        }
    }
}

Вы можете иметь общий исходный набор для следующих комбинаций целей:

• JVM или Android + JS + Native

• JVM или Android + Native

• JS + Native

• JVM или Android + JS

• Native

Kotlin в настоящее время не поддерживает общий исходный набор для следующих комбинаций:

• Несколько целей JVM

• JVM + Android цели

• Несколько целей JS

Если вам нужно получить доступ к платформам-специфичным API из общего нативного исходного набора, IntelliJ IDEA поможет вам определить общие объявления, которые можно использовать в общем нативном коде. В других случаях используйте механизм Kotlin для ожидаемых и фактических объявлений.

Обмен кодом в библиотеках

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

Например, рассмотрите следующую иерархию исходных наборов из репозитория kotlinx.coroutines:

Исходный набор concurrent объявляет функцию runBlocking и компилируется для JVM и нативных целей. После того, как библиотека kotlinx.coroutines обновлена и опубликована с иерархической структурой проекта, вы можете зависеть от неё и вызывать runBlocking из исходного набора, который общий для JVM и нативных целей, поскольку он соответствует «подписи целей» исходного набора библиотеки concurrent.

Использование нативных библиотек в иерархической структуре

Вы можете использовать платформенно-зависимые библиотеки, такие как Foundation, UIKit, и POSIX в исходных наборах, общих для нескольких нативных целей. Это помогает обмениваться нативным кодом, не ограничиваясь платформенно-специфическими зависимостями.

Начиная с Kotlin 1.6.20, использование платформенно-зависимых библиотек доступно в общих исходных наборах по умолчанию. Не требуется никаких дополнительных шагов – IntelliJ IDEA поможет вам определить общие объявления, которые можно использовать в общем коде. Подробнее см. Иерархическая структура проекта.

В дополнение к платформенным библиотекам, поставляемым с Kotlin/Native, этот подход также может обрабатывать настраиваемые cinterop библиотеки, делая их доступными в общих исходных наборах. Для включения этой поддержки укажите дополнительный ключ kotlin.mpp.enableCInteropCommonization:

kotlin.mpp.enableCInteropCommonization=true