12.2.5 No-arg 编译器插件

原文链接: https://kotlinlang.org/docs/no-arg-plugin.html

12.2.5 No-arg 编译器插件

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

生成的构造函数是合成的,因此不能从 Java 或 Kotlin 中直接调用,但可以通过反射调用。

这让 Java Persistence API(JPA)能够实例化某个类,尽管从 Kotlin 或 Java 的视角看它并没有无参构造函数(参见下面对 kotlin-jpa 插件的说明)。

在你的 Kotlin 文件中

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

1
2
3
package com.my

annotation class Annotation

Gradle

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

Kotlin

1
2
3
plugins {
    kotlin("plugin.noarg") version "2.4.20"
}

Groovy

1
2
3
plugins {
    id "org.jetbrains.kotlin.plugin.noarg" version "2.4.20"
}

然后指定必须为带注解的类生成无参构造函数的 no-arg 注解列表:

1
2
3
noArg {
    annotation("com.my.Annotation")
}

如果你希望插件从合成构造函数中执行初始化逻辑,请启用 invokeInitializers 选项。默认情况下它是禁用的。

1
2
3
noArg {
    invokeInitializers = true
}

Maven

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<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.my.Annotation</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 no-arg 注解。

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

Kotlin

1
2
3
plugins {
    kotlin("plugin.jpa") version "2.4.20"
}

Groovy

1
2
3
plugins {
    id "org.jetbrains.kotlin.plugin.jpa" version "2.4.20"
}

在 Maven 中启用 jpa 插件:

1
2
3
<compilerPlugins>
    <plugin>jpa</plugin>
</compilerPlugins>

命令行编译器

把插件 JAR 文件添加到编译器插件 classpath,并指定注解或预设:

1
2
3
-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