1. 什么是 Lombok？

Lombok 是一个 Java 的小插件，它的作用就是让代码变得更加简洁和优雅。我们通常在写 POJO（Plain Old Java Object）类时，往往需要手动添加 getter、setter、toString() 等方法，这样不仅重复劳动，还让代码显得杂乱、冗余。而 Lombok 可以通过一些注解，让这些繁琐的操作自动化，实现真正的“代码优雅”。等你用完之后，你会爱不释手的哦！[笑哭]

2. 为什么选择 Lombok？

以下几个特点，使 Lombok 成为了很多 Java 开发者的必备插件：

• 减少重复代码：使用 Lombok 后，可以省去 getter、setter 等方法的编写，避免手动生成的代码污染文件。
• 提升开发效率：快速创建常用方法，使代码结构更为清晰。
• 增强代码可读性：避免大量重复代码，集中精力关注业务逻辑。

3. 如何开始使用 Lombok？

在项目中使用 Lombok 很简单。以下是快速上手步骤：

Step 1：添加 Lombok 依赖

如果你的项目使用 Maven 构建，只需在 pom.xml 文件中添加 Lombok 的依赖：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.24</version> <!-- 最新版本号可以上官网查看 -->
    <scope>provided</scope>
</dependency>

Gradle 用户可以在 build.gradle 文件中加入：

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

Step 2：安装 Lombok 插件

很多 IDE 需要安装 Lombok 插件才能正常识别注解，如 Intellij IDEA 和 Eclipse。

0. 在 IDEA 中：点击 File -> Settings -> Plugins，搜索并安装 Lombok 插件。
1. 在 Eclipse 中：可从 Eclipse Marketplace 中搜索 Lombok 进行安装。

完成这些配置后，重启 IDE。

4. 常用 Lombok 注解解析

Lombok 主要通过注解实现功能。以下是几个常用注解及其效果：

@Getter 和 @Setter

@Getter 和 @Setter 注解用于自动生成字段的 getter 和 setter 方法。使用这些注解后，就不再需要手动编写这些方法。

import lombok.Getter;
import lombok.Setter;

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

@ToString

@ToString 注解可以自动生成 toString() 方法。支持字段的选择、排除等自定义操作。

import lombok.ToString;

@ToString
public class User {
    private String name;
    private int age;
}

如果希望忽略某些字段，可以使用 @ToString.Exclude。

@ToString
public class User {
    private String name;
    @ToString.Exclude
    private int age;
}

@NoArgsConstructor 和 @AllArgsConstructor

• @NoArgsConstructor：生成无参构造方法。
• @AllArgsConstructor：生成包含所有参数的构造方法。

import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;

@NoArgsConstructor
@AllArgsConstructor
public class User {
    private String name;
    private int age;
}

@Builder

@Builder 注解可用于生成流式的建造者模式。建造者模式适合构建复杂对象，它通过 builder() 方法一步步设置对象的各个字段，提升代码的可读性。

import lombok.Builder;

@Builder
public class User {
    private String name;
    private int age;
}

// 使用方法
User user = User.builder().name("Alice").age(25).build();

@Data

@Data 注解是 Lombok 中最方便的注解之一，它自动包含了 @Getter、@Setter、@ToString、@EqualsAndHashCode 以及 @RequiredArgsConstructor。

import lombok.Data;

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

5. 使用 Lombok 的注意事项

虽然 Lombok 提升了代码简洁度，但在使用时也有一些注意点：

• 避免滥用：Lombok 虽然方便，但不要因为简化代码而过度使用。比如在 @Entity 注解的类上使用 @Data，可能会因为 equals 和 hashCode 的实现带来潜在问题。
• 需定期更新版本：保持 Lombok 版本与 IDE、Java 版本的兼容，避免因版本不兼容导致的注解失效问题。
• 阅读生成的代码：Lombok 的代码生成在 IDE 中不可见，建议偶尔查看生成的 .class 文件，确保代码符合预期。

结语

Lombok 无疑是 Java 世界中提升编码效率的一大利器。它不仅减少了重复代码，还提高了代码可读性。如果你还没有尝试过 Lombok，不妨动手试一试，让代码更为优雅！