マルチプラットフォームライブラリへの依存関係の追加
すべてのプログラムが正常に動作するには、一連のライブラリが必要です。 Kotlin Multiplatform プロジェクトは、複数のターゲットプラットフォームをサポートするクロスプラットフォームライブラリ、プラットフォーム固有のライブラリ、および他のマルチプラットフォームプロジェクトに依存できます。
Android アプリの開発経験がある場合、マルチプラットフォーム依存関係の追加は、通常の Android プロジェクトに Gradle の依存関係を追加するのと似ています。 主な違いは、モジュール全体ではなく、特定のソースセット(source set)に依存関係を追加する必要がある点です。
このページでは、マルチプラットフォームプロジェクトにおける依存関係管理の全体的なアプローチについて説明します。 プラットフォーム固有の詳細については、Android の依存関係の追加および iOS の依存関係の追加を参照してください。
依存関係の種類
Kotlin Multiplatform プロジェクトで使用できる依存関係には、主に2つの種類があります。
マルチプラットフォーム依存関係。これらは複数のターゲットをサポートし、共通ソースセット(common source set)で使用できるマルチプラットフォームライブラリです。
Koin、Coil、SQLDelight など、多くの最新の Android ライブラリはすでにマルチプラットフォームをサポートしています。
公開されている Kotlin Multiplatform ライブラリのカタログである klibs.io で、さらに多くのマルチプラットフォームライブラリを探すことができます。
ネイティブ依存関係。これらは、対応するエコシステム由来のプラットフォーム固有のライブラリです。 ネイティブプロジェクトでは通常、Android の Gradle や iOS の Swift Package Manager など、プラットフォーム固有のツールを使用してこれらのライブラリを管理します。
マルチプラットフォームプロジェクトのモジュールで作業する場合でも、通常、セキュアストレージやシステムコールなどのプラットフォーム API を使用するためにネイティブ依存関係が必要になります。 ビルドスクリプトでは、
androidMainやiosMainなどのネイティブソースセットの設定でネイティブ依存関係を指定します。
どちらの種類の依存関係でも、ローカルリポジトリと外部リポジトリの両方を使用できます。
Gradle バージョンカタログ
Gradle を使用する場合、依存関係の管理にはバージョンカタログ (version catalogs) を使用することをお勧めします。
バージョンカタログを使用すると、カタログ内でアーティファクト名とバージョンを定義し、その定義をビルドスクリプトファイル内で参照できます。
たとえば、基本的なカタログファイルは次のようになります。
# libs.versions.toml (デフォルトのカタログファイル)
[versions]
my-library = "1.0"
[libraries]
my-library = {module = "com.example:my-library", version.ref = "my-library"}そして、このカタログを使用して依存関係を追加する例は次のとおりです。
// build.gradle.kts
dependencies {
// 'libs' はカタログファイル名の最初の部分です
// 'my.library' は名前空間を除いたアーティファクト名で、
// ダッシュの代わりにドットが使用されます
implementation(libs.my.library)
}コア Kotlin ライブラリへの依存関係
標準ライブラリ
Kotlin Multiplatform プロジェクトの各ソースセットは、自動的に Kotlin 標準ライブラリ (kotlin-stdlib) に依存します。 標準ライブラリのバージョンは、適用されている Kotlin Multiplatform Gradle プラグインのバージョンと同じになります。
プラットフォーム固有のソースセットに対して、Gradle は対応するプラットフォーム固有のライブラリバリアントを自動的に使用し、残りのソースセットには共通の標準ライブラリが追加されます。 JVM ターゲットの場合、Kotlin Gradle プラグインは、Gradle ビルドスクリプトの compilerOptions.jvmTarget コンパイラオプションに応じて、適切な JVM 標準ライブラリを選択します。
デフォルトの kotlin-stdlib 依存関係の解決方法を変更する方法については、標準ライブラリへの依存関係の変更を参照してください。
テストライブラリ
マルチプラットフォームのテストには、kotlin.test API が利用可能です。 これはマルチプラットフォームライブラリであるため、commonTest ソースセットに単一の依存関係を指定するだけで、すべてのテストソースセットにテスト依存関係を追加できます。
kotlin {
//...
sourceSets {
// すべてのテストソースセットで kotlin.test のクラスを利用可能にします
commonTest.dependencies {
implementation(kotlin("test"))
}
}
}kotlin {
//...
sourceSets {
// すべてのテストソースセットで kotlin.test のクラスを利用可能にします
commonTest {
dependencies {
implementation kotlin("test")
}
}
}
}kotlinx ライブラリ
kotlinx ライブラリは、JetBrains のコア Kotlin チームによって保守されているマルチプラットフォームライブラリです (代表例として kotlinx.serialization や kotlinx.coroutines があります)。
他のマルチプラットフォームライブラリと同様に、依存関係を追加するには、対応するソースセットでライブラリアーティファクトを参照します。
kotlinx ライブラリは、Web ターゲット用など、より複雑なセットアップが必要になる場合があります。 詳細な手順については、各ライブラリのドキュメントを参照してください。
Kotlin Multiplatform ライブラリへの依存関係
SQLDelight など、Kotlin Multiplatform を採用しているライブラリへの依存関係を追加できます。 このようなライブラリの作者は通常、プロジェクトへの依存関係の追加方法に関するガイドを提供しています。
klibs.io で Kotlin Multiplatform ライブラリを探す
Gradle バージョンカタログのサンプル
Gradle を使用する場合は、バージョンカタログを使用することをお勧めします。 以下の例で使用されるすべてのライブラリを定義したバージョンカタログを次に示します。
[versions]
ktor = "3.5.2"
kotlinx-coroutines = "1.11.0"
sqlDelight = "2.3.2"
[libraries]
ktor-clientCore = { module = "io.ktor:ktor-client-core", version.ref = "3.5.2" }
kotlinx-coroutinesCore = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "1.11.0" }
sqldelight-nativeDriver = { module = "com.squareup.sqldelight:native-driver", version.ref = "2.3.2" }すべてのソースセットで共有されるライブラリ
すべてのソースセットからライブラリにアクセスしたい場合、またはそれを使用して共有コードを記述したい場合は、共通ソースセット(common source set)にのみライブラリを追加します。 Kotlin Multiplatform Gradle プラグインが、宣言されている他のソースセットに対応するプラットフォーム固有のアーティファクトを自動的に解決します。
共通ソースセットはプラットフォーム固有のアーティファクトに依存できません。 共通コードは、宣言されているすべてのターゲットに対してコンパイルできる必要があるためです。
kotlin {
//...
sourceSets {
commonMain.dependencies {
implementation(libs.ktor.clientCore)
}
androidMain.dependencies {
// ktor-client のプラットフォーム固有部分への依存関係は、
// ビルド時に解決されます
}
}
}kotlin {
//...
sourceSets {
commonMain {
dependencies {
implementation(libs.ktor.clientCore)
}
}
androidMain {
dependencies {
// ktor-client のプラットフォーム固有部分への依存関係は、
// ビルド時に解決されます
}
}
}
}トップレベルの dependencies {} ブロックで共通ライブラリを設定することもできます。 トップレベルでの依存関係の設定を参照してください。
特定のソースセットで使用されるライブラリ
特定のソースセットでのみマルチプラットフォームライブラリを使用したい場合は、そのソースセットにのみ追加できます。 その場合、そのライブラリの宣言は、追加したソースセット内でのみ利用可能になります。
このような場合、プラットフォーム固有の名前ではなく、共通のライブラリ名を使用してください。 Kotlin Multiplatform Gradle プラグインがこれらの参照を自動的に解決します。 正確な名前については、各ライブラリのドキュメントに記載されているはずです。
以下は、プラットフォーム固有の SQLDelight に native-driver-iosx64 の代わりに native-driver を使用する例です。
kotlin {
//...
sourceSets {
commonMain.dependencies {
// kotlinx.coroutines はすべてのソースセットで利用可能
implementation(libs.kotlinx.coroutinesCore)
}
androidMain.dependencies {
// Android固有の依存関係を記述する場所
}
iosMain.dependencies {
// SQLDelight は iOS ソースセットで利用可能ですが、
// Android や common ソースセットでは利用できません
implementation(libs.sqldelight.nativeDriver)
}
}
}kotlin {
//...
sourceSets {
commonMain {
dependencies {
// kotlinx.coroutines はすべてのソースセットで利用可能
implementation(libs.kotlinx.coroutinesCore)
}
}
androidMain {
dependencies {
// Android固有の依存関係を記述する場所
}
}
iosMain {
dependencies {
// SQLDelight は iOS ソースセットで利用可能ですが、
// Android や common ソースセットでは利用できません
implementation(sqldelight.nativeDriver)
}
}
}
}他のマルチプラットフォームプロジェクトへの依存関係
あるマルチプラットフォームプロジェクトを、別のマルチプラットフォームプロジェクトに依存させることができます。 これを設定するには、依存関係を必要とするソースセットに Gradle プロジェクト依存関係を追加します。 すべてのソースセットでプロジェクト依存関係を使用したい場合は、共通ソースセットに追加します。 この場合、コンパイラは他のソースセットに対しても、そのプロジェクトのプラットフォーム固有アーティファクトを自動的に提供します。
kotlin {
//...
sourceSets {
commonMain.dependencies {
implementation(project(":some-other-multiplatform-module"))
}
androidMain.dependencies {
// :some-other-multiplatform-module のプラットフォーム固有の宣言は
// 自動的に解決されます
}
}
}kotlin {
//...
sourceSets {
commonMain {
dependencies {
implementation project(':some-other-multiplatform-module')
}
}
androidMain {
dependencies {
// :some-other-multiplatform-module のプラットフォーム固有の宣言は
// 自動的に解決されます
}
}
}
}次のステップ
マルチプラットフォームプロジェクトにおける依存関係の追加に関するその他のリソースをチェックし、以下について詳しく学びましょう。
- Android の依存関係の追加
- iOS の依存関係の追加
- サンプルプロジェクトでの Android および iOS ライブラリの使用
ヘルプの入手
- Kotlin Slack。招待を受け取って #multiplatform チャンネルに参加してください。
- Kotlin イシュートラッカー。新しいイシューを報告してください。
