前言

本人github仓库地址：https://github.com/RabbitsInTheGrass/springBoot-Learning

1. 简介

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变得简洁、快速。
Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。同时可以自动化日志变量。

2. 引入Lombok

使用Lombok需要的开发环境Java+Maven+IntelliJ IDEA或者Eclipse(安装Lombok Plugin)。

2.1 添加maven依赖

<!-- 引入lombok依赖 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>

2.2 idea安装插件

打开idea的设置，点击Plugins，点击Browse repositories，在弹出的窗口中搜索lombok，然后安装即可。
在这里插入图片描述

2.3 编译时出错问题

编译时出错，可能是没有enable注解处理器。在设置中找到Annotation Processors > Enable annotation processing。设置完成之后程序正常运行。

2.4 常用注解

@Setter ：注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。
@Getter ：使用方法同上，区别在于生成的是getter方法。
@ToString ：注解在类，生成toStirng方法。
@EqualsAndHashCode ：注解在类，生成hashCode和equals方法。
@Data ：注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
@NoArgsConstructor ：注解在类，生成无参的构造方法。
@AllArgsConstructor ：注解在类，生成包含类中所有字段的全参的构造方法。
@RequiredArgsConstructor ：注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。
@Log4j ：注解在类上；为类提供一个属性名为log 的 log4j 日志对象
@Slf4j ：注解在类，生成log变量，严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);

注意： 在使用以上注解需要处理参数时，处理方法如下（以@ToString注解为例，其他注解同@ToString注解）：

@ToString(exclude=“column”)
意义：排除column列所对应的元素，即在生成toString方法时不包含column参数；
@ToString(exclude={“column1”,“column2”})
意义：排除多个column列所对应的元素，其中间用英文状态下的逗号进行分割，即在生成toString方法时不包含多个column参数；
@ToString(of=“column”)
意义：只生成包含column列所对应的元素的参数的toString方法，即在生成toString方法时只包含column参数；；
@ToString(of={“column1”,“column2”})
意义：只生成包含多个column列所对应的元素的参数的toString方法，其中间用英文状态下的逗号进行分割，即在生成toString方法时只包含多个column参数；
----------------------------------------------------------------------------------------------------

@Cleanup : 可以关闭流
@Builder ：被注解的类加个构造者模式
@Synchronized ：加个同步锁
@SneakyThrows : 等同于try/catch 捕获异常
@NonNull : 如果给参数加个这个注解，参数为null会抛出空指针异常
@Value : 注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法。
@Accessors：注解在类或者属性上；主要用于控制生成的getter和setter。
fluent： boolean值，默认为false。此字段主要为控制生成的getter和setter方法前面是否带get/set
chain ：boolean值，默认false。如果设置为true，setter返回的是此对象，方便链式调用方法
prefix：设置前缀例如：@Accessors(prefix = “abc”) private String abcAge; 当生成get/set方法时，会把此前缀去掉。

3. 工作原理

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

运行时解析：
运行时能够解析的注解，必须将@Retention设置为RUNTIME，这样就可以通过反射拿到该注解。java.lang.reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口。
编译时解析：
编译时解析有两种机制，分别简单描述下：
- Annotation Processing Tool
  apt自JDK5产生，JDK7已标记为过期，不推荐使用，JDK8中已彻底删除，自JDK6开始，可以使用Pluggable Annotation Processing API来替换它，apt被替换主要有2点原因：
  api都在com.sun.mirror非标准包下；没有集成到javac中，需要额外运行。
- Pluggable Annotation Processing API
  JSR 269自JDK6加入，作为apt的替代方案，它解决了apt的两个问题，javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，javac执行的过程如下：
  
  Lombok本质上就是一个实现了“JSR 269 API”的程序。在使用javac的过程中，它产生作用的具体流程如下：
  - javac对源代码进行分析，生成了一棵抽象语法树（AST）；
  - 运行过程中调用实现了“JSR 269 API”的Lombok程序；
  - 此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点；
  - javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）。通过读Lombok源码，发现对应注解的实现都在HandleXXX中，比如@Getter注解的实现在HandleGetter.handle()。还有一些其它类库使用这种方式实现，比如Google Auto、Dagger等等。

4. Lombok的优缺点

优点：

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

缺点：

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

SpringBoot学习历程（六）：集成Lombok