Gradle 配置 Lombok 项目并发布到私有 Maven 仓库的完整指南

news2025/3/6 21:04:46

Gradle 配置 Lombok 项目并发布到私有 Maven 仓库的完整指南

在 Java 项目开发中，使用 Lombok 可以极大地减少样板代码（如 getter/setter 方法、构造器等），提高开发效率。然而，当使用 Gradle 构建工具并将项目发布到私有 Maven 仓库时，常常会遇到 Lombok 注解未正确发布或生成代码缺失的问题。本文将详细讲解如何正确配置 Gradle 项目，确保 Lombok 在开发和发布过程中正常工作。

一、常见问题

Lombok注解消失
Lombok 注解在编译阶段生效，编译后的字节码中已经生成了相应的方法或字段，注解本身不会被保留。因此，发布到 Maven 仓库的 JAR 包中通常看不到 Lombok 注解。
生成代码缺失
如果 Gradle 配置不正确，例如缺少 annotationProcessor，编译阶段 Lombok 的注解处理器无法生效，最终生成的代码可能会不完整。
依赖范围问题
Lombok 是一个编译时依赖，而不是运行时依赖。如果将 Lombok 声明为 implementation，可能导致构建环境下生成代码正常，但运行环境下出现问题。

二、Gradle Lombok 配置详解

在 Gradle 项目中正确配置 Lombok，需要以下步骤：

1. 添加 Lombok 依赖

在项目的 build.gradle.kts 文件中添加 Lombok 依赖：

dependencies {
    compileOnly("org.projectlombok:lombok:1.18.26") // Lombok 编译时依赖
    annotationProcessor("org.projectlombok:lombok:1.18.26") // Lombok 注解处理器
}

说明：

compileOnly 表示 Lombok 仅在编译时生效，不会出现在运行时依赖中。
annotationProcessor 用于在编译期间启用 Lombok 的注解处理器。

2. 配置 Maven Publish 插件

为将项目发布到私有 Maven 仓库，需要引入 maven-publish 插件，并进行相关配置：

plugins {
    id("java")
    `maven-publish` // 引入 Maven Publish 插件
}

在 publishing 块中指定发布内容和私有仓库地址：

publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            from(components["java"]) // 发布 Java 构件
        }
    }
    repositories {
        maven {
            url = uri("http://192.168.100.104:8081/repository/maven-snapshots/") // 私库地址
            credentials {
                username = "your-username" // 替换为你的用户名
                password = "your-password" // 替换为你的密码
            }
            isAllowInsecureProtocol = true // 如果使用 HTTP，允许非安全协议
        }
    }
}

3. 测试依赖配置

为了确保 Lombok 配置完整，建议在 testImplementation 中添加如下配置：

testImplementation(platform("org.junit:junit-bom:5.10.0"))
testImplementation("org.junit.jupiter:junit-jupiter")

同时启用 JUnit Platform：

tasks.test {
    useJUnitPlatform()
}

三、Lombok 依赖声明和发布配置

发布到私库的 JAR 包中可能需要 Lombok 的依赖声明，特别是在下游项目需要依赖 Lombok 时。

1. 确保 Lombok 的依赖信息

在发布的 pom.xml 文件中明确声明 Lombok 依赖：

publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            from(components["java"])
            pom {
                dependencies {
                    dependency {
                        groupId = "org.projectlombok"
                        artifactId = "lombok"
                        version = "1.18.26"
                        scope = "compile"
                    }
                }
            }
        }
    }
}

四、验证发布结果

完成配置后，验证发布的构件是否包含完整的生成代码和依赖信息。

1. 检查生成的 JAR 包内容

运行以下命令解压 JAR 包，检查是否包含 Lombok 生成的代码（如 getCode() 方法）：

jar -tvf your-published-artifact.jar

2. 使用 `javap` 查看字节码

使用 javap 工具检查编译后的类文件：

javap -p -classpath your-published-artifact.jar package.path.to.QueryTopicDetailRequest

确认是否生成了 getter/setter 和构造器等代码。

五、完整配置示例

以下是一个完整的 Gradle 配置文件示例，结合了上述配置：

plugins {
    id("java")
    `maven-publish`
}

group = "site.achun.biz.share"
version = "1.0-SNAPSHOT"

repositories {
    mavenCentral()
}

dependencies {
    compileOnly("org.projectlombok:lombok:1.18.26")
    annotationProcessor("org.projectlombok:lombok:1.18.26")
    implementation("org.springframework:spring-web:6.0.10")
    testImplementation(platform("org.junit:junit-bom:5.10.0"))
    testImplementation("org.junit.jupiter:junit-jupiter")
}

tasks.test {
    useJUnitPlatform()
}

publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            from(components["java"])
            pom {
                dependencies {
                    dependency {
                        groupId = "org.projectlombok"
                        artifactId = "lombok"
                        version = "1.18.26"
                        scope = "compile"
                    }
                }
            }
        }
    }
    repositories {
        maven {
            url = uri("http://192.168.100.104:8081/repository/maven-snapshots/")
            credentials {
                username = "your-username"
                password = "your-password"
            }
            isAllowInsecureProtocol = true
        }
    }
}