Lombok詳細教程及idea中lombok插件的安裝

一、背景

我們在開發過程中，通常都會定義大量的JavaBean，然後通過IDE去生成其屬性的構造器、getter、setter、equals、hashcode、toString方法，當要對某個屬性進行改變時，比如命名、類型等，都需要重新去生成上面提到的這些方法，那java中有沒有一種方式能夠避免這種重複的勞動呢？答案是有，我們來看一下下面這張圖，右面是一個簡單的JavaBean，只定義了兩個屬性，在類上加上了@Data，從左面的結構圖上可以看到，已經自動生成了上面提到的方法。

 

二、Lombok簡介

Lombok是一個可以通過簡單的註解形式來幫助我們簡化消除一些必須有但顯得很臃腫的Java代碼的工具，通過使用對應的註解，可以在編譯源碼的時候生成對應的方法。
官方地址：https://projectlombok.org/
github地址：https://github.com/rzwitserloot/lombok。

 

三、Lombok使用

lombok插件的安裝

IDEA中添加Lombok插件,File->Setting->Plugins搜索Lombok Plugin,點擊install,安裝完成後重啓IDEA

備註：如果在上述的安裝過程中無法自動下載，可以選擇本地安裝
插件下載地址：https://plugins.jetbrains.com/plugin/6317-lombok-plugin
具體步驟可以參照 https://blog.csdn.net/shmily_lsl/article/details/80689307 博客
我這邊自己下載的是2016.3版本的

讓idea支持lombok編譯

勾選idea的Enable annotation processing選項，該選項在Preference——Build,Execution,Deployment——Compiler——Annotation Processors中

 

在maven項目的pom.xml中添加依賴

<!-- lombok -->
<dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <version>1.18.2</version>
 <scope>provided</scope>
</dependency>

 

四、Lombok註解介紹

@Data：註解在類上，將類提供的所有屬性都添加get、set方法，並添加、equals、canEquals、hashCode、toString方法
@Setter：註解在類上，爲所有屬性添加set方法、註解在屬性上爲該屬性提供set方法
@Getter：註解在類上，爲所有的屬性添加get方法、註解在屬性上爲該屬性提供get方法
@NotNull：在參數中使用時，如果調用時傳了null值，就會拋出空指針異常
@Synchronized 用於方法，可以鎖定指定的對象，如果不指定，則默認創建一個對象鎖定
@Log作用於類，創建一個log屬性
@Builder：使用builder模式創建對象
@NoArgsConstructor：創建一個無參構造函數
@AllArgsConstructor：創建一個全參構造函數
@ToStirng：創建一個toString方法
@Accessors(chain = true)使用鏈式設置屬性，set方法返回的是this對象。
@RequiredArgsConstructor：創建對象
@UtilityClass:工具類
@ExtensionMethod:設置父類
@FieldDefaults：設置屬性的使用範圍，如private、public等，也可以設置屬性是否被final修飾。
@Cleanup: 關閉流、連接點。
@EqualsAndHashCode：重寫equals和hashcode方法。
@toString：創建toString方法。

下面只是介紹了幾個常用的註解，更多的請參見https://projectlombok.org/features/index.html。

1、@Getter / @Setter註解

可以作用在類上和屬性上，放在類上，會對所有的非靜態(non-static)屬性生成Getter/Setter方法，放在屬性上，會對該屬性生成Getter/Setter方法。並可以指定Getter/Setter方法的訪問級別。當然了屬性上面的Getter和Setter的設置要優先於類上面的

 

2、@EqualsAndHashCode註解

默認情況下，會使用所有非瞬態(non-transient)和非靜態(non-static)字段來生成equals和hascode方法，也可以指定具體使用哪些屬性。
1）. 此註解會生成equals(Object other) 和 hashCode()方法。
2）. 它默認使用非靜態，非瞬態的屬性
3）. 可通過參數exclude排除一些屬性
4）. 可通過參數of指定僅使用哪些屬性
5）. 它默認僅使用該類中定義的屬性且不調用父類的方法
6）. 可通過callSuper=true解決上一點問題。讓其生成的方法中調用父類的方法。

3、@ToString

生成toString方法，默認情況下，會輸出類名、所有屬性，屬性會按照順序輸出，以逗號分割。

4、@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

@NoArgsConstructor ： 生成一個無參數的構造方法
@AllArgsContructor： ?會生成一個包含所有變量
@RequiredArgsConstructor： 會生成一個包含常量，和標識了NotNull的變量的構造方法。生成的構造方法是私有的private。

5、@Data

@Data相當於@Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode這5個註解的合集。
通過官方文檔，可以得知，當使用@Data註解時，則有了@EqualsAndHashCode註解，那麼就會在此類中存在equals(Object other) 和 hashCode()方法，且不會使用父類的屬性，這就導致了可能的問題。 比如，有多個類有相同的部分屬性，把它們定義到父類中，恰好id（數據庫主鍵）也在父類中，那麼就會存在部分對象在比較時，它們並不相等，卻因爲lombok自動生成的equals(Object other) 和 hashCode()方法判定爲相等，從而導致出錯。
修復此問題的方法很簡單：
（1）、使用@Getter @Setter @ToString代替@Data並且自定義equals(Object other) 和 hashCode()方法，比如有些類只需要判斷主鍵id是否相等即足矣。
（2）、 或者使用在使用@Data時同時加上@EqualsAndHashCode(callSuper=true)註解。設置該屬性的話需要保證當前類繼承了父類

6、@slf4j

相當於在類中書寫了 private static final Logger log = LoggerFactory.getLogger(User.class);

 

五、Lombok原理

瞭解了簡單的使用之後，現在應該比較好奇它是如何實現的。整個使用的過程中，只需要使用註解而已，不需要做其它額外的工作，那玄妙之處應該是在註解的解析上。JDK5引入了註解的同時，也提供了兩種解析方式

1、運行時解析

運行時能夠解析的註解，必須將@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();

2、編譯時解析

編譯時解析有兩種機制，網上很多文章都把它倆搞混了，分別簡單描述一下。

（1）、Annotation Processing Tool

apt自JDK5產生，JDK7已標記爲過期，不推薦使用，JDK8中已徹底刪除，自JDK6開始，可以使用Pluggable Annotation Processing API來替換它，apt被替換主要有2點原因：
1）、api都在com.sun.mirror非標準包下
2）、沒有集成到javac中，需要額外運行
apt的更多介紹可以參見這裏。

（2）、Pluggable Annotation Processing API

JSR 269，自JDK6加入，作爲apt的替代方案，它解決了apt的兩個問題，javac在執行的時候會調用實現了該API的程序，這樣我們就可以對編譯器做一些增強，這時javac執行的過程如下：

 

 

  Lombok就是使用這種方式實現的，有興趣的話可以去看看其Lombok源碼，對應註解的實現都在HandleXXX中，比如@Getter註解的實現是HandleGetter.handle()。還有一些其它類庫使用這種方式實現，比如Google Auto、Dagger等等。

六、Lombok初學者使用建議

在剛開始使用Lombok的時候建議大家可以多看看class文件，來加深對你所需要使用註解的理解。

作者：Albert_Yu
鏈接：https://www.jianshu.com/p/3ce2f0a39df4
來源：簡書
著作權歸作者所有。商業轉載請聯繫作者獲得授權，非商業轉載請註明出處。