1.Lombok背景介绍

官方介绍如下：

Project Lombok makes java a spicier language by adding ‘handlers’ that know how to build and compile simple, boilerplate-free, not-quite-java code.

大致意思是Lombok通过增加一些“处理程序”，可以让java变得简洁、快速。

2.环境安装

Lombok的使用跟引用jar包一样，可以在官网（https://projectlombok.org/download）下载jar包，
也可以使用maven添加依赖：

  1. <dependency>
  2.     <groupId>org.projectlombok</groupId>
  3.     <artifactId>lombok</artifactId>
  4.     <version>1.16.20</version>
  5.     <scope>provided</scope>
  6. </dependency>

3.Lombok中注解

  • val: final 像动态语言一样，声明一个fianl的变量。
  • var: 同JDK10
  • @Data：注解在类上，将类提供的所有属性都添加get、set方法，并添加、equals、canEquals、hashCode、toString方法
  • @Setter：注解在类上，为所有属性添加set方法、注解在属性上为该属性提供set方法
  • @Getter：注解在类上，为所有的属性添加get方法、注解在属性上为该属性提供get方法
  • @NotNull：在参数中使用时，如果调用时传了null值，就会抛出空指针异常
  • @Synchronized 用于方法，可以锁定指定的对象，如果不指定，则默认创建一个对象锁定
  • @Log作用于类，创建一个log属性
  • @Builder：使用builder模式创建对象
  • @NoArgsConstructor：创建一个无参构造函数
  • @AllArgsConstructor：创建一个全参构造函数
  • @ToString：创建一个toString方法
  • @Accessors(chain = true)使用链式设置属性，set方法返回的是this对象。
  • @RequiredArgsConstructor：创建对象, 例: 在class上添加@RequiredArgsConstructor(staticName = “of”)会创建生成一个静态方法
  • @UtilityClass:工具类
  • @ExtensionMethod:设置父类
  • @FieldDefaults：设置属性的使用范围，如private、public等，也可以设置属性是否被final修饰。
  • @Cleanup: 关闭流、连接点。
  • @EqualsAndHashCode：重写equals和hashcode方法。
  • @toString：创建toString方法。
  • @Cleanup: 用于流等可以不需要关闭使用流对象.

@Log4j和@Slf4j : 注解在类上；为类提供一个 属性名为log 的 log4j 日志对像

日志相关的依赖

<!-- 日志处理 -->
<dependencies>
  <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.26</version>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.26</version>
  </dependency>
</dependencies>

4.Lombok工作原理分析

Lombok使用的过程中，只需要添加相应的注解，无需再为此写任何代码。自动生成的代码到底是如何产生的呢？

核心之处就是对于注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

  • 运行时解析

运行时能够解析的注解，必须将@Retention设置为RUNTIME，这样就可以通过反射拿到该注解。java.lang,reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口

  • 编译时解析

编译时解析有两种机制，分别简单描述下：
~~1）Annotation Processing Tool不推荐使用 ~~

apt自JDK5产生，JDK7已标记为过期，不推荐使用，JDK8中已彻底删除，自JDK6开始，可以使用Pluggable Annotation Processing API来替换它，apt被替换主要有2点原因：

  • api都在com.sun.mirror非标准包下
  • 没有集成到javac中，需要额外运行

2）Pluggable Annotation Processing API

JSR 269自JDK6加入，作为apt的替代方案，它解决了apt的两个问题， javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，这时javac执行的过程如下： image.png

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

  1. javac对源代码进行分析，生成了一棵抽象语法树（AST）
  2. 运行过程中调用实现了“JSR 269 API”的Lombok程序
  3. 此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点
  4. javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）

5. Lombok的优缺点

优点：

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

缺点：

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