プラットフォーム間でのコード共有
Kotlin Multiplatformを使用すると、Kotlinが提供するメカニズムを利用してコードを共有できます。
- プロジェクトで使用されるすべてのプラットフォーム間でのコード共有:すべてのプラットフォームに適用される共通のビジネスロジックを共有するために使用します。
- プロジェクトに含まれる一部のプラットフォーム間でのコード共有:プロジェクトに含まれる一部(すべてではない)のプラットフォーム間でコードを共有します。階層構造を利用することで、類似したプラットフォーム間でコードを再利用できます。
共有コードからプラットフォーム固有のAPIにアクセスする必要がある場合は、Kotlinのexpected宣言とactual宣言のメカニズムを使用してください。
すべてのプラットフォームでのコード共有
すべてのプラットフォームで共通するビジネスロジックがある場合、プラットフォームごとに同じコードを書く必要はありません。共通のソースセット(common source set)で共有するだけです。
ソースセットの一部の依存関係はデフォルトで設定されています。手動で dependsOn の関係を指定する必要はありません。
jvmMainやmacosArm64Mainなど、共通ソースセットに依存するすべてのプラットフォーム固有ソースセット向け。androidMainとandroidUnitTestなど、特定のターゲットのmainソースセットとtestソースセット間。
共有コードからプラットフォーム固有のAPIにアクセスする必要がある場合は、Kotlinのexpected宣言とactual宣言のメカニズムを使用してください。
類似したプラットフォーム間でのコード共有
多くの共通ロジックやサードパーティAPIを再利用できる可能性のある、複数のネイティブターゲットを作成する必要が生じることはよくあります。
たとえば、iOSをターゲットとする典型的なマルチプラットフォームプロジェクトでは、2つのiOS関連ターゲットがあります。1つはiOS ARM64デバイス用、もう1つはx64シミュレーター用です。これらにはプラットフォーム固有の個別のソースセットがありますが、実際にはデバイス用とシミュレーター用で異なるコードが必要になることはめったになく、依存関係もほぼ同じです。そのため、iOS固有のコードはそれらの間で共有できます。
明らかに、このような構成では、2つのiOSターゲット用の共有ソースセットを持ち、iOSデバイスとシミュレーターの両方に共通する任意のAPIを直接呼び出すことができるKotlin/Nativeコードを用意することが望ましいでしょう。
このような場合、階層構造を利用して、以下のいずれかの方法でプロジェクト内のネイティブターゲット間でコードを共有できます。
詳細については、ライブラリでのコード共有およびプラットフォーム固有のライブラリの連携を参照してください。
ライブラリでのコード共有
階層的なプロジェクト構造のおかげで、ライブラリもターゲットのサブセットに対して共通APIを提供できます。ライブラリが公開されると、中間ソースセット(intermediate source set)のAPIがプロジェクト構造に関する情報とともにライブラリ成果物(アーティファクト)に埋め込まれます。このライブラリを使用すると、プロジェクトの中間ソースセットは、各ソースセットのターゲットで利用可能なライブラリのAPIにのみアクセスします。
たとえば、kotlinx.coroutines リポジトリの以下のソースセット階層を確認してください。
concurrent ソースセットは runBlocking 関数を宣言し、JVMおよびネイティブターゲット向けにコンパイルされます。kotlinx.coroutines ライブラリが階層的なプロジェクト構造で更新・公開されると、ライブラリの concurrent ソースセットの「ターゲットシグネチャ」と一致するため、JVMとネイティブターゲット間で共有されているソースセットからこのライブラリに依存し、runBlocking を呼び出すことができます。
プラットフォーム固有のライブラリの連携
プラットフォーム固有の依存関係に制約されることなく、より多くのネイティブコードを共有するには、Foundation、UIKit、POSIXなどのプラットフォームライブラリを使用します。これらのライブラリはKotlin/Nativeに同梱されており、デフォルトで共有ソースセット内で利用可能です。
さらに、プロジェクトで Kotlin CocoaPods Gradle プラグインを使用している場合は、cinterop メカニズムで取り込んだサードパーティのネイティブライブラリを操作できます。
