初次使用 IDE 搭配 Lombok 注解的配置

前言

在 Java 开发的漫漫征程中，我们总会遇到各种提升效率的工具。Lombok 便是其中一款能让代码编写变得更加简洁高效的神奇库。它通过注解的方式，巧妙地在编译阶段为我们生成那些繁琐的样板代码，比如 getter、setter、构造函数等。然而，初次使用 IDE 结合 Lombok 注解时，配置过程可能会让人有些摸不着头脑，需要我们自己配置一下。

一、Lombok 初印象

在深入配置之前，先让我们感受一下 Lombok 的魅力。以往，当我们创建一个普通的 Java 类时，为了能对类中的属性进行操作，需要手动编写大量的 getter 和 setter 方法。就像下面这个简单的 User 类：

public class User {
    private String username;
    private int age;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

代码里充斥着这些重复的样板代码，不仅让代码篇幅变长，还降低了代码的可读性。而有了 Lombok，一切都变得不一样了：

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class User {
    private String username;
    private int age;
}

仅仅使用了两个注解，代码瞬间变得简洁明了，这就是 Lombok 的强大之处。

二、前期准备：添加 Lombok 依赖

在正式配置 IDE 之前，我们需要先在项目中添加 Lombok 的依赖。这一步根据项目使用的构建工具不同，操作也有所差异。

（一）Maven 项目

如果你使用的是 Maven 项目，只需要在 pom.xml 文件中添加以下依赖代码：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.26</version>
</dependency>

（二）Gradle 项目

要是你用的是 Gradle 项目，就在 build.gradle 文件里添加如下依赖：

compileOnly 'org.projectlombok:lombok:1.18.26'
annotationProcessor 'org.projectlombok:lombok:1.18.26'

添加完依赖后，项目就具备了使用 Lombok 的基本条件。

三、IDE 中的配置之旅

（一）IntelliJ IDEA 配置

1. 安装 Lombok 插件（一般自带就有，可以忽略）
   • 打开 IntelliJ IDEA，点击菜单栏中的 File，然后选择 Settings（在 Mac 系统中是 IntelliJ IDEA -> Preferences）。
   • 在弹出的设置窗口左侧列表中找到 Plugins 选项。
   • 点击右侧的 Marketplace 标签，在搜索框中输入 Lombok。
   • 找到 Lombok 插件后，点击 Install 按钮进行安装。安装完成后，点击 Restart IDE 重启 IDE，让插件生效。
2. 开启注解处理器
   • 再次打开 Settings/Preferences 窗口，这次在左侧列表中找到 Build, Execution, Deployment -> Compiler -> Annotation Processors。
   • 在右侧窗口中，勾选 Enable annotation processing 选项。这样，IntelliJ IDEA 就会在编译时处理 Lombok 注解，为我们生成相应的代码。
     

（二）Eclipse 配置

1. 下载并安装 Lombok
   • 从 Lombok 的官方 GitHub 仓库（https://github.com/projectlombok/lombok）下载最新的 Lombok JAR 文件。
   • 下载完成后，双击该 JAR 文件，会弹出一个安装窗口。
   • 如果窗口没有自动检测到 Eclipse 的安装路径，点击 Specify location 按钮，手动选择 Eclipse 的安装目录。
   • 点击 Install/Update 按钮开始安装，安装完成后，重启 Eclipse。
2. 开启注解处理
   • 打开 Eclipse，点击 Window -> Preferences。
   • 在左侧菜单中找到 Java -> Compiler -> Annotation Processing。
   • 在右侧窗口中，勾选 Enable annotation processing 选项，确保 Eclipse 能够识别并处理 Lombok 注解。

四、验证配置成果

配置完成后，我们需要验证一下是否配置成功。创建一个简单的 Java 类，使用 Lombok 注解：

import lombok.Data;

@Data
public class Product {
    private String name;
    private double price;
}

再创建一个测试类来使用这个 Product 类：

public class TestProduct {
    public static void main(String[] args) {
        Product product = new Product();
        product.setName("iPhone");
        product.setPrice(9999.0);
        System.out.println("Product Name: " + product.getName());
        System.out.println("Product Price: " + product.getPrice());
    }
}

如果代码能够正常编译和运行，并且输出了正确的结果，那就说明我们的 Lombok 配置成功了。