Lombok教程

（一）介绍

Lombok项目是一个Java库，它会自动插入您的编辑器和构建工具中，从而为您的Java增光添彩。永远不要再编写另一个getter或equals方法，带有一个注解的类将具有功能全面的生成器，自动执行日志记录变量等等。

（二）原理

在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执行的过程如下：

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等等。

（三）Lombok安装

1：引入依赖

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

2：IDEA设置
由于lombok是在编译时期生效的，因此我们需要告诉编辑器我们使用了这个工具，需要让编辑器能够识别，这样我们在观察类结构时就能够看到实际的类代码，如果不设置的话，那么由于我们仅添加了某些注解，这样是程序开发的时候编辑器是无法识别到对应的对应方法的，那么我们就没办法在程序中获取到某类的setter和getter方法了，无法做到智能提示
3：IDEA添加Lombok插件
步骤如下：

打开IDEA，选择[File]->[Settings]->[Plugins]
点击[Browse repositories...]
查找[lombok]安装
重启IDEA
1
2
3
4

4：测试
选择一个实体类，类上添加@Data注解，IDEA按下alt+7,如果正常显示setter和getter方法即设置成功

（四）Lombok注解

备注：想要清楚的查看Lombok的生成的代码，可以每次设置完注解编译该文件，查看对应的class文件即可,如果使用的IDEA的话，按下Ctrl+Shift+F9即可.然后到对应的target目录下查看即可，该文件每次不会自动刷新，需要重新打开

1：@Getter和@Setter

这俩个注解是生成Getter和Setter方法的注解，这俩个注解可以作用到类上也可以作用到单个字段上，作用到类上表示对所有字段添加对应的方法.
其中Getter可以设置方法的访问权限
@Getter(AccessLevel.PROTECTED)不同的访问权限可以通过枚举类AccessLevel设置

注意：
1：@Getter和@Setter只针对成员变量，如果是静态成员不会生成对应的方法
2：如果成员变量是final修饰的，只会生成get方法，不会生成set方法
3：如果不想生成某个具体成员的set和get,那么可以通过如下设置，不提供外部访问和设置方法

 @Getter(AccessLevel.NONE)
 @Setter(AccessLevel.NONE)
1
2

2：@ToString

生成toString()方法，默认会输出所有的成员变量，不会输出静态成员

指定某些成员变量不输出

@ToString(exclude = {"id", "name"})
1

指定变量输出（包括输出静态变量）可以通过of来设置，其中desc是静态变量

@ToString(exclude = {"id", "name"}, of = "desc")

1
2

3：@EqualsAndHashCode

该注解会自动生成equals、canEqual、hashCode三个方法，现在依次查看下每个方法
equals方法，首先判断地址是否相同，然后判断类型是否相同，最后依次对比每个成员变量的值是否相等

public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof User)) {
            return false;
        } else {
            User other = (User)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                Object this$id = this.getId();
                Object other$id = other.getId();
                if (this$id == null) {
                    if (other$id != null) {
                        return false;
                    }
                } else if (!this$id.equals(other$id)) {
                    return false;
                }

                Object this$name = this.getName();
                Object other$name = other.getName();
                if (this$name == null) {
                    if (other$name != null) {
                        return false;
                    }
                } else if (!this$name.equals(other$name)) {
                    return false;
                }

                return true;
            }
        }
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//canEqual就是判断对象是否是当前类实例    
protected boolean canEqual(Object other) {
        return other instanceof User;
    }

1
2
3
4
5

public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $id = this.getId();
        int result = result * 59 + ($id == null ? 43 : $id.hashCode());
        Object $name = this.getName();
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        return result;
    }
1
2
3
4
5
6
7
8
9

自定义EqualsAndHashCode，如果我们只需要判断其中几个字段是否相等，我们可以通过
@EqualsAndHashCode(exclude = {“name”})
@EqualsAndHashCode(of = {“id”})
来排除或者限制某些字段作为判断逻辑

4：@NonNull

@NonNull注解可以用在字段、方法、参数、变量、类上，主要的功能是做非空判断，如果对应值为空，那么会返回一个空指针异常

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE, ElementType.TYPE_USE})

1
2

5：构造函数

@RequiredArgsConstructor会自动会以下成员变量生成对应参数的构造函数
1：被final修改的变量且没有赋初始值的，此时不能有无参构造函数
2：被注解@NonNull修改的成员变量
@NoArgsConstructor 生成无参的构造函数
@AllArgsConstructor 生成所有参数的构造函数

6：@Data
@Data是一个全能的功能型注解，包含了以下几个注解：

@Getter和@Setter
@ToString
@EqualsAndHashCode
@RequiredArgsConstructor

1
2
3
4
5

7：@Builder

@Builder注释为你的类生成相对略微复杂的构建器API。@Builder可以让你以下面显示的那样调用你的代码，来初始化你的实例对象：

User lisi = User.builder().id("123").name("lisi").build();
——————————————————————————————
UserBuilder id = User.builder().id("123456");
User user1 = id.name("zhangsan").build();
User user2 = id.name("lisi").build();

1
2
3
4
5
6

8：@Log

@Log 注解可以不用再在每个类内写机械式的Logger log=xxxx了，lombok帮你搞定，通过这个注解，直接在需要写日志的地方用log.info(“”)就可以了

public void demo() {
        log.info("开始执行demo方法");
  }

1
2
3
4

9:val

当我们在创建集合或者map时需要确定返回类型，但是有了val后在接收返回类型的时候都可以使用val来接收，然后它会自编译时根据实际数据确定对应的类型。注意val可以直接使用只要导包即可，不需要额外的注解，不限制具体的类

val list = new ArrayList<>();
val map = new HashMap<>();
    list.add("AAA");
    map.put("AAA", new User());

//编译后代码如下
 ArrayList<Object> list = new ArrayList();
 HashMap<Object, Object> map = new HashMap();
        list.add("AAA");
        map.put("AAA", new User());

1
2
3
4
5
6
7
8
9
10
11

10： @Cleanup

自动资源管理：没有麻烦和安全地调用您的close()方法。使用@Cleanup以确保在代码执行路径退出当前作用域之前自动清除给定资源。您可以通过使用@Cleanup注解任何局部变量声明来执行此操作.

主要功能：

1：流的自动清理关闭
2：异常自动的处理

@Cleanup FileInputStream inputStream = new FileInputStream("");
 @Cleanup FileOutputStream outputStream = new FileOutputStream("");
1
2

//编译后代码：
    public void demo() throws IOException {
        FileInputStream inputStream = new FileInputStream("");

        try {
            FileOutputStream outputStream = new FileOutputStream("");
            if (Collections.singletonList(outputStream).get(0) != null) {
                outputStream.close();
            }
        } finally {
            if (Collections.singletonList(inputStream).get(0) != null) {
                inputStream.close();
     } }  }
1
2
3
4
5
6
7
8
9
10
11
12
13