Kotlin マルチプラットフォームを既存のプロジェクトに追加する

Android プロジェクト内に Kotlin マルチプラットフォーム（KMP）モジュールを作成するには、Kotlin マルチプラットフォーム共有モジュール テンプレートを使用します。このテンプレートは、Android Studio Meerkat と Android Gradle プラグイン バージョン 8.8.0 以降で利用できます。

モジュール テンプレートを使用すると、Android と iOS プラットフォームをターゲットとする最小構成の新しいモジュールの作成を自動化できます。

注: iOS アプリをビルドするには、Xcode がインストールされている macOS マシンが必要です。また、アプリを実行するには、iOS シミュレータをインストールするか、開発用に準備された iPhone が必要です。

共有 KMP モジュールを設定する

共有 KMP モジュールを作成するには、次の操作を行います。

1. [File] > [New] > [New Module] を選択します。
2. [Templates] パネルで [Kotlin Multiplatform Shared Module] テンプレートを選択します。

図 1. 新しい KMP モジュールを作成する

テンプレートの各フィールドは次のとおりです。

• Module name - Gradle モジュール名と iOS フレームワーク名を定義します（後で変更可能）。
• Package name - このモジュール内のファイルのパッケージ名を定義します。
  1. [完了] をクリックして、Gradle がプロジェクトと同期できるようにします。また、新しく作成されたモジュール ファイルをソース管理に追加するよう求められることもあります。

注: 生成されたモジュールには、基本的なプレースホルダ関数とテストが含まれています。これらのプレースホルダ関数により、モジュールが正常にコンパイルされ、実行されます。

完了すると、Android Studio の [プロジェクト ビュー] に、新しい共有モジュールと各プラットフォームのソースセットが表示されます。

図 2. 新しい共有モジュールを示すプロジェクト ビュー

共有モジュールを Android アプリにリンクする

モジュール ウィザードでは、新しく作成されたモジュールが既存のモジュールに依存関係として追加されることはありません。次のステップとして、他の Android 依存関係と同様に、共有モジュールを既存の Gradle モジュールのいずれかにリンクする必要があります。

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

注: プロジェクトで Gradle の型安全なプロジェクト アクセサラ機能を有効にしている場合は、projects.shared を使用して共有モジュールにアクセスできます。

有効にすると、通常どおりコードにアクセスできます。Android アプリから、androidMain または commonMain で利用可能なコードにアクセスできます。

Kotlin マルチプラットフォーム プロジェクトの構造の詳細については、Kotlin マルチプラットフォーム プロジェクトの構造の基本をご覧ください。

iOS アプリに共有モジュールを設定する

Swift は Kotlin モジュールを直接使用できないため、コンパイルされたバイナリ フレームワークを生成する必要があります。

注: Kotlin Gradle プラグインは、Swift Package Manager の統合または Cocoapods の統合もサポートしており、Kotlin とネイティブ（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
  }
}

他のアーキテクチャ タイプの定義については、階層型プロジェクト構造をご覧ください。

注: 出力フレームワークは、共有モジュールの build.gradle.kts ファイルで定義されているように、デフォルトで sharedKit と呼ばれます。独自のプロジェクトでは、xcfName 変数を制御して必要に応じて名前を変更できます。

iOS プロジェクトで共有ライブラリをリンクする

iOS プロジェクトから共有コードにアクセスできるようにするには、スクリプト フェーズを追加して、Swift ソースをコンパイルする前に Kotlin フレームワークを生成します。

注: Finder で xcodeproj ファイルをダブルクリックして Xcode プロジェクトを開くこともできます。

1. Android Studio でファイルを右クリックし、[Open In] と [Open in Associated Application] を選択します。これにより、Xcode で iOS アプリが開きます。

図 3. 関連するアプリで開く

1. プロジェクト ナビゲータでプロジェクト名をダブルクリックして、プロジェクト設定を開きます。

図 4. Xcode プロジェクト設定ダイアログ

1. このフェーズの内容を明確にするために、デフォルトの [Run Script] 名を [Compile Kotlin Framework] に変更します。[Run Script] のタイトルをダブルクリックして編集します。
2. ビルドフェーズを開き、[シェル] テキスト フィールドに次のスクリプト コードを入力します。

図 5. 実行スクリプト ビルドフェーズ

注: cd "$SRCROOT/.." は、スクリプトを KMP Gradle プロジェクトのルートフォルダ（この場合は親フォルダ）に移動します。ご使用の iOS プロジェクトが別のパスにある場合は、ここで調整する必要があります。

1. [Run Script] フェーズを [Compile Sources] フェーズの前にドラッグします。

   

   図 6. ソースをコンパイルする前にスクリプト ビルドフェーズを実行する

2. ⌘B をクリックするか、[Product] メニューに移動して [Build] を選択して、Xcode でプロジェクトをビルドします。

ビルドが成功すると、次のようなアイコンが表示されます。

図 7. ビルドが成功しました

iOS アプリで共有コードにアクセスする

iOS アプリが共有モジュールのコードに正常にアクセスできることを確認するには、次の操作を行います。

1. iOS プロジェクトで、Sources/View/ContentView.swift にある ContentView.swift ファイルを開きます。
2. ファイルの先頭にインポート sharedKit を追加します。
3. 次のように、表示される文字列に Platform_iosKt.platform() 情報を含めるように Text ビューを変更します。

注: Swift の文字列のインターポレーションでは、（コード）構文を使用します。

この更新では、アプリが共有モジュールから platform() 関数を呼び出せるかどうかを確認します。iOS プラットフォームで実行されている場合は「iOS」を返す必要があります。

図 8. iOS アプリを実行している Xcode シミュレータ

参考情報

KMP 開発を初めて行う場合は、公式の KMP ドキュメントでその他のガイドをご覧ください。iOS 開発が初めての場合は、Swift の基本に関するドキュメントをご覧ください。