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

媒介

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

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

1. public class User {
2.     private String username;
3.     private int age;
5.     public String getUsername() {
6.         return username;
7.     }
9.     public void setUsername(String username) {
10.         this.username = username;
11.     }
13.     public int getAge() {
14.         return age;
15.     }
17.     public void setAge(int age) {
18.         this.age = age;
19.     }
20. }

复制代码

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

1. import lombok.Getter;
2. import lombok.Setter;
4. @Getter
5. @Setter
6. public class User {
7.     private String username;
8.     private int age;
9. }

复制代码

仅仅使用了两个注解，代码刹时变得简洁明了，这就是 Lombok 的强盛之处。
二、前期准备：添加 Lombok 依赖

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

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

1. <dependency>
2.     <groupId>org.projectlombok</groupId>
3.     <artifactId>lombok</artifactId>
4.     <version>1.18.26</version>
5. </dependency>

复制代码

（二）Gradle 项目

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

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

复制代码

添加完依赖后，项目就具备了使用 Lombok 的基本条件。
三、IDE 中的设置之旅

（一）IntelliJ IDEA 设置

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

（二）Eclipse 设置

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

四、验证设置成果

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

1. import lombok.Data;
3. @Data
4. public class Product {
5.     private String name;
6.     private double price;
7. }

复制代码

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

1. public class TestProduct {
2.     public static void main(String[] args) {
3.         Product product = new Product();
4.         product.setName("iPhone");
5.         product.setPrice(9999.0);
6.         System.out.println("Product Name: " + product.getName());
7.         System.out.println("Product Price: " + product.getPrice());
8.     }
9. }

复制代码

假如代码能够正常编译和运行，而且输出了正确的效果，那就分析我们的 Lombok 设置乐成了。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。