Java 开发之 Lombok 必知必会

1. 前言

---

在目前众多编程语言中，Java 语言的表现还是抢眼，不论是企业级服务端开发，还是 Andorid 客户端开发，都是作为开发语言的首选，甚至在大数据开发领域，Java 语言也能占有一席之地，如 Hadoop，Spark，Flink 大数据等。而作为已经诞生 24 年的 Java 相比其他语言来说，编写起来略显得冗长和复杂，而为了能极大提升 Java 开发的效率和代码简洁性，一个 Java 库 Lombok 就这样诞生了。

首先我们还是看下 Lombok 官方的描述：

Project Lombok is a java library that automatically plugs into your
editor and build tools, spicing up your java. Never write another
getter or equals method again, with one annotation your class has a
fully featured builder, Automate your logging variables, and much
more.

从上面的说明里我们可以初步认识一下 Lombok，一个作用于编辑器和构建工具的 Java 库，可以对编写的 Java 代码进行增强，比如说不用再写实体类的 getter 方法，equals 方法而是自动生成，自动生成日志输出变量等等，减少重复模板的代码。大概知道了 Lombok 框架提供的功能后，接下来我们就真正使用一下 Lombok 提供的注解，看它是如何帮助我们提高书写 Java 代码的简洁性和效率的。

本文主要内容涉及如下：

• Lombok 插件安装
  -Lombok 常用注解使用

示例项目：github.com/wrcj12138aa…

• lombok-actions：

环境支持：

• JDK 8
• SpringBoot 2.1.4
• Maven 3.6.0

2. 正文

---

2.1 安装 Lombok
使用 Lombok 之前我们先要在所使用的 IDE 中进行集成安装，这里以 IDEA 为例，安装步骤十分简单：

• 前往 File -> Settings -> Plugin -> Marketplace ，搜索 Lombok
  

• 选择搜索结果 Lombok ，点击 Install 安装。

• 安装完成后重启即可。

基于 Eclipse 的 Lombok
插件安装方法这里就不详细描述了，官方也给了对应的文档说明：projectlombok.org/setup/eclip…

在 IDE 安装了 Lombok 插件后，我们就可以在 pom.xml 文件中添加 Lombok 的依赖进行使用了。

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.8</version>
    <scope>provided</scope>
</dependency>

注意：pom 依赖设置 scope为provided，是为了让 Lombok 库不被打包进程序。

2.2 @Getter/@Setter
通常我们编写实体类无论多少个字段，都要为其提供 getter 和 setter 方法，如下面的示例类 User.java

我们常会遇到这种情况：某个实体类新增和修改某个字段，我们都需要单独处理调整，十分麻烦并且重复。这时候如果我们使用 Lombok 提供 @Getter/@Setter 注解就能帮我们省去 getter 和 setter 方法的维护，由 Lombok 对 User 类自动生成 getter 和 setter 方法,两者最终的字节码时一样的，而我们现在在 User.java 上编写的代码仅仅 7 行即可：

@Getter
@Setter
public class User {
    private Integer id;
    private String username;
    private String password;
}

然后用测试类 UserTests.java 测试结果如下：