Skip to content

No-arg 編譯器外掛程式 ​

no-arg 編譯器外掛程式會為帶有特定註解的類別產生零引數建構函式。

產生的建構函式會標記層級為 HIDDEN 的 @Deprecated,因此你可以從 Java 呼叫它,但無法從 Kotlin 呼叫。 各個架構可以透過反射來呼叫它。

例如,這可讓像是 Java Persistence API (JPA) 等架構具現化未宣告零引數建構函式的 Kotlin 類別。

對於搭配 Kotlin 使用的 JPA 實體,你可以使用 kotlin-jpa 編譯器外掛程式。 它會自動指定 JPA 註解,例如 @Entity、@Embeddable 以及 @MappedSuperclass。

宣告註解 ​

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)

後續內容 ​