Skip to content

No-argコンパイラプラグイン

no-argコンパイラプラグインは、特定のアノテーションを持つクラスに対して、追加の引数なしコンストラクタを生成します。

生成されたコンストラクタは合成されたものであり、JavaやKotlinから直接呼び出すことはできませんが、リフレクションを使用して呼び出すことができます。

これにより、KotlinやJavaの視点からは引数なしコンストラクタを持たないにもかかわらず、Java Persistence API (JPA)がクラスをインスタンス化できるようになります(kotlin-jpaプラグインの説明は下記を参照)。

Kotlinファイルでの設定

引数なしコンストラクタを必要とするコードをマークするために、新しいアノテーションを追加します。

kotlin
package com.my

annotation class Annotation

Gradleでの設定

Gradleのplugins DSLを使用してプラグインを追加します。

kotlin
plugins {
    kotlin("plugin.noarg") version "2.1.21"
}
groovy
plugins {
    id "org.jetbrains.kotlin.plugin.noarg" version "2.1.21"
}

次に、アノテーションが付けられたクラスに対してno-argコンストラクタの生成に繋がるno-argアノテーションのリストを指定します。

groovy
noArg {
    annotation("com.my.Annotation")
}

プラグインに合成コンストラクタからの初期化ロジックを実行させたい場合は、invokeInitializersオプションを有効にします。デフォルトでは無効になっています。

groovy
noArg {
    invokeInitializers = true
}

Mavenでの設定

xml
<plugin>
    <artifactId>kotlin-maven-plugin</artifactId>
    <groupId>org.jetbrains.kotlin</groupId>
    <version>${kotlin.version}</version>

    <configuration>
        <compilerPlugins>
            <!-- Or "jpa" for JPA support -->
            <plugin>no-arg</plugin>
        </compilerPlugins>

        <pluginOptions>
            <option>no-arg:annotation=com.my.Annotation</option>
            <!-- Call instance initializers in the synthetic constructor -->
            <!-- <option>no-arg:invokeInitializers=true</option> -->
        </pluginOptions>
    </configuration>

    <dependencies>
        <dependency>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-noarg</artifactId>
            <version>${kotlin.version}</version>
        </dependency>
    </dependencies>
</plugin>

JPAのサポート

kotlin-springプラグインがall-openを基盤としているのと同様に、kotlin-jpano-argを基盤としています。このプラグインは、@Entity@Embeddable、および@MappedSuperclassno-argアノテーションを自動的に指定します。

Gradle plugins DSLを使用してプラグインを追加します。

kotlin
plugins {
    kotlin("plugin.jpa") version "2.1.21"
}
groovy
plugins {
    id "org.jetbrains.kotlin.plugin.jpa" version "2.1.21"
}

Mavenでは、jpaプラグインを有効にします。

xml
<compilerPlugins>
    <plugin>jpa</plugin>
</compilerPlugins>

コマンドラインコンパイラ

コンパイラプラグインのクラスパスにプラグインのJARファイルを追加し、アノテーションまたはプリセットを指定します。

bash
-Xplugin=$KOTLIN_HOME/lib/noarg-compiler-plugin.jar
-P plugin:org.jetbrains.kotlin.noarg:annotation=com.my.Annotation
-P plugin:org.jetbrains.kotlin.noarg:preset=jpa