解决 IntelliJ IDEA 中使用 Lombok 编译报错的几种方法

引言

常见的 Lombok 编译错误

解决方法

方法一：确保最新版本 Lombok 库已添加到项目依赖

方法二：检查 IDEA 的编译器设置

方法三：安装并启用 Lombok 插件

方法四：配置 Lombok 注解处理器

方法五：检查 Lombok 注解的使用

示例代码

结论

参考资料

引言

Lombok 是一个非常流行的 Java 库，它通过注解简化了 Java 类的编写，减少了样板代码。然而，在使用 Lombok 时，有时会遇到编译错误，特别是在 IntelliJ IDEA 中。本文将介绍几种常见的 Lombok 编译错误及其解决方法，帮助开发者顺利使用 Lombok。

常见的 Lombok 编译错误

在使用 Lombok 过程中，可能会遇到以下几种常见的编译错误：

找不到 Lombok 注解生成的方法或属性
编译器无法识别 Lombok 注解
IDEA 插件未正确安装或配置

解决方法

方法一：确保最新版本 Lombok 库已添加到项目依赖

请确保您的pom.xml文件中已经正确引入了最新版本Lombok依赖，如果没有，请添加以下依赖：

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>最新版本</version>
<scope>provided</scope>
</dependency>

注意：旧版本会有编译问题的bug，更新到最新版本即可，亲测有效。

maven仓库地址编辑 https://mvnrepository.com/artifact/org.projectlombok/lombok

步骤：

打开项目的 pom.xml 或 build.gradle 文件：
- 对于 Maven 项目，编辑 pom.xml 文件。
- 对于 Gradle 项目，编辑 build.gradle 文件。

添加 Lombok 依赖：

Maven：

<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.24</version> <!-- 使用最新的版本 --><scope>provided</scope>
</dependency>

Gradle：

implementation 'org.projectlombok:lombok:1.18.24' // 使用最新的版本
annotationProcessor 'org.projectlombok:lombok:1.18.24'

刷新项目依赖：
- 在 IntelliJ IDEA 中，点击 File -> Invalidate Caches / Restart，然后选择 Invalidate and Restart。

方法二：检查 IDEA 的编译器设置

在以下位置加上该配置"-Djps.track.ap.dependencies=false"

方法三：安装并启用 Lombok 插件

步骤：

打开 IntelliJ IDEA。
进入插件市场：
- 点击 File -> Settings（Windows/Linux）或 IntelliJ IDEA -> Preferences（macOS）。
- 导航到 Plugins 选项卡。
搜索并安装 Lombok 插件：
- 在搜索框中输入 Lombok。
- 找到 Lombok Plugin 并点击 Install。
- 安装完成后，重启 IntelliJ IDEA。
启用 Lombok 插件：
- 确保插件已启用。可以在 Settings -> Plugins 中查看。

方法四：配置 Lombok 注解处理器

步骤：

打开项目设置：
- 点击 File -> Settings（Windows/Linux）或 IntelliJ IDEA -> Preferences（macOS）。
导航到注解处理器设置：
- 在左侧菜单中选择 Build, Execution, Deployment -> Compiler -> Annotation Processors。
启用注解处理器：
- 勾选 Enable annotation processing。
- 勾选 Obtain processors from project classpath。
重新编译项目：
- 点击 Build -> Rebuild Project。

方法五：检查 Lombok 注解的使用

步骤：

确保注解使用正确：
- 检查你的类是否正确使用了 Lombok 注解。例如：
```
import lombok.Data;@Data
public class User {private String name;private int age;
}
```
检查类路径：
- 确保所有依赖项都已正确添加到项目的类路径中。
清理和重建项目：
- 点击 Build -> Clean Project。
- 点击 Build -> Rebuild Project。

示例代码

以下是一个使用 Lombok 的简单示例，展示了如何使用 @Data 注解：

import lombok.Data;@Data
public class User {private String name;private int age;
}

测试代码

public class Main {public static void main(String[] args) {User user = new User();user.setName("John Doe");user.setAge(30);System.out.println(user.getName()); // 输出: John DoeSystem.out.println(user.getAge());  // 输出: 30}
}