Lombok使用_用google开源的lombok-CSDN博客

Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法

lombok 注解：
    lombok 提供的注解不多，可以参考官方视频的讲解和官方文档。
    Lombok 注解在线帮助文档：http://projectlombok.org/features/index.
    下面介绍几个我常用的 lombok 注解：
        @Data   ：注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法
        @Setter：注解在属性上；为属性提供 setting 方法
        @Getter：注解在属性上；为属性提供 getting 方法
        @Log4j ：注解在类上；为类提供一个属性名为log 的 log4j 日志对象
        @NoArgsConstructor：注解在类上；为类提供一个无参的构造方法
        @AllArgsConstructor：注解在类上；为类提供一个全参的构造方法

@ToString：注解在类上；成toString方法，默认情况下，会输出类名、所有属性，属性会按照顺序输出，以逗号分割。

@EqualsAndHashCode 默认情况下，会使用所有非瞬态(non-transient)和非静态(non-static)字段来生成equals和hascode方法，也可以指定具体使用哪些属性。

下面是简单示例
1.不使用 lombok 的方案

public class Person {
3

private String id;
5

private String name;
6

private String identity;
7

private Logger log = Logger.getLogger(Person.class);
8

public Person() {
10

}
12

public Person(String id, String name, String identity) {
14

this.id = id;
15

this.name = name;
16

this.identity = identity;
17

}
18

public String getId() {
20

return id;
21

}
22

public String getName() {
24

return name;
25

}
26

public String getIdentity() {
28

return identity;
29

}
30

public void setId(String id) {
32

this.id = id;
33

}
34

public void setName(String name) {
36

this.name = name;
37

}
38

public void setIdentity(String identity) {
40

this.identity = identity;
41

}
42

}
43

2.使用 lombok 的方案

@Data
3

@Log4j
4

@NoArgsConstructor
5

@AllArgsConstructor
6

public class Person {
7

private String id;
9

private String name;
10

private String identity;
11

}
13

Lombok原理

了解了简单的使用之后，现在应该比较好奇它是如何实现的。整个使用的过程中，只需要使用注解而已，不需要做其它额外的工作，那玄妙之处应该是在注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

运行时解析

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

boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
<T extends Annotation> T getAnnotation(Class<T> annotationClass);
Annotation[] getAnnotations();
Annotation[] getDeclaredAnnotations();
 
 1
2
3
4

编译时解析

编译时解析有两种机制，网上很多文章都把它俩搞混了，分别简单描述一下。

Annotation Processing Tool

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

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

apt的更多介绍可以参见这里。

Pluggable Annotation Processing API

JSR 269，自JDK6加入，作为apt的替代方案，它解决了apt的两个问题，javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，这时javac执行的过程如下：
这里写图片描述
Lombok就是使用这种方式实现的，有兴趣的话可以去看看其Lombok源码，对应注解的实现都在HandleXXX中，比如@Getter注解的实现是HandleGetter.handle()。还有一些其它类库使用这种方式实现，比如Google Auto、Dagger等等。