Idea使用Lombok简化实体类代码

引入相应的maven包

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

Lombok的scope=provided，说明它只在编译阶段生效，不需要打入包中。事实正是如此，Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。

IDEA添加对Lombok的支持

点击File-- Settings设置界面，安装Lombok插件

点击File-- Settings设置界面，开启Annocation Processors

开启该项是为了让Lombok注解在编译阶段起到作用。

Eclipse的Lombok插件安装可以自行百度，也比较简单，最好在官方下载最新版，网上有些版本可能会导致eclipse出现莫名其妙错误。

Lombok实现原理

自从Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”规范，只要程序实现了该API，就能在javac运行的时候得到调用。

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

javac对源代码进行分析，生成一棵抽象语法树(AST)
javac编译过程中调用实现了JSR 269的Lombok程序
此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树(AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点
javac使用修改后的抽象语法树(AST)生成字节码文件

Lombok注解的使用

POJO类常用注解：

@Getter/@Setter: 作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。

 1 package com.trace;
 2 
 3 import lombok.AccessLevel;
 4 import lombok.Getter;
 5 import lombok.Setter;
 6 
 7 /**
 8  * Created by Trace on 2018/5/19.<br/>
 9  * DESC: 测试类
10  */
11 @SuppressWarnings("unused")
12 public class TestClass {
13 
14     public static void main(String[] args) {
15 
16     }
17 
18 
19     @Getter(value = AccessLevel.PUBLIC)
20     @Setter(value = AccessLevel.PUBLIC)
21     public static class Person {
22         private String name;
23         private int age;
24         private boolean friendly;
25     }
26 
27 
28     public static class Animal {
29         private String name;
30         private int age;
31         @Getter @Setter private boolean funny;
32     }
33     
34 }

在Structure视图中，可以看到已经生成了getter/setter等方法

编译后的代码如下：[这也是传统Java编程需要编写的样板代码]

 1 //
 2 // Source code recreated from a .class file by IntelliJ IDEA
 3 // (powered by Fernflower decompiler)
 4 //
 5 
 6 package com.trace;
 7 
 8 public class TestClass {
 9     public TestClass() {
10     }
11 
12     public static void main(String[] args) {
13     }
14 
15     public static class Animal {
16         private String name;
17         private int age;
18         private boolean funny;
19 
20         public Animal() {
21         }
22 
23         public boolean isFunny() {
24             return this.funny;
25         }
26 
27         public void setFunny(boolean funny) {
28             this.funny = funny;
29         }
30     }
31 
32     public static class Person {
33         private String name;
34         private int age;
35         private boolean friendly;
36 
37         public Person() {
38         }
39 
40         public String getName() {
41             return this.name;
42         }
43 
44         public int getAge() {
45             return this.age;
46         }
47 
48         public boolean isFriendly() {
49             return this.friendly;
50         }
51 
52         public void setName(String name) {
53             this.name = name;
54         }
55 
56         public void setAge(int age) {
57             this.age = age;
58         }
59 
60         public void setFriendly(boolean friendly) {
61             this.friendly = friendly;
62         }
63     }
64 }

@ToString：作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段。

@EqualsAndHashCode：作用于类，覆盖默认的equals和hashCode

@NonNull：主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常。

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：作用于类上，用于生成构造函数。有staticName、access等属性。

staticName属性一旦设定，将采用静态方法的方式生成实例，access属性可以限定访问权限。

@NoArgsConstructor：生成无参构造器；

@RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器；

@AllArgsConstructor：生成全参构造器。

编译后结果

 1 public static class Person {
 2     @NonNull
 3     private String name;
 4     private int age;
 5     private boolean friendly;
 6 
 7     public String toString() {
 8         return "TestClass.Person(name=" + this.getName() + ", age=" + this.getAge() + ")";
 9     }
10 
11     @NonNull
12     public String getName() {
13         return this.name;
14     }
15 
16     public int getAge() {
17         return this.age;
18     }
19 
20     public boolean isFriendly() {
21         return this.friendly;
22     }
23 
24     public void setName(@NonNull String name) {
25         if(name == null) {
26             throw new NullPointerException("name");
27         } else {
28             this.name = name;
29         }
30     }
31 
32     public void setAge(int age) {
33         this.age = age;
34     }
35 
36     public void setFriendly(boolean friendly) {
37         this.friendly = friendly;
38     }
39 
40     private Person() {
41     }
42 
43     private static TestClass.Person of() {
44         return new TestClass.Person();
45     }
46 
47     @ConstructorProperties({"name"})
48     Person(@NonNull String name) {
49         if(name == null) {
50             throw new NullPointerException("name");
51         } else {
52             this.name = name;
53         }
54     }
55 
56     @ConstructorProperties({"name", "age", "friendly"})
57     public Person(@NonNull String name, int age, boolean friendly) {
58         if(name == null) {
59             throw new NullPointerException("name");
60         } else {
61             this.name = name;
62             this.age = age;
63             this.friendly = friendly;
64         }
65     }
66 }

@Data：作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

@Builder：作用于类上，将类转变为建造者模式

@Log：作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解

其他重要注解：

@Cleanup：自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象

编译后结果如下：

@SneakyThrows：可以对受检异常进行捕捉并抛出，可以改写上述的main方法如下

@Synchronized：作用于方法级别，可以替换synchronize关键字或lock锁，用处不大

原文作者：LiWenD正在掘金

原文地址：https://juejin.im/post/5b00517cf265da0ba0636d4b