Skip to content

无参编译器插件

no-arg 编译器插件会为带有特定注解的类生成一个额外的零参构造函数。

生成的构造函数是合成的,因此无法从 Java 或 Kotlin 中直接调用,但可以使用反射进行调用。

这使得 Java Persistence API (JPA) 即使在 Kotlin 或 Java 的角度来看没有零参数构造函数,也能实例化一个类(关于 kotlin-jpa 插件的描述,请参阅下方)。

在你的 Kotlin 文件中

添加新注解来标记需要零参构造函数的代码:

kotlin
package com.my

annotation class Annotation

Gradle

使用 Gradle 的插件 DSL 添加该插件:

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

然后指定无参注解的列表,这些注解必须导致为被注解的类生成无参构造函数:

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>
            <!-- 或者 "jpa" 以支持 JPA -->
            <plugin>no-arg</plugin>
        </compilerPlugins>

        <pluginOptions>
            <option>no-arg:annotation=com.my.Annotation</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>

JPA 支持

与封装在 all-open 之上的 kotlin-spring 插件一样,kotlin-jpa 封装在 no-arg 之上。该插件会自动指定 @Entity@Embeddable@MappedSuperclass 无参注解。

使用 Gradle 插件 DSL 添加该插件:

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

在 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