Lombok

2024-03-11 22:51:07

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.

一句话：使用该插件后，程序员不用再写POJO的getter和setter方法等模块式代码了，一个注解就能帮程序员自动写这些方法。

Lombok 使用

IDEA安装Lombok插件
在 pom 文件中引入依赖

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

其中 <scope>provided</scope> 表示 jar 包是运行在编译时的，当程序编译成 class 源代码后，这个 jar 包就不会在源代码层面有所体现。

Lombok 注解

右侧上方的 @Getter、@Setter、@ToString、@EqualsAndHashCode 这几个名字大家都不陌生，无非就是帮我们生成对应的方法，这四个注解的总和也就是注解 @Data。
右侧下方的 @AllArgsConstructor、@RequiredArgsConstructor、@NoArgsConstructor分别为全参构造函数、必须参数构造函数、无参构造函数，它们通常为构造方法的注解。
左侧的 @NonNull 会自动生成空值校验；@CleanUp 会自动调用变量的 close 方法释放资源；@Builder 会自动生成构造者模式，方便对属性 set/get 操作；@Synchronized 会自动生成同步锁；@SneakyThrows 会自动生成 try/catch 捕捉异常；@Slf4j是日志相关的，会自动为类添加日志支持。

注解详细

1、@Getter/@Setter

自动产生 getter/setter方法

2、 @ToString

自动重写 toString() 方法，会印出所有变量

3、 @EqualsAndHashCode

自动生成 equals(Object other) 和 hashcode() 方法，包括所有非静态变量和非 transient 的变量

如果某些变量不想要加进判断，可以透过 exclude 排除，也可以使用 of 指定某些字段

Q : 为什么只有一个整体的 @EqualsAndHashCode 注解，而不是分开的两个 @Equals 和 @HashCode？

A : 在 Java 中有规定，当两个对象 equals 时，他们的 hashcode 一定要相同，反之，当 hashcode 相同时，对象不一定 equals。所以 equals 和 hashcode 要一起实现，免得发生违反 Java 规定的情形发生

4、@NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor

这三个都是在自动生成该类的构造器，差别只在生成的构造器的参数不一样而已

@NoArgsConstructor : 生成一个没有参数的默认构造器

@AllArgsConstructor : 生成一个包含所有参数的构造器

这里注意一个 Java 的小坑，当我们没有指定构造器时，Java 编译器会帮我们自动生成一个没有任何参数的构造器给该类，但是如果我们自己写了构造器之后，Java 就不会自动帮我们补上那个无参数的构造器了

然而很多地方（像是 Spring Data JPA），会需要每个类都一定要有一个无参数的构造器，所以你在加上 @AllArgsConstructor 时，一定要补上 @NoArgsConstrcutor，不然会有各种坑等着你。

@RequiredArgsConstructor : 生成一个包含 "特定参数" 的构造器，特定参数指的是那些有加上 final 修饰词的变量们

补充一下，如果所有的变量都是正常的，都没有用 final 修饰的话，那就会生成一个没有参数的构造器。

5. @Data

整合包，只要加了 @Data 这个注解，等于同时加了以下注解

@Getter/@Setter
@ToString
@EqualsAndHashCode
@RequiredArgsConstructor

@Data 是使用频率最高的 lombok 注解，通常 @Data 会加在一个值可以被更新的对象上，像是日常使用的 DTO 们、或是 JPA 里的 Entity 们，就很适合加上 @Data 注解，也就是 @Data for mutable class

6. @Value

也是整合包，但是他会把所有的变量都设成 final 的，其他的就跟 @Data 一样，等于同时加了以下注解

@Getter (注意没有setter)
@ToString
@EqualsAndHashCode
@RequiredArgsConstructor

上面那个 @Data 适合用在 POJO 或 DTO 上，而这个 @Value 注解，则是适合加在值不希望被改变的类上，像是某个类的值当创建后就不希望被更改，只希望我们读它而已，就适合加上 @Value 注解，也就是 @Value for immutable class

另外注意一下，此 lombok 的注解 @Value 和另一个 Spring 的注解 @Value 重名，在 import 时不要 import 错了。

7. @Builder

自动生成流式 set 值写法，从此之后再也不用写一堆 setter 了

注意，虽然只要加上 @Builder 注解，我们就能够用流式写法快速设定对象的值，但是 setter 还是必须要写不能省略的，因为 Spring 或是其他框架有很多地方都会用到对象的 getter/setter 对他们取值/赋值

所以通常是 @Data 和 @Builder 会一起用在同个类上，既方便我们流式写代码，也方便框架做事。

8. @Slf4j

自动生成该类的 log 静态常量，要打日志就可以直接打，不用再手动 new log 静态常量了

除了 @Slf4j 之外，lombok 也提供其他日志框架的变种注解可以用，像是 @Log、@Log4j...等，他们都是帮我们创建一个静态常量 log，只是使用的库不一样而已。

@Log //对应的log语句如下
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());

@Log4j //对应的log语句如下
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);

SpringBoot默认支持的就是 slf4j + logback 的日志框架，所以也不用再多做啥设定，直接就可以用在 SpringBoot project上，log 系列注解最常用的就是 @Slf4j

Lombok 实现原理

要讲 Lombok 的实现原理，在此之前就需要来说下注解的两种解析方式：运行时注解和编译时注解。

首先来看下运行时解析，比如Spring 配置的 AOP 切面这些注解都是在程序运行时通过反射来获取的注解值，但是只有在程序运行时才能获取到这些注解值，导致运行时代码效率很低，并且如果想在编译阶段利用这些注解来进行检查，比如对用户的不合理代码作出错误报告，反射的方法就行不通了。

这就引出了第二种在编译时解析，Lombok 工具就是运行在编译时解析的。

那如何把注解与 Java 编译器结合使用呢？Java 也提供了两种解决方案：

第一种方案是注解处理器（Annotation Processing Tool），它最早是在 JDK 1.5 与注解（Annotation）一起引入的，它是一个命令行工具，能够提供构建时基于源代码对程序结构的读取功能，能够通过运行注解处理器来生成新的中间文件，进而影响编译过程，不过它在 JDK 1.8 中被移除了，取而代之的是 JSR 269 插入式注解处理器（Pluggable Annotation Processing API），它是实现了 JSR 269 的机制，作为注解处理器的替代方案。

我们通过一个流程图来进一步说明注解处理器的工作原理：

首先写完代码后会调用 javac 编译，在编译后会生成抽象语法树（AST），之后会调用插入式注解处理器处理，上面说了插入式注解处理器会修改语法树，生成一些额外的代码，经过处理器的处理语法树会有变动，有变动之后，会再次到生成抽象语法树的处理环节，将变动后的代码再次生成抽象语法树，接着再通过注解处理器，如果这次语法树没有被修改，那么就会生成响应的字节码，变成 class 文件，以上就是注解处理器在整个 javac 编译源代码生成 class 文件中起到的作用。

Lombok优缺点

优点

能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率
让代码变得简洁，不用过多的去关注相应的方法
属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点

不支持多种参数构造器的重载
虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

码农公寓