コマンドラインからのKSPの実行
ほとんどのプロジェクトでは、コンパイル中に自動的にKSPを実行するGradle用KSPプラグインを介してKSPを使用します。別の方法として、コマンドラインからKSPを実行することも可能です。これは、KSPを他のビルドシステムと統合したり、プロセッサを開発したり、コードのテストやデバッグを行ったりする場合に役立ちます。
KSPはJVMアプリケーションであるため、コマンドラインからKSPを起動するには java コマンドを使用します。クラスパスと必要な引数を指定してください。
java -cp <classpath> <mainclass> <options> <processor>| 引数 | 説明 |
|---|---|
<classpath> | KSPランタイムJARファイルおよびその依存関係へのパス。 |
<mainclass> | プラットフォーム固有のKSPエントリーポイント。 |
<options> | KSPのコマンドラインオプション。 |
<processor> | プロセッサのJARへのパス。 |
クラスパス
Gradle用のKSPプラグインとは異なり、java コマンドは自動的に依存関係を解決しません。クラスパス上にKSPランタイムJARファイルとその依存関係を指定する必要があります。
GitHubのKSPリリースページから artifacts.zip をダウンロードしてください。このアーカイブには、必要なKSP JARファイルが含まれています。
symbol-processing-aa-2.3.12.jarsymbol-processing-common-deps-2.3.12.jarsymbol-processing-api-2.3.12.jar
また、Mavenリポジトリから以下のランタイム依存関係も含める必要があります。
メインクラス
KSPはJVMアプリケーションであるため、起動するメインクラスを指定する必要があります。KSPはサポートされているプラットフォームごとに異なるエントリーポイントを提供します。
| エントリーポイント | プラットフォーム |
|---|---|
KSPJvmMain | Kotlin/JVMおよびAndroid |
KSPJsMain | Kotlin/JS |
KSPNativeMain | iOS、macOS、Linux、WindowsなどのKotlin/Nativeターゲット |
KSPCommonMain | Kotlin Multiplatformプロジェクトにおけるコモン(共通)コンパイル |
java でKSPを起動する際は、完全修飾クラス名(FQCN)を指定してください。例:
java -cp <classpath> com.google.devtools.ksp.cmdline.KSPJvmMain <options> <processor>次の例では、KSPJvmMain を使用してJVMターゲット向けにKSPを実行しています。
java -cp \
symbol-processing-aa-2.3.12.jar:\
symbol-processing-common-deps-2.3.12.jar:\
symbol-processing-api-2.3.12.jar:\
kotlin-stdlib-2.4.21.jar:\
kotlinx-coroutines-core-jvm-1.11.0.jar \
com.google.devtools.ksp.cmdline.KSPJvmMain \
-language-version=2.0 \
-api-version=2.0 \
-jvm-target=11 \
-module-name=main \
-source-roots=project_dir/src/kotlin/main \
-project-base-dir=project_dir/ \
-output-base-dir=project_dir/build/ \
-caches-dir=project_dir/build/caches/ \
-class-output-dir=project_dir/build/out/main/classes \
-kotlin-output-dir=project_dir/build/out/main/kotlin/ \
-java-output-dir=project_dir/build/out/main/java/ \
-resource-output-dir=project_dir/build/out/main/res/ \
path/to/processor.jarオプション
KSPJvmMain エントリーポイントには、以下のオプションが必要です。
| オプション | 説明 |
|---|---|
-language-version=<version> | プロジェクトで使用されているKotlin言語バージョン。 |
-api-version=<version> | Kotlin APIバージョン。 |
-jvm-target=<version> | ターゲットJVMバージョン。 |
-module-name=<name> | モジュール名。 |
-source-roots=<paths> | ソースルートディレクトリ。複数のディレクトリを指定する場合はコロン区切りのリストを使用します。 |
-project-base-dir=<path> | プロジェクトのルートディレクトリ。 |
-output-base-dir=<path> | KSP出力用のベースディレクトリ。 |
-caches-dir=<path> | KSPキャッシュ用のディレクトリ。 |
-java-output-dir=<path> | 生成されたJavaファイル用のディレクトリ。 |
-class-output-dir=<path> | 生成されたクラスファイル用のディレクトリ。 |
-kotlin-output-dir=<path> | 生成されたKotlinファイル用のディレクトリ。 |
-resource-output-dir=<path> | 生成されたリソース用のディレクトリ。 |
<processor> | プロセッサのクラスパス。 |
他のエントリーポイントでは、異なるオプションのセットが使用されます。特定のエントリーポイントのオプションの完全なリストを確認するには、次のコマンドを実行してください。
java -cp <classpath> <mainclass> -hその他のオプション
-libraries=<path>: ソースファイルから参照される依存関係を解決するために使用されるクラスパス。通常はモジュールのコンパイルクラスパスです。-jdk-home=<path>: JDKのホームディレクトリ。プロセッサがJavaシンボルを解決し、Java標準ライブラリへのアクセスが必要な場合に使用します。-friends=<path>: 現在のモジュールのフレンドモジュールのクラスパス。詳細については、Kotlin GradleプラグインAPIリファレンスのfriendPathsプロパティを参照してください。
-Dksp.logging JVMシステムプロパティを使用してログレベルを設定することもできます。有効な値は error、warn(または warning)、info、debug です。その他の値は warn として扱われます。デフォルト値は warn です。
関連項目
- インクリメンタル処理の仕組みと、それをコマンドラインからデバッグする方法について学ぶ。
- Gradleを使用してKotlin MultiplatformプロジェクトでKSPを使用する方法について学ぶ。
