还在手写 Getter/Setter 方法吗？Lombok 让你的代码更简洁！

Posted 2021-12-13 Hollis Chuang

以下是文章大纲：

Lombok 是什么？

官网：https://projectlombok.org/

Lombok 是一个 Java 库，使用 Lombok 可以通过简单的注解帮助我们消除 Java 的样板代码，使代码更加简洁清晰。

比如对于简单的 Java 对象（POJO），很多的代码里充斥着大量的 getter() 和 setter() 方法，样板代码占用比例高，影响可读性，引入 Lombok 只需一个注解就能达到相同效果，而且更简洁。

Lombok 引入

1、POM 中引入依赖

使用 Lombok 注解需要依赖它的库。

Maven 库：https://mvnrepository.com/artifact/org.projectlombok/lombok

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

系统中如果有引入无需重复引入。

2、IDE 中安装插件

为什么装插件？

• 因为 Lombok 的引入后，java 文件使用 javac 编译成的字节码文件中就会包含 getter 和 setter 函数，但是源代码中找不到定义，IDE 会认为这是错误，因此需要安装一个 Lombok 的插件，方便本地 IDE 的研发工作。

IDEA 中安装：

Settings->Plugins->输入框输入”lombok”

Lombok 使用

比如要针对以下 Java 对象提供 getter() 和 setter() 方法：

public class Mountain 

    private String name;

    private String country;

只需要在类上打 @Getter 和 @Setter 注解。

@Getter
@Setter
public class Mountain 

    private String name;

    private String country;

然后用 maven 编译一下：mvn clean compile。

使用的时候就可以正常拿到像 getCountry() 和 setCountry() 这样的方法。通过 IDE 找方法调用处也可以直接锁定到字段上，以前要点两下才能看到字段明细信息，使用 Lombok 点一下就能达到效果。

Lombok 使用注意

• 不建议直接使用 @Data 这种大而全的方式覆盖太多的简化场景。

• toString 场景不建议使用 Lombok 的，建议使用系统自定义 ToString 里的方法。

• 对外包考虑到接入方也需要引入依赖，如果担心副作用，可以不引入。

• 其他注解酌情使用。

Lombok 原理

自 JDK6 之后，javac 在执行的时候会调用实现了 JSR 269 API 的程序，这样我们就可以对编译器做一些增强，这时 javac 执行的过程如下：

Lombok 本质上就是一个实现了“JSR 269 API”的程序。在使用 javac 的过程中，它产生作用的具体流程如下：

1. javac 对源代码进行分析，生成一棵抽象语法树（AST）

2. 运行过程中调用实现了“JSR 269 API”的 Lombok 程序

3. Lombok 对第一步骤得到的 AST 进行处理，找到 @Getter @Setter 注解所在类对应的语法树（AST）

4. Lombok 修改该语法树（AST），增加 getter() 和 setter() 方法定义的相应树节点

5. javac 使用修改后的抽象语法树（AST）生成字节码文件，即给 class 增加新的节点（代码块）

有道无术，术可成；有术无道，止于术

欢迎大家关注Java之道公众号

好文章，我在看❤️