Skip to content

コンパイラープラグイン ​

コンパイラープラグインは、コンパイラー自体を変更することなく、コンパイル中のコードを解析または変更するためにコンパイルプロセスにフックします。例えば、コードにアノテーションを付加したり、他のフレームワークやAPIとの互換性を持たせるために新しいコードを生成したりできます。

このページでは、利用可能なKotlinコンパイラープラグインと、ユースケースに合うものがない場合の対処方法について説明します。

Kotlinチームは以下のコンパイラープラグインを保守・管理しています:

プラグイン説明
All-openアノテーションが付与されたクラスとそのメンバーを自動的に open にし、フレームワークが実行時にそれらを拡張できるようにします。
AtomicFUアトミック操作を、ロックフリーな並行処理のための効率的かつプラットフォーム固有の実装へと変換します。
DataFrame型安全かつKotlinフレンドリーな方法で DataFrame を操作できるようにする型付きAPIを生成します。
JPAJPAアノテーションが付与されたエンティティを open にし、引数なしコンストラクターを生成します。all-open と no-arg のラッパーです。
js-plain-objectsJSのツールやライブラリとの相互運用性を向上させるため、KotlinクラスをプレーンなJavaScriptオブジェクトとして公開します。
jvm-abi-genApplication Binary Interface (ABI) JARを生成します。
kaptKotlinコードに対してJavaアノテーションプロセッサーを実行し、追加のソースファイルを生成します。
LombokJavaソース内のLombokアノテーションによって生成されたコードを、Kotlinコードが理解して利用できるようにします。
no-arg引数なしコンストラクターを必要とするフレームワークをサポートするため、アノテーションが付与されたクラスに引数なしコンストラクターを生成します。
Power-assert式の各部分の詳細な値を表示することで、アサーション失敗時の情報を強化します。
SAM with receiverSAMインターフェースでレシーバー付きラムダを使用できるようにし、よりDSLらしい構文を実現します。
Serializationリフレクションを使わずにKotlinオブジェクトをシリアライズおよびデシリアライズするコードを生成します。
SpringSpringのアノテーションが付与されたクラスとメンバーを open にします。あらかじめ設定された all-open のラッパーです。

GoogleのAndroidチームは以下を保守・管理しています:

プラグイン説明
Compose compiler Gradle pluginComposeコンパイラーをGradleと統合し、宣言型UI機能とCompose固有の最適化を有効にします。
Parcelize pluginAndroidコンポーネント間でKotlinオブジェクトを受け渡しできるように、Parcelable の実装を自動生成します。

これらのプラグインでカバーされていない方法でコンパイルプロセスを適応させる必要がある場合は、まず Kotlin Symbol Processing (KSP) API や Android lint などの外部リンターを使用できるかどうかを確認してください。Kotlin Slack を閲覧したり、参加してご自身のユースケースについてアドバイスを求めたりすることもできます。

_それでも_必要なものが見つからない場合は、カスタムコンパイラープラグインを作成できます。ただし、KotlinコンパイラープラグインのAPIは不安定(unstable)であるため、このアプローチは最後の手段としてのみ使用してください。カスタムコンパイラープラグインを作成する場合、コンパイラーの新しいリリースごとに破壊的変更が導入されるため、継続的なメンテナンスに多大な労力を費やす必要があります。