Lombok 編譯器外掛程式

DANGER

Lombok 編譯器外掛程式為實驗性。

它可能隨時被棄用或變更。請僅用於評估目的。

我們非常感謝您在 YouTrack 上提供相關回饋。

Kotlin Lombok 編譯器外掛程式允許在相同的混合 Java/Kotlin 模組中，Kotlin 程式碼生成並使用 Java 的 Lombok 宣告。 如果您從另一個模組呼叫這些宣告，則無需為該模組的編譯使用此外掛程式。

Lombok 編譯器外掛程式無法取代 Lombok，但它有助於 Lombok 在混合 Java/Kotlin 模組中運作。 因此，當您使用此外掛程式時，仍需像往常一樣配置 Lombok。 了解更多關於如何配置 Lombok 編譯器外掛程式。

支援的註解

此外掛程式支援以下註解：

• @Getter, @Setter
• @Builder, @SuperBuilder
• @NoArgsConstructor, @RequiredArgsConstructor, and @AllArgsConstructor
• @Data
• @With
• @Value

我們正在持續開發此外掛程式。要了解詳細的當前狀態，請造訪 Lombok 編譯器外掛程式的 README。

目前，我們沒有支援 @Tolerate 註解的計劃。然而，如果您在 YouTrack 中對 @Tolerate 問題投票，我們可能會考慮。

NOTE

如果您在 Kotlin 程式碼中使用 Lombok 註解，Kotlin 編譯器將忽略它們。

Gradle

在 build.gradle(.kts) 檔案中應用 kotlin-plugin-lombok Gradle 外掛程式：

Kotlin

plugins {
    kotlin("plugin.lombok") version "2.1.21"
    id("io.freefair.lombok") version "8.13"
}

Groovy

plugins {
    id 'org.jetbrains.kotlin.plugin.lombok' version '2.1.21'
    id 'io.freefair.lombok' version '8.13'
}

請參閱此使用 Lombok 編譯器外掛程式的範例測試專案。

使用 Lombok 配置檔案

如果您使用 Lombok 配置檔案 lombok.config，您需要設定該檔案的路徑，以便外掛程式可以找到它。 該路徑必須是相對於模組目錄的。 例如，將以下程式碼添加到您的 build.gradle(.kts) 檔案中：

Kotlin

kotlinLombok {
    lombokConfigurationFile(file("lombok.config"))
}

Groovy

kotlinLombok {
    lombokConfigurationFile file("lombok.config")
}

請參閱此使用 Lombok 編譯器外掛程式及 lombok.config 的範例測試專案。

Maven

要使用 Lombok 編譯器外掛程式，請將外掛程式 lombok 加入 compilerPlugins 區段，並將依賴 kotlin-maven-lombok 加入 dependencies 區段。 如果您使用 Lombok 配置檔案 lombok.config，請在 pluginOptions 中為外掛程式提供其路徑。將以下行添加到 pom.xml 檔案中：

<plugin>
    <groupId>org.jetbrains.kotlin</groupId>
    <artifactId>kotlin-maven-plugin</artifactId>
    <version>${kotlin.version}</version>
    <configuration>
        <compilerPlugins>
            <plugin>lombok</plugin>
        </compilerPlugins>
        <pluginOptions>
            <option>lombok:config=${project.basedir}/lombok.config</option>
        </pluginOptions>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-lombok</artifactId>
            <version>${kotlin.version}</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</plugin>

請參閱此使用 Lombok 編譯器外掛程式及 lombok.config 的範例測試專案。

搭配 kapt 使用

預設情況下，kapt 編譯器外掛程式會執行所有註解處理器並禁用 javac 的註解處理。 若要讓 Lombok 與 kapt 一同運作，請設定 kapt 以保持 javac 的註解處理器正常運作。

如果您使用 Gradle，請將此選項添加到 build.gradle(.kts) 檔案中：

kapt {
    keepJavacAnnotationProcessors = true
}

在 Maven 中，請使用以下設定來讓 Lombok 與 Java 的編譯器一同啟動：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.5.1</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <annotationProcessorPaths>
            <annotationProcessorPath>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </annotationProcessorPath>
        </annotationProcessorPaths>
    </configuration>
</plugin>

如果註解處理器不依賴於 Lombok 生成的程式碼，Lombok 編譯器外掛程式可與 kapt 正確協同運作。

請查看以下使用 kapt 和 Lombok 編譯器外掛程式的測試專案範例：

• 使用 Gradle。
• 使用 Maven。

命令列編譯器

Lombok 編譯器外掛程式 JAR 可在 Kotlin 編譯器的二進位發行版中找到。您可以使用 Xplugin kotlinc 選項提供其 JAR 檔案的路徑來附加此外掛程式：

-Xplugin=$KOTLIN_HOME/lib/lombok-compiler-plugin.jar

如果您想使用 lombok.config 檔案，請將 <PATH_TO_CONFIG_FILE> 替換為您的 lombok.config 路徑：

# 外掛程式選項格式為："-P plugin:<外掛程式 ID>:<鍵>=<值>"。
# 選項可以重複。

-P plugin:org.jetbrains.kotlin.lombok:config=<PATH_TO_CONFIG_FILE>