Lombok 使用详解，简化 Java 编程

客官°小女子只卖身不卖艺 2021-08-26 16:34 423阅读 0赞

作者 | 日拱一兵

来源 | 公众号（日拱一兵）

在 Java 应用程序中存在许多重复相似的、生成之后几乎不对其做更改的代码，但是我们还不得不花费很多精力编写它们来满足 Java 的编译需求

比如，在 Java 应用程序开发中，我们几乎要为所有 Bean 的成员变量添加 get() ,set() 等方法，这些相对固定但又不得不编写的代码浪费程序员很多精力，同时让类内容看着更杂乱，我们希望将有限的精力关注在更重要的地方。

Lombok 已经诞生很久了，甚至在 Spring Boot Initalizr 中都已加入了 Lombok 选项，

![format_png][]

这里我们将 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. Early access to future java features such as val, and much more.

**直白的说：** Lombok 是一种 Java™ 实用工具，可用来帮助开发人员消除 Java 的冗长，尤其是对于简单的 Java 对象（POJO）。它通过注解实现这一目的，且看:

### **Bean 的对比** ###

传统的 POJO 类是这样的

![format_png 1][]

通过Lombok改造后的 POJO 类是这样的

![format_png 2][]

一眼可以观察出来我们在编写 Employee 这个类的时候通过 `@Data` 注解就已经实现了所有成员变量的 `get()` 与 `set()` 方法等，同时 Employee 类看起来更加清晰简洁。Lombok 的神奇之处不止这些，丰富的注解满足了我们开发的多数需求。

### **Lombok的安装** ###

查看下图，@Data的实现，我们发现这个注解是应用在编译阶段的

![format_png 3][]

这和我们大多数使用的注解，如 Spring 的注解（在运行时，通过反射来实现业务逻辑）是有很大差别的，如Spring 的@RestController 注解

![format_png 4][]

一个更直接的体现就是，普通的包在引用之后一般的 IDE 都能够自动识别语法，但是 Lombok 的这些注解，一般的 IDE 都无法自动识别，因此如果要使用 Lombok 的话还需要配合安装相应的插件来支持 IDE 的编译，防止IDE 的自动检查报错，下面以 IntelliJ IDEA 举例安装插件。

在Repositories中搜索Lombok，安装后重启IDE即可

![format_png 5][]

在Maven或Gradle工程中添加依赖

![format_png 6][]

至此我们就可以应用 Lombok 提供的注解干些事情了。

**Lombok注解详解**

Lombok官网提供了许多注解，但是 “劲酒虽好，可不要贪杯哦”，接下来逐一讲解官网推荐使用的注解(有些注解和原有Java编写方式没太大差别的也没有在此处列举，如@ Synchronized等)

![format_png 7][]

### **@Getter和@Setter** ###

该注解可应用在类或成员变量之上，和我们预想的一样，`@Getter` 和 `@Setter` 就是为成员变量自动生成 get 和 set 方法，默认生成访问权限为 public 方法，当然我们也可以指定访问权限 protected 等，如下图：

![format_png 8][]

成员变量name指定生成set方法，并且访问权限为protected；boolean类型的成员变量 female 只生成get方法，并修改方法名称为 isFemale()。当把该注解应用在类上，默认为所有非静态成员变量生成 get 和 set 方法，也可以通过 AccessLevel.NONE 手动禁止生成get或set方法，如下图：

![format_png 9][]

### **@ToString** ###

该注解需应用在类上，为我们生成 Object 的 toString 方法，而该注解里面的几个属性能更加丰富我们想要的内容, `exclude` 属性禁止在 toString 方法中使用某字段，而of属性可以指定需要使用的字段，如下图：

![format_png 10][]

查看编译后的Employee.class得到我们预期的结果，如下图

![format_png 11][]

### **@EqualsAndHashCode** ###

该注解需应用在类上，使用该注解，lombok会为我们生成 equals(Object other) 和 hashcode() 方法，包括所有非静态属性和非transient的属性，同样该注解也可以通过 exclude 属性排除某些字段，of 属性指定某些字段，也可以通过 callSuper 属性在重写的方法中使用父类的字段，这样我们可以更灵活的定义bean的比对，如下图：

![format_png 12][]

查看编译后的Employee.class文件，如下图：

![format_png 13][]

**@NonNull**

该注解需应用在方法或构造器的参数上或属性上，用来判断参数的合法性，默认抛出 NullPointerException 异常

![format_png 14][]

查看NonNullExample.class文件，会为我们抛出空指针异常，如下图：

![format_png 15][]

当然我们可以通过指定异常类型抛出其他异常，lombok.nonNull.exceptionType = \[NullPointerException | IllegalArgumentException\] , 为实现此功能我们需要在项目的根目录新建lombok.config文件：

![format_png 16][]

重新编译NonNullExample类，已经为我们抛出非法参数异常：

![format_png 17][]

**@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor**

以上三个注解分别为我们生成无参构造器，指定参数构造器和包含所有参数的构造器，默认情况下，`@RequiredArgsConstructor`, `@AllArgsConstructor` 生成的构造器会对所有标记 `@NonNull` 的属性做非空校验。

无参构造器很好理解，我们主要看看后两种，先看 `@RequiredArgsConstructor`

![format_png 18][]

从上图中我们可以看出， `@RequiredArgsConstructor` 注解生成有参数构造器时只会包含有 final 和 `@NonNull` 标识的 field，同时我们可以指定 staticName 通过生成静态方法来构造对象

查看Employee.class文件

![format_png 19][]

当我们把 staticName 属性去掉我们来看遍以后的文件:

![format_png 20][]

相信你已经注意到细节

`@AllArgsConstructor` 就更简单了，请大家自行查看吧

**@Data**

介绍了以上的注解，再来介绍 `@Data` 就非常容易懂了，`@Data` 注解应用在类上，是`@ToString`, `@EqualsAndHashCode`, `@Getter / @Setter` 和 `@RequiredArgsConstructor`合力的体现，如下图：

![format_png 21][]

**@Builder**

函数式编程或者说流式的操作越来越流行，应用在大多数语言中，让程序更具更简介，可读性更高，编写更连贯，`@Builder`就带来了这个功能，生成一系列的builder API，该注解也需要应用在类上，看下面的例子就会更加清晰明了。

![format_png 22][]

编译后的Employee.class文件如下：

![format_png 23][]

妈妈再也不用担心我 set 值那么麻烦了，流式操作搞定：

![format_png 24][]

**@Log**

该注解需要应用到类上，在编写服务层，需要添加一些日志，以便定位问题，我们通常会定义一个静态常量Logger，然后应用到我们想日志的地方，现在一个注解就可以实现：

![format_png 25][]

查看class文件，和我们预想的一样：

![format_png 26][]

Log有很多变种，CommonLog，Log4j，Log4j2，Slf4j等，lombok依旧良好的通过变种注解做良好的支持：

![format_png 27][]

我实际使用的是 `@Slf4j` 注解

### val ###

熟悉 Javascript 的同学都知道，var 可以定义任何类型的变量，而在 java 的实现中我们需要指定具体变量的类型，而 val 让我们摆脱指定，编译之后就精准匹配上类型，默认是 final 类型，就像 java8 的函数式表达式，()->System.out.println(“hello lombok”); 就可以解析到Runnable函数式接口。

![format_png 28][]

查看解析后的class文件：

![format_png 29][]

**@Cleanup**

当我们对流进行操作，我们通常需要调用 close 方法来关闭或结束某资源，而 @Cleanup 注解可以帮助我们调用 close 方法，并且放到 try/finally 处理块中，如下图：

![format_png 30][]

编译后的class文件如下，我们发现被try/finally包围处理，并调用了流的close方法

![format_png 31][]

其实在 JDK1.7 之后就有了 `try-with-resource`，不用我们显式的关闭流，这个请大家自行看吧

## **总结** ##

Lombok的基本操作流程是这样的：

1. 定义编译期的注解

2. 利用JSR269 api(Pluggable Annotation Processing API )创建编译期的注解处理器

3. 利用tools.jar的javac api处理AST(抽象语法树)

4. 将功能注册进jar包

![format_png 32][]

Lombok 当然还有很多注解，我推荐使用以上就足够了，这个工具是带来便利的，而不能被其捆绑，“弱水三千只取一瓢饮，代码千万需抓重点看”，Lombok 能让我更加专注有效代码排除意义微小的障眼代码（get，set等），另外Lombok生成的代码还能像使用工具类一样方便（@Builder）。

更多内容请查看官网：https://www.projectlombok.org/

--------------------

## 灵魂追问 ##

1. 为什么只有一个整体 `@EqualsAndHashCode` 注解？

而不是 `@Equals` 和 `@HashCode`？

这涉及到一个规范哦

2. 如果把三种构造器方式同时应用又加上了 `@Builder` 注解，会发生什么？

欢迎评论！

--------------------

\-END-

如果看到这里，说明你喜欢这篇文章，请**转发****、点赞**。微信搜索「web\_resource」，欢迎添加小编微信「focusoncode」，每日朋友圈更新一篇高质量技术博文（无广告）。

**↓扫描二维码添加小编↓**

![format_png 33][]

**推****荐****阅****读**

***1. ***[Dubbo 爆出严重漏洞!][Dubbo]

***2. ***[Spring Boot+Redis 分布式锁：模拟抢单][Spring Boot_Redis]

***3.*** [安利一款 IDEA 中强大的代码生成利器][IDEA]

***4. ***[如何获取靠谱的新型冠状病毒疫情][Link 1]

![format_png 34][]

[format_png]: /images/20210730/2bcc3a9e97174965abad12a99223e554.png
[format_png 1]: /images/20210730/37e4936c89b4465481e2fe666aa3a627.png
[format_png 2]: /images/20210730/10dec04e26dc411695c09dbf8ab77d5b.png
[format_png 3]: /images/20210730/dd34d212664240199d84ffa91aca0511.png
[format_png 4]: /images/20210730/431050661d7047ea9a01e9b68dc82d1b.png
[format_png 5]: /images/20210730/ba278b62d7bf4e2399780e2b74771e4a.png
[format_png 6]: /images/20210730/7d89e7447ad24b738c24da60e28a86ee.png
[format_png 7]: /images/20210730/849dd319279149279dce347cece0b003.png
[format_png 8]: /images/20210730/1d528bcd3b6f491bbf06e30c5cdba250.png
[format_png 9]: /images/20210730/a94bd470946a4810a50481c1221351b3.png
[format_png 10]: /images/20210730/9319437b7b58494992fa8b2e2d5aab43.png
[format_png 11]: /images/20210730/0f6872c925144bcf8e4f4f5df82ebba5.png
[format_png 12]: /images/20210730/d1091c4f6cf742288fb04a1646d4d91a.png
[format_png 13]: /images/20210730/d700a1b3060e4fc7a8b7138010d18180.png
[format_png 14]: /images/20210730/fc984d7f3454499ca0cfe3d80cedfdf8.png
[format_png 15]: /images/20210730/e9ecc2ecafb24d9f8c13ae068763a213.png
[format_png 16]: /images/20210730/e872eedf3c2248f691c0956198413c4b.png
[format_png 17]: /images/20210730/115b1212a775452883ef2c2cc5ee4e61.png
[format_png 18]: /images/20210730/94a25d7ad5ff443fb44912ec377a3f47.png
[format_png 19]: /images/20210730/79b721d9c2cb4d6cb84128434b9356a3.png
[format_png 20]: /images/20210730/438c0626c8de4fe388ebfbee415303f3.png
[format_png 21]: /images/20210730/563ab30314144379ae181bfd48720c8e.png
[format_png 22]: /images/20210730/fdb18471c3644d76bd2e8fa09fc5384e.png
[format_png 23]: /images/20210730/d24465d2fab648648352f09255f3d81a.png
[format_png 24]: /images/20210730/6b6e5f9eba8a4e76ada8684b9cd97f05.png
[format_png 25]: /images/20210730/62e5162089fc4d3f98b32c8589082401.png
[format_png 26]: /images/20210730/6b11bcbcc6d74fd080e9d72855057fc0.png
[format_png 27]: /images/20210730/8ef3ceb6fcbb48cebc10b159700f8e08.png
[format_png 28]: /images/20210730/0437f1505f564dd69ee15a29b0362846.png
[format_png 29]: /images/20210730/001123f67bdb41d9a369ae59a5a480cf.png
[format_png 30]: /images/20210730/80982760e9d24c6c992569115d362e2f.png
[format_png 31]: /images/20210730/b29c6365a5d448ba92767f3c7a1fe25d.png
[format_png 32]: /images/20210730/bd6543d621f7451984ab8774e293fecd.png
[format_png 33]: /images/20210730/7227214bc04a47dba9534964fcef06e6.png
[Dubbo]: https://blog.csdn.net/qq_37217713/article/details/104368230
[Spring Boot_Redis]: https://blog.csdn.net/qq_37217713/article/details/104368227
[IDEA]: https://blog.csdn.net/qq_37217713/article/details/104205000
[Link 1]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e57aff979deb91c3492fcaf2270414ae2c87a24dd2891387f91918aff50d9ba5eab5b8b75&idx=1&mid=2247491628&scene=21&sn=8795f58c1c90ce6ebfb6b64d8fae2595#wechat_redirect
[format_png 34]: /images/20210730/949e01f4939d41368f965e380b95d754.png