Skip to content

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

no-arg コンパイラープラグインは、特定のアノテーションが付与されたクラスに対して引数なしコンストラクター(zero-argument constructor)を生成します。

生成されたコンストラクターには HIDDEN レベルの @Deprecated アノテーションが付与されるため、Javaからは呼び出せますが、Kotlinからは呼び出せません。 フレームワークはリフレクションを通じてそれを呼び出すことができます。

例えばこれにより、Java Persistence API (JPA) などのフレームワークが、引数なしコンストラクターを宣言していないKotlinクラスをインスタンス化できるようになります。

KotlinでJPAエンティティを扱う場合は、kotlin-jpa コンパイラープラグインを使用できます。 このプラグインは、@Entity、@Embeddable、@MappedSuperclass などのJPAアノテーションを自動的に指定します。

アノテーションの宣言 ​

no-arg プラグインは、その設定で登録したアノテーションが付与されているクラスのみを処理します。 そのためプラグインを有効にする前に、引数なしコンストラクターが必要なクラスをマークするためのアノテーションを宣言してください。 例えば、NoArgAnnotation のようになります。

kotlin
package com.example

annotation class NoArgAnnotation

プラグインの適用 ​

Gradle ​

build.gradle(.kts) ファイルの plugins {} ブロックに no-arg プラグインを追加します。

kotlin
plugins {
    kotlin("jvm") version "2.4.21"  // 使用するKotlinのバージョン
    kotlin("plugin.noarg") version "2.4.21" // Kotlin no-arg プラグイン
}
groovy
plugins {
    id "org.jetbrains.kotlin.jvm" version "2.4.21"
    id "org.jetbrains.kotlin.plugin.noarg" version "2.4.21"
}

次に、アノテーションが付与されたクラスに対して引数なしコンストラクターを生成するために、先ほど宣言したアノテーション(例えば com.example.NoArgAnnotation)を指定します。

groovy
noArg {
    annotation("com.example.NoArgAnnotation")
}

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

groovy
noArg {
    invokeInitializers = true
}

Maven ​

pom.xml ファイルにプラグインを追加します。

xml
<properties>
    <kotlin.version>2.4.21</kotlin.version>
</properties>

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

    <configuration>
        <compilerPlugins>
            <plugin>no-arg</plugin>
        </compilerPlugins>

        <pluginOptions>
            <option>no-arg:annotation=com.example.NoArgAnnotation</option>
            <!-- 生成されたコンストラクターでインスタンス初期化子を呼び出す -->
            <!-- <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>

no-arg プラグインの使用 ​

プラグインが適用されると、登録されたアノテーションが付与されたクラスにはコンパイル時に引数なしコンストラクターが生成されます。手動でコンストラクターを宣言する必要はありません。

kotlin
package com.example

// no-arg プラグインはこのクラスに対して引数なしコンストラクターを生成します
@NoArgAnnotation
class MyEntity(val id: Int)

次のステップ ​

  • JPAエンティティには、kotlin-jpa プラグインを使用してください。このプラグインは、@Entity、@Embeddable、@MappedSuperclass などのJPAアノテーションを使って no-arg および all-open プラグインを設定します。
  • no-arg コンパイラープラグインのソースコードを確認してください。