Kotlin/JSコンパイラの機能
Kotlin/JSコンパイラは、JavaScriptコードを生成する前にKotlinコードを中間表現(IR)へと変換します。 この中間ステップにより、コンパイラはパフォーマンス、サイズ、開発速度の面で出力を最適化できるほか、ターゲットとするJavaScriptバージョン、モジュールシステム、TypeScript宣言ファイル、出力の粒度など、生成されるJavaScriptを細かく制御できるようになります。
ターゲットJavaScriptバージョンの設定
Kotlin/JSコンパイラは、ECMAScript標準のES5、ES2015、ES2020バージョン向けのJavaScriptを生成できます。 ターゲット環境でサポートされている最新のバージョンを選択してください。 build.gradle.ktsファイルでtargetプロパティを設定します。例えば、ES2020をターゲットにするには次のように記述します。
tasks.withType<KotlinJsCompile>().configureEach {
compilerOptions {
target = "es2020"
}
}各ターゲットで利用可能な機能については、ECMAScriptターゲットの設定を参照してください。
モジュールシステムの設定
Kotlin/JSコンパイラは、UMD、CommonJS、AMD、ES modulesなどのさまざまなモジュールシステム用のコードを生成できます。 ターゲットのモジュールシステムを選択するには、build.gradle.ktsファイルでmoduleKindコンパイラオプションを設定します。
tasks.withType<org.jetbrains.kotlin.gradle.targets.js.ir.KotlinJsIrLink> {
compilerOptions.moduleKind.set(org.jetbrains.kotlin.gradle.dsl.JsModuleKind.MODULE_COMMONJS)
}サポートされているmoduleKindの値や設定の詳細については、JavaScriptモジュールを参照してください。
TypeScript宣言ファイル(`d.ts`)の生成
Kotlin/JSコンパイラは、KotlinコードからTypeScript定義を生成できます。これらの定義は、JavaScriptツールやIDEでのコード補完や静的解析のための型情報を提供し、JavaScriptおよびTypeScriptプロジェクトでKotlin APIを利用しやすくします。
定義ファイルを生成するには、Kotlinの宣言に@JsExportアノテーションを付与し、build.gradle.ktsファイルのjs {}ブロックにgenerateTypeScriptDefinitions()関数を追加します。
kotlin {
js {
binaries.executable()
browser {
}
generateTypeScriptDefinitions()
}
}コンパイラは@JsExportでマークされたトップレベル宣言を収集し、.d.tsファイル内にTypeScript定義を生成します。
詳細については、TypeScript宣言ファイル(d.ts)の生成を参照してください。
出力の粒度の設定
コンパイラがプロジェクト内の.jsファイルをどのように出力するかを選択できます。
- モジュールごと(Per module): プロジェクトのモジュールごとに個別の
.jsファイルを生成します(デフォルト)。 - プログラム全体(Whole program): プログラム全体に対して単一の
.jsファイルを生成します。 - ファイルごと(Per file): Kotlinファイルごとに1つの
.jsファイルを生成します。エクスポートされた宣言がファイルに含まれる場合は2つのファイルを生成します(ターゲットJavaScriptバージョンがes2015およびes2020の場合に利用可能)。
粒度を変更するには、gradle.propertiesファイルでkotlin.js.ir.output.granularityプロパティを設定します。
# デフォルト: per-module
kotlin.js.ir.output.granularity=whole-programファイルごとの要件を含む設定の詳細については、出力の粒度の設定を参照してください。
トップレベルプロパティの遅延初期化
アプリケーションの起動パフォーマンスを向上させるため、Kotlin/JSコンパイラはトップレベルプロパティを遅延初期化(lazy initialization)します。これにより、コード内で使用されているすべてのトップレベルプロパティを初期化することなくアプリケーションを読み込むことができます。起動時に必要なものだけが初期化され、その他のプロパティはそれらを使用するコードが実際に実行されたときに値を受け取ります。
val a = run {
val result = // 重い計算処理
println(result)
result
} // 初回使用時に値が計算される何らかの理由でプロパティを即時初期化(アプリケーション起動時に初期化)する必要がある場合は、@EagerInitializationアノテーションを付与してください。
開発用バイナリのインクリメンタルコンパイル
Kotlin/JSコンパイラには、開発プロセスを高速化する「開発用バイナリのインクリメンタルコンパイルモード」が用意されています。 このモードでは、コンパイラはモジュールレベルでcompileDevelopmentExecutableKotlinJs Gradleタスクの結果をキャッシュします。 その後のコンパイルでは、変更されていないソースファイルに対してキャッシュされたコンパイル結果が再利用されるため、特に小さな変更を加えた場合のコンパイルがより高速に完了します。
インクリメンタルコンパイルはデフォルトで有効になっています。開発用バイナリのインクリメンタルコンパイルを無効にするには、プロジェクトのgradle.propertiesまたはlocal.propertiesに以下の行を追加してください。
# デフォルト: true
kotlin.incremental.js.ir=falseキャッシュを作成して格納する必要があるため、インクリメンタルコンパイルモードでのクリーンビルドは通常よりも遅くなります。
本番環境におけるメンバー名の最小化
Kotlin/JSコンパイラは、Kotlinのクラスや関数に関する内部的な関係情報を利用してより効率的な最小化(minification)を適用し、関数、プロパティ、クラスの名前を短縮します。これにより、結果として生成されるバンドルアプリケーションのサイズを削減できます。
このメンバー名の最小化は、Kotlin/JSアプリケーションを本番(production)モードでビルドする際に自動的に適用され、デフォルトで有効になっています。メンバー名の最小化を無効にするには、-Xir-minimized-member-namesコンパイラオプションを使用します。
kotlin {
js {
compilations.all {
compileTaskProvider.configure {
compilerOptions.freeCompilerArgs.add("-Xir-minimized-member-names=false")
}
}
}
}デッドコード削除
デッドコード削除(DCE: Dead code elimination)は、使用されていないプロパティ、関数、クラスを削除することで、生成されるJavaScriptコードのサイズを削減します。
未使用の宣言は、以下のようなケースで発生します。
- 関数がインライン化され、直接呼び出されることがない場合(ごく一部のケースを除き、常に発生します)。
- モジュールが共有ライブラリを使用している場合。DCEがないと、使用していないライブラリの部分もバンドル結果に含まれたままになります。例えば、Kotlin標準ライブラリにはリスト、配列、文字列操作用の関数やDOM用のアダプターなどが含まれています。この全機能はJavaScriptファイルとして約1.3 MBを占めます。単純な「Hello, world」アプリケーションが必要とするのはコンソールルーチンだけであり、ファイル全体でもわずか数キロバイトで済みます。
Kotlin/JSコンパイラでは、DCEは自動的に処理されます。
以下のGradleタスクに対応する「開発(development)」バンドルタスクでは、DCEが無効になります。
jsBrowserDevelopmentRunjsBrowserDevelopmentWebpackjsNodeDevelopmentRuncompileDevelopmentExecutableKotlinJscompileDevelopmentLibraryKotlinJs- 名前に「development」が含まれるその他のGradleタスク
以下のGradleタスクに対応する「本番(production)」バンドルをビルドする場合、DCEが有効になります。
jsBrowserProductionRunjsBrowserProductionWebpackcompileProductionExecutableKotlinJscompileProductionLibraryKotlinJs- 名前に「production」が含まれるその他のGradleタスク
@JsExportアノテーションを使用すると、DCEにルート(削除対象外の基点)として扱わせたい宣言を指定できます。
