Skip to content
Beta

Build tools API

BTAはKotlin/JVM、Kotlin/JS、Kotlin/Wasmをサポートしています。

現在、Kotlin/Nativeはサポートしていません。

Kotlinには、ビルドシステムとKotlinコンパイラの統合を簡素化するBuild tools API (BTA) が用意されています。

ビルドシステムに完全なKotlinサポート(インクリメンタルコンパイル、Kotlinコンパイラプラグイン、デーモン、Kotlinマルチプラットフォームなど)を追加するには、多大な労力が必要でした。BTAは、ビルドシステムとKotlinコンパイラのエコシステム間に統一されたAPIを提供することで、この複雑さを軽減することを目指しています。

BTAは、ビルドシステムが実装可能な単一のエントリポイントを定義します。これにより、コンパイラの内部詳細に深く統合する必要がなくなります。

安定性レベルはターゲットごとに異なります。BTAはKotlin/JVM向けにはベータ版であり、Kotlin/JSおよびKotlin/Wasm向けにはアルファ版です。 詳細については、ビルドツール API (BTA)を参照してください。BTAを使用するには、@OptIn(ExperimentalBuildToolsApi::class) によるオプトインが必要です。

プロポーザルに関心がある場合やフィードバックを共有したい場合は、KEEPを参照してください。 実装のステータスはYouTrackで追跡できます。

Gradleとの統合 ​

Kotlin Gradleプラグイン (KGP) は、デフォルトでKotlin/JVMコンパイルにBTAを使用します。

KGPでの使用体験に関するフィードバックをYouTrackでお待ちしております。

Alpha

Kotlin/JS、Kotlin/Wasm、およびKotlinメタデータでのBTAの有効化

Kotlin 2.4.20以降、KGPはBTAを介してKotlin/JS、Kotlin/Wasm、およびKotlinメタデータのコンパイルを実行できるようになりました。 これにより、KGPはコンパイラとより一貫して連携できるようになり、場合によってはコンパイルがより高速かつ安定します。

Kotlin 2.4.20では、これらのターゲットはオプトインとして利用可能です。試すには、gradle.properties ファイルに対応するプロパティを追加してください:

none
kotlin.js.runViaBuildToolsApi = true
kotlin.wasm.runViaBuildToolsApi = true
kotlin.metadata.runViaBuildToolsApi = true

異なるコンパイラバージョンの構成 ​

BTAを使用すると、KGPで使用されているバージョンとは異なるKotlinコンパイラバージョンを使用できるようになります。これは以下のような場合に便利です:

  • 新しいKotlin機能を試したいが、ビルドスクリプトをまだ更新していない場合。
  • 最新のプラグインの修正が必要だが、現在は古いコンパイラバージョンを使い続けたい場合。

build.gradle.kts ファイルでの設定例は以下の通りです:

kotlin
import org.jetbrains.kotlin.buildtools.api.ExperimentalBuildToolsApi
import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi

plugins {
    kotlin("jvm") version "2.4.20"
}

group = "org.jetbrains.example"
version = "1.0-SNAPSHOT"

repositories {
    mavenCentral()
}

kotlin {
    jvmToolchain(8)
    @OptIn(ExperimentalBuildToolsApi::class, ExperimentalKotlinGradlePluginApi::class)
    compilerVersion.set("2.3.21") // <-- 2.4.20とは異なるバージョン
}

互換性のあるKotlinコンパイラおよびKGPバージョン ​

BTAは以下をサポートしています:

  • 前の3つのメジャーKotlinコンパイラバージョン。
  • 1つ先のメジャーバージョン。

例えば、KGP 2.2.0において、サポートされるKotlinコンパイラバージョンは以下の通りです:

  • 1.9.25
  • 2.0.x
  • 2.1.x
  • 2.2.x
  • 2.3.x

制限事項 ​

異なるコンパイラバージョンをコンパイラプラグインと一緒に使用すると、Kotlinコンパイラの例外が発生する可能性があります。Kotlinチームは将来のKotlinリリースでこれに対処する予定です。

「in-process」戦略でのインクリメンタルコンパイルの有効化 ​

KGPは3つのコンパイラ実行戦略をサポートしています。 通常、「in-process」戦略(Gradleデーモン内でコンパイラを実行する)はインクリメンタルコンパイルをサポートしていません。

BTAを使用すると、「in-process」戦略でインクリメンタルコンパイルがサポートされるようになります。有効にするには、gradle.properties ファイルに以下のプロパティを追加します:

kotlin
kotlin.compiler.execution.strategy=in-process

Mavenとの統合 ​

BTAにより、kotlin-maven-plugin が Kotlinデーモン をサポートできるようになります。これはデフォルトの コンパイラ実行戦略 です。kotlin-maven-plugin はデフォルトでBTAを使用するため、設定の必要はありません。

BTAにより、将来的に インクリメンタルコンパイルの安定化 などのより多くの機能を提供することが可能になります。