一、Lombok簡介
（1）Lombok官網（https://projectlombok.org/）對lombok的介紹
（2）GitHub項目地址：https://github.com/rzwitserloot/lombok
雖然是生硬的翻譯，大家也大致可以看到Lombok存在的價值和意義，Lombok主要是可以提高開發效率，讓我們這些小碼農們工作時可以偷懶，讓我們不再編寫很多臃腫而定式的代碼，雖然現在我們使用IDE工具可以生成很多，但是頻繁的生成也會讓我們的實體類看起來非常的臃腫。Lombok正是我們這些處於水深火熱中的小碼農的福音。
二、Lombok存在的意義：
（1）簡化冗余的JavaBean代碼，使得實體文件很簡潔；
（2）便捷的生成比較復雜的代碼，例如一個POJO要轉化成構建器模式的形式，只需要一個注解。
三、Lombok有哪些注解，他們的作用分別是什么？
a）Lombok的注解概覽
b）下面對每個注解進行一一總結，如下：
1、@NotNull
①詳細介紹：這個注解可以用在成員方法或者構造方法的參數前面，會自動產生一個關於此參數的非空檢查，如果參數為空，則拋出一個空指針異常。
②栗子：
編譯前：
//成員方法參數加上@NonNull注解
public String getName(@NonNull Person p) {
return p.getName();
}
編譯后：
public String getName(@NonNull Person p) {
if (p == null) {
throw new NullPointerException("person");
}
return p.getName();
}
2、@Cleanup
①、詳細介紹：這個注解用在變量前面，可以保證此變量代表的資源會被自動關閉，默認是調用資源的close()方法，如果該資源有其它關閉方法，可使用@Cleanup("methodName")來指定要調用的方法。
②、栗子：
編譯前：
public static void main(String[] args) throws IOException {
@Cleanup InputStream in = new FileInputStream(args[0]);
@Cleanup OutputStream out = new FileOutputStream(args[1]);
byte[] b = new byte[1024];
while (true) {
int r = in.read(b);
if (r == -1) break;
out.write(b, 0, r);
}
}
編譯后：
public static void main(String[] args) throws IOException {
InputStream in = new FileInputStream(args[0]);
try {
OutputStream out = new FileOutputStream(args[1]);
try {
byte[] b = new byte[10000];
while (true) {
int r = in.read(b);
if (r == -1) break;
out.write(b, 0, r);
}
} finally {
if (out != null) {
out.close();
}
}
} finally {
if (in != null) {
in.close();
}
}
}
3、@Getter/@Setter
①、詳細介紹：這一對注解從名字上就很好理解，用在成員變量前面，相當於為成員變量生成對應的get和set方法，同時還可以為生成的方法指定訪問修飾符，當然，默認為public。也可以用在類上，表示為該類所有的屬性，生成對應的get和set方法。
②、栗子：
編譯前：
public class Programmer {
@Getter
@Setter
private String name;
@Setter(AccessLevel.PROTECTED)
private int age;
@Getter(AccessLevel.PUBLIC)
private String language;
}
編譯后：
public class Programmer {
private String name;
private int age;
private String language;
public void setName(String name) {
this.name = name;
}
public String getName() {
return name;
}
protected void setAge(int age) {
this.age = age;
}
public String getLanguage() {
return language;
}
}
4、@Getter（lazy=true）
①詳細介紹：如果Bean的一個字段的初始化是代價比較高的操作，比如加載大量的數據；同時這個字段並不是必定使用的。那么使用懶加載機制，可以保證節省資源。懶加載機制，是對象初始化時，該字段並不會真正的初始化，而是第一次訪問該字段時才進行初始化字段的操作。
5、@ToString/@EqualsAndHashCode
①詳細介紹：這兩個注解也比較好理解，就是生成toString，equals和hashcode方法，同時后者還會生成一個canEqual方法，用於判斷某個對象是否是當前類的實例，生成方法時只會使用類中的非靜態和非transient成員變量，這些都比較好理解，就不舉例子了。
當然，這兩個注解也可以添加限制條件，例如用@ToString(exclude={"param1","param2"})來排除param1和param2兩個成員變量，或者用@ToString(of={"param1","param2"})來指定使用param1和param2兩個成員變量，@EqualsAndHashCode注解也有同樣的用法。
6、@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor
①、詳細介紹：這三個注解都是用在類上的，第一個和第三個都很好理解，就是為該類產生無參的構造方法和包含所有參數的構造方法，第二個注解則使用類中所有帶有@NonNull注解的或者帶有final修飾的成員變量生成對應的構造方法。當然，和前面幾個注解一樣，成員變量都是非靜態的，另外，如果類中含有final修飾的成員變量，是無法使用@NoArgsConstructor注解的。
三個注解都可以指定生成的構造方法的訪問權限，同時，第二個注解還可以用@RequiredArgsConstructor(staticName="methodName")的形式生成一個指定名稱的靜態方法，返回一個調用相應的構造方法產生的對象。
②、栗子：
編譯前：
@RequiredArgsConstructor(staticName = "sunsfan")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@NoArgsConstructor
public class Shape {
private int x;
@NonNull
private double y;
@NonNull
private String name;
}
編譯后：
public class Shape {
private int x;
private double y;
private String name;
public Shape() {
}
protected Shape(int x, double y, String name) {
this.x = x;
this.y = y;
this.name = name;
}
public Shape(double y, String name) {
this.y = y;
this.name = name;
}
public static Shape sunsfan(double y, String name) {
return new Shape(y, name);
}
}
7、@Data/@Value
①、詳細介紹：@Data注解綜合了@Getter/@Setter，@ToString，@EqualsAndHashCode和@RequiredArgsConstructor注解，其中@RequiredArgsConstructor使用了類中的帶有@NonNull注解的或者final修飾的成員變量，它可以使用@Data(staticConstructor="methodName")來生成一個靜態方法，返回一個調用相應的構造方法產生的對象。
@Value注解和@Data類似，區別在於它會把所有成員變量默認定義為private final修飾，並且不會生成set方法。
8、@SneakyThrows
①、詳細介紹：這個注解用在方法上，可以將方法中的代碼用try-catch語句包裹起來，捕獲異常並在catch中用Lombok.sneakyThrow(e)把異常拋出，可以使用@SneakyThrows(Exception.class)的形式指定拋出哪種異常。
②、栗子：
編譯前：
public class SneakyThrows implements Runnable {
@SneakyThrows(UnsupportedEncodingException.class)
public String utf8ToString(byte[] bytes) {
return new String(bytes, "UTF-8");
}
@SneakyThrows
public void run() {
throw new Throwable();
}
}
編譯后：
public class SneakyThrows implements Runnable {
@SneakyThrows(UnsupportedEncodingException.class)
public String utf8ToString(byte[] bytes) {
try {
return new String(bytes, "UTF-8");
} catch(UnsupportedEncodingException uee) {
throw Lombok.sneakyThrow(uee);
}
}
@SneakyThrows
public void run() {
try {
throw new Throwable();
} catch(Throwable t) {
throw Lombok.sneakyThrow(t);
}
}
}
9、@Synchronized
①、詳細介紹：這個注解用在類方法或者實例方法上，效果和synchronized關鍵字相同，區別在於鎖對象不同，對於類方法和實例方法，synchronized關鍵字的鎖對象分別是類的class對象和this對象，而@Synchronized的鎖對象分別是私有靜態final對象LOCK和私有final對象lock，當然，也可以自己指定鎖對象。
②、栗子：
編譯前：
public class Synchronized {
private final Object readLock = new Object();
@Synchronized
public static void hello() {
System.out.println("world");
}
@Synchronized
public int answerToLife() {
return 42;
}
@Synchronized("readLock")
public void foo() {
System.out.println("bar");
}
}
編譯后：
public class Synchronized {
private static final Object $LOCK = new Object[0];
private final Object $lock = new Object[0];
private final Object readLock = new Object();
public static void hello() {
synchronized($LOCK) {
System.out.println("world");
}
}
public int answerToLife() {
synchronized($lock) {
return 42;
}
}
public void foo() {
synchronized(readLock) {
System.out.println("bar");
}
}
}
10、@Log
①、詳細介紹：這個注解用在類上，可以省去從日志工廠生成日志對象這一步，直接進行日志記錄，具體注解根據日志工具的不同而不同，同時，可以在注解中使用topic來指定生成log對象時的類名。
②日志總結，注解對應的日志代碼：
@CommonsLog ==> private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class); @JBossLog ==> private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class); @Log ==> private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName()); @Log4j ==> private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class); @Log4j2 ==> private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class); @Slf4j ==> private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class); @XSlf4j ==> private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);
11、@Accessors
①、詳細介紹：通過該注解可以控制getter和setter方法的形式。
②、栗子：
a）fluent 若為true，則getter和setter方法的方法名都是屬性名，且setter方法返回當前對象。
@Data
@Accessors(fluent = true)
class User {
private Integer id;
private String name;
// 生成的getter和setter方法如下，方法體略
public Integer id(){}
public User id(Integer id){}
public String name(){}
public User name(String name){}
}
b）chain 若為true，則setter方法返回當前對象。
@Data
@Accessors(chain = true)
class User {
private Integer id;
private String name;
// 生成的setter方法如下，方法體略
public User setId(Integer id){}
public User setName(String name){}
}
c）prefix 若為true，則getter和setter方法會忽視屬性名的指定前綴（遵守駝峰命名）
@Data
@Accessors(prefix = "f")
class User {
private Integer fId;
private String fName;
// 生成的getter和setter方法如下，方法體略
public Integer id(){}
public void id(Integer id){}
public String name(){}
public void name(String name){}
}
四、Lombok的實際應用：
a)添加Lombok的maven依賴：
maven依賴：
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.2</version>
<scope>provided</scope>
</dependency>
b）下載插件 Lombok Plugin（為什么要下載IDE插件，下文原理中會詳解）
c）只需要引入依賴、下載插件后，就可以直接在開發時使用啦
使用Lombok開發：
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private String id;
private String username;
private String password;
private Integer age;
private String description;
}
不使用Lombok開發：
package com.shuwen.demo.entity;
public class User {
private String id;
private String username;
private String password;
private Integer age;
private String description;
public User(){}
public User(String id, String username, String password, Integer age, String description) {
this.id = id;
this.username = username;
this.password = password;
this.age = age;
this.description = description;
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
@Override
public String toString() {
return "User{" +
"id='" + id + '\'' +
", username='" + username + '\'' +
", password='" + password + '\'' +
", age=" + age +
", description='" + description + '\'' +
'}';
}
}
經過這一對比，是不是很心動了呢，但是Lombok自身也有一定的缺陷，也需要注意哦~
五、Lombok的缺陷/易導致的錯誤
通過官方文檔，可以得知，當使用@Data注解時，則有了@EqualsAndHashCode注解，那么就會在此類中存在equals(Object other) 和 hashCode()方法，且不會使用父類的屬性，這就導致了可能的問題。
問題：比如，有多個類有相同的部分屬性，把它們定義到父類中，恰好id（數據庫主鍵）也在父類中，那么就會存在部分對象在比較時，它們並不相等，卻因為lombok自動生成的equals(Object other) 和 hashCode()方法判定為相等，從而導致出錯。
六、Lombok的缺陷解決方案
解決方案：
（1）使用@Getter @Setter @ToString代替@Data並且自定義equals(Object other) 和 hashCode()方法，比如有些類只需要判斷主鍵id是否相等即足矣。
（2）或者使用在使用@Data時同時加上@EqualsAndHashCode(callSuper=true)注解
七、Lombok的底層原理
首先我們應該知道的是JSR 269：Pluggable Annotation Processing API：官網地址(https://www.jcp.org/en/jsr/detail?id=269）————可插入注釋處理API，JSR 269 之前我們也有注解這樣的神器，可是我們比如想要做什么必須使用反射，反射的方法局限性較大。
首先，它必須定義：@Retention為RetentionPolicy.RUNTIME，只能在RUNTIME運行時通過反射來獲取注解的值，這會導致運行時代碼效率降低；其次，如果我們想在編碼階段利用注解來執行一些檢查，對用戶的某些不合格或者是不合理的代碼進行告知，反射這種方法這時候就無法解決這樣的問題。
JSR 269如約而至，在它之后我們可以在JAVAC的編譯期利用注解做這些事情，所以我們發現核心的區別還是注解的起作用時間到底是在運行期還是在編譯期。
簡單介紹一下JSR 269（JDK6的新特性）：
如果存在標記處理器，並且編譯參數里面指定要處理標記，那么這個過程就會處理在某個編譯單元里面的標記。JSR269定義了一個接口，可以用來寫這種Annotation處理插件。
從上圖可知，Annotation Processing 是在解析和生成之間的一個步驟。具體詳細步驟如下：
上圖即是Lombok處理流程：
（1）首先JAVAC解析成抽象語法樹（AST）；
（2）然后Lombok根據自己的注解處理器，動態的修改AST，增加新的節點代碼；
（3）最后通過分析和生成字節碼。
自從Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”規范，只要程序實現了該API，就能在javac運行的時候得到調用。
IDE插件Lombok問題：
舉個栗子：
現在有一個A類，其中有一些字段，沒有創建它們的setter和getter方法，使用了lombok的@Data注解，另外有一個B類，它調用了A類實例的相應字段的setter和getter方法
編譯A類和B類所在的項目，並不會報錯，因為最終生成的A類字節碼文件中存在相應字段的setter和getter方法。
但是，IDE有自己的想法，IDE發現B類源代碼中所使用的A類實例的setter和getter方法在A類源代碼中找不到定義，IDE會認為這是錯誤。
所以我們為了讓IDE不認為這是錯誤，讓IDE放心，或者說是糊弄IDE都要下載安裝Lombok Plugin插件。
時光匆匆飛逝，望你我皆有所收獲。