Kotlin Multiplatform クイックスタート

このチュートリアルでは、シンプルな Kotlin Multiplatform アプリケーションをすばやく起動して実行できます。

環境設定

Kotlin Multiplatform (KMP) プロジェクトには特定の環境が必要ですが、ほとんどの要件は IDE のプリフライトチェックによって明確にされます。

IDE と必要なプラグインから始めます。

IDE を選択してインストールします。 Kotlin Multiplatform は IntelliJ IDEA および Android Studio でサポートされているため、お好みの IDE を使用できます。
JetBrains Toolbox App は、IDE をインストールするための推奨ツールです。これにより、複数の製品やバージョン（早期アクセスプログラム (EAP) や Nightly リリースを含む）を管理できます。
スタンドアロンインストールの場合、IntelliJ IDEA または Android Studio のインストーラーをダウンロードしてください。
Kotlin Multiplatform に必要なプラグインは、IntelliJ IDEA 2025.1.1.1 または Android Studio Narwhal 2025.1.1 を必要とします。
Kotlin Multiplatform IDE プラグインをインストールします (Kotlin Multiplatform Gradle プラグインと混同しないように)。
Kotlin Multiplatform プラグインは、Windows または Linux の IDE ではまだ利用できません。しかし、これらのプラットフォームで厳密に必要というわけでもありません。 KMP プロジェクトを生成して実行するためのチュートリアルは引き続き実行できます。
IntelliJ IDEA 用の Kotlin Multiplatform IDE プラグインをインストールすると、まだ持っていない場合は必要なすべての依存関係もインストールされます (Android Studio には必要なすべてのプラグインがバンドルされています)。
Windows または Linux 用の IntelliJ IDEA を使用している場合は、必要なすべてのプラグインを手動でインストールしていることを確認してください。
- Android
- Android Design Tools
- Jetpack Compose
- Native Debugging Support
- Compose Multiplatform for Desktop IDE Support (Kotlin Multiplatform プラグインがない場合にのみ必要です)。
ANDROID_HOME 環境変数が設定されていない場合は、システムがそれを認識するように設定します。
Bash または ZshWindows PowerShell または CMD
以下のコマンドを .profile または .zprofile に追加します。
shell
export ANDROID_HOME=~/Library/Android/sdk
PowerShell の場合、以下のコマンドで永続的な環境変数を追加できます (詳細は PowerShell ドキュメントを参照してください)。
shell
[Environment]::SetEnvironmentVariable('ANDROID_HOME', '<path to the SDK>', 'Machine')
CMD の場合、setx コマンドを使用します。
shell
setx ANDROID_HOME "<path to the SDK>"
iOS アプリケーションを作成するには、Xcode がインストールされた macOS ホストが必要です。 IDE は内部で Xcode を実行し、iOS フレームワークをビルドします。
KMP プロジェクトの作業を開始する前に、少なくとも一度は Xcode を起動し、初期設定を完了させてください。
Xcode が更新されるたびに手動で起動し、更新されたツールをダウンロードする必要があります。 Kotlin Multiplatform IDE プラグインは、Xcode が作業に適した状態でない場合に警告を発するプリフライトチェックを行います。

プロジェクトを作成

macOS の場合

macOS では、Kotlin Multiplatform プラグインが IDE 内でプロジェクト生成ウィザードを提供します。

IntelliJ IDEAAndroid Studio

IDE ウィザードを使用して新しい KMP プロジェクトを作成します。

メインメニューで File | New | Project を選択します。
左側のリストから Kotlin Multiplatform を選択します。
必要に応じて、プロジェクトの名前、場所、その他の基本属性を設定します。
プロジェクトの JDK として JetBrains Runtime (JBR) のバージョンを選択することを推奨します。これは、特にデスクトップ KMP アプリの互換性を向上させる上で重要な修正を提供するためです。関連するバージョンの JBR はすべての IntelliJ IDEA ディストリビューションに含まれているため、追加の設定は必要ありません。
プロジェクトの一部として含めたいプラットフォームを選択します。
- すべてのターゲットプラットフォームは、最初から Compose Multiplatform を使用して UI コードを共有するように設定できます (UI コードを持たないサーバーモジュールを除く)。
- iOS の場合、2つの実装のいずれかを選択できます。
  - Compose Multiplatform を使用した共有 UI コード
  - SwiftUI で作成され、共有ロジックを持つ Kotlin モジュールに接続された完全なネイティブ UI
- デスクトップターゲットには、Compose Hot Reload 機能のアルファ版が含まれており、対応するコードを変更するとすぐに UI の変更を確認できます。デスクトップアプリを作成する予定がない場合でも、UI コードの作成を高速化するためにデスクトップバージョンを使用することをお勧めします。

プラットフォームの選択が完了したら、Create ボタンをクリックし、IDE がプロジェクトを生成してインポートするのを待ちます。

IntelliJ IDEA ウィザードのデフォルト設定で Android、iOS、デスクトップ、および Web プラットフォームが選択されている

Kotlin Multiplatform IDE プラグインは K2 機能に大きく依存しており、それがなければ記載どおりに動作しません。したがって、開始する前に K2 モードが有効になっていることを確認してください。 Settings | Languages & Frameworks | Kotlin | Enable K2 mode。

IDE ウィザードを使用して新しい KMP プロジェクトを作成します。

メインメニューで File | New | New project を選択します。
デフォルトの Phone and Tablet テンプレートカテゴリから Kotlin Multiplatform を選択します。
必要に応じて、プロジェクトの名前、場所、その他の基本属性を設定し、Next をクリックします。
プロジェクトの一部として含めたいプラットフォームを選択します。
- すべてのターゲットプラットフォームは、最初から Compose Multiplatform を使用して UI コードを共有するように設定できます (UI コードを持たないサーバーモジュールを除く)。
- iOS の場合、2つの実装のいずれかを選択できます。
  - Compose Multiplatform を使用した共有 UI コード
  - SwiftUI で作成され、共有ロジックを持つ Kotlin モジュールに接続された完全なネイティブ UI
- デスクトップターゲットには、ホットリロード機能のアルファ版が含まれており、対応するコードを変更するとすぐに UI の変更を確認できます。デスクトップアプリを作成する予定がない場合でも、UI コードの作成を高速化するためにデスクトップバージョンを使用することをお勧めします。
プロジェクトが生成されたら、プロジェクトの JDK として JetBrains Runtime (JBR) のバージョンを選択することを推奨します。これは、特にデスクトップ KMP アプリの互換性を向上させる上で重要な修正を提供するためです。関連するバージョンの JBR はすべての IntelliJ IDEA ディストリビューションに含まれているため、追加の設定は必要ありません。

プラットフォームの選択が完了したら、Finish ボタンをクリックし、IDE がプロジェクトを生成してインポートするのを待ちます。

Android、iOS、デスクトップ、および Web プラットフォームが選択された Android Studio ウィザードの最後のステップ

Windows または Linux の場合

Windows または Linux を使用している場合:

Web KMP ウィザードを使用してプロジェクトを生成します。
アーカイブを解凍し、生成されたフォルダを IDE で開きます。
インポートが完了するのを待ってから、undefined セクションに進み、アプリのビルドと実行方法について学習します。

プリフライトチェックを確認する

Project Environment Preflight Checks ツールウィンドウを開いて、プロジェクト設定に環境の問題がないことを確認できます。右サイドバーまたは下部バーにあるプリフライトチェックアイコンをクリックします飛行機のプリフライトチェックアイコン

このツールウィンドウでは、これらのチェックに関連するメッセージを確認したり、再実行したり、設定を変更したりできます。

プリフライトチェックコマンドは、Search Everywhere ダイアログでも利用できます。 Shift を2回押して、「preflight」という単語を含むコマンドを検索します。

「preflight」という単語が入力された Search Everywhere メニュー

サンプルアプリを実行する

IDE ウィザードによって作成されたプロジェクトには、iOS、Android、デスクトップ、Web アプリケーション用の生成された実行設定、およびサーバーアプリを実行するための Gradle タスクが含まれています。 Windows および Linux の場合、各プラットフォームの Gradle コマンドについては以下を参照してください。

AndroidiOSデスクトップWeb

Android アプリを実行するには、composeApp 実行設定を開始します。

Android 実行設定がハイライトされたドロップダウン

Windows または Linux で Android アプリを実行するには、Android App 実行設定を作成し、モジュールを [プロジェクト名].composeApp に選択します。

デフォルトでは、利用可能な最初の仮想デバイスで実行されます。

仮想デバイスで実行された Android アプリ

iOS アプリをビルドするには macOS ホストが必要です。

プロジェクトの iOS ターゲットを選択し、Xcode がインストールされた macOS マシンを設定した場合、 iosApp 実行設定を選択し、シミュレートされたデバイスを選択できます。

iOS 実行設定がハイライトされたドロップダウン

iOS アプリを実行すると、内部で Xcode を使用してビルドされ、iOS シミュレーターで起動されます。最初のビルドでは、コンパイルのためにネイティブ依存関係を収集し、その後の実行のためにビルドをウォームアップします。

仮想デバイスで実行された iOS アプリ

デスクトップアプリのデフォルトの実行設定は、composeApp [desktop] として作成されます。

デフォルトのデスクトップ実行設定がハイライトされたドロップダウン

Windows または Linux でデスクトップアプリを実行するには、以下のコマンドで [アプリ名]:composeApp Gradle プロジェクトを指す Gradle 実行設定を作成します。

shell

desktopRun -DmainClass=com.example.myapplication.MainKt --quiet

この設定により、JVM デスクトップアプリを実行できます。

仮想デバイスで実行された JVM アプリ

Web アプリのデフォルトの実行設定は、composeApp [wasmJs] として作成されます。

デフォルトの Wasm 実行設定がハイライトされたドロップダウン

Windows または Linux で Web アプリを実行するには、以下のコマンドで [アプリ名]:composeApp Gradle プロジェクトを指す Gradle 実行設定を作成します。

shell

wasmJsBrowserDevelopmentRun

この設定を実行すると、IDE は Kotlin/Wasm アプリをビルドし、デフォルトのブラウザで開きます。

仮想デバイスで実行された Web アプリ

トラブルシューティング

Java および JDK

Java に関する一般的な問題:

一部のツールが Java バージョンを見つけられなかったり、間違ったバージョンを使用したりする場合があります。これを解決するには:
- JAVA_HOME 環境変数を適切な JDK がインストールされているディレクトリに設定します。
  クラス再定義をサポートする OpenJDK フォークである JetBrains Runtime の使用をお勧めします。
- JAVA_HOME 内の bin フォルダへのパスを PATH 変数に追加し、JDK に含まれるツールがターミナルで利用可能になるようにします。
Android Studio での Gradle JDK に関する問題に遭遇した場合は、正しく設定されていることを確認してください。 Settings | Build, Execution, Deployment | Build Tools | Gradle を選択します。

Android ツール

JDK と同様に、adb などの Android ツールを起動する際に問題がある場合は、ANDROID_HOME/tools、ANDROID_HOME/tools/bin、および ANDROID_HOME/platform-tools へのパスが PATH 環境変数に追加されていることを確認してください。

Xcode

iOS 実行設定が実行する仮想デバイスがないと報告する場合は、Xcode を起動し、iOS シミュレーターのアップデートがないか確認してください。

ヘルプ

Kotlin Slack。招待を取得し、#multiplatform チャンネルに参加してください。
Kotlin Multiplatform Tooling イシュートラッカー。新しい問題を報告してください。

次にすること

KMP プロジェクトの構造と共有コードの作成について詳しく学習します。

共有 UI コードの使用に関するチュートリアルのシリーズ: Compose Multiplatform アプリを作成する
ネイティブ UI と共有コードの使用に関するチュートリアルのシリーズ: Kotlin Multiplatform アプリを作成する
Kotlin Multiplatform ドキュメントを詳しく確認します。
- プロジェクト設定
- マルチプラットフォーム依存関係の使用
Compose Multiplatform UI フレームワーク、その基本、およびプラットフォーム固有の機能について学習します。 Compose Multiplatform と Jetpack Compose。

KMP 向けにすでに書かれたコードを見つける。

公式 JetBrains サンプルと、KMP の機能を示す厳選されたプロジェクトリストを含むサンプルページ。
GitHub トピック:
- kotlin-multiplatform、Kotlin Multiplatform で実装されたプロジェクト。
- kotlin-multiplatform-sample、 KMP で書かれたサンプルプロジェクトのリスト。
klibs.io – KMP ライブラリの検索プラットフォーム。これまでに OkHttp、Ktor、Coil、Koin、SQLDelight など、2000以上のライブラリがインデックス化されています。

Kotlin Multiplatform クイックスタート ​

環境設定 ​

プロジェクトを作成 ​

macOS の場合 ​

Windows または Linux の場合 ​

プリフライトチェックを確認する ​

サンプルアプリを実行する ​

トラブルシューティング ​

Java および JDK ​

Android ツール ​

Xcode ​

ヘルプ ​

次にすること ​