奇淫巧技之Lombok

一、Lombok介紹

Lombok是一個可以通過簡單的註解形式來幫助我們簡化消除一些必須有但顯得很臃腫的Java代碼的工具，通過使用對應的註解，可以在編譯源碼的時候生成對應的方法。

二、開胃菜

這裏演示Data annotation：

定義Result類，在Result在引用Data註解
import lombok.Data;

import java.io.Serializable;

@Data
public class Result implements Serializable {
    /**
     * 是否查詢成功
     */
    private boolean success;
    /**
     * 回饋信息
     */
    private String message;
    /**
     * 響應結果代碼
     */
    private String code;

}
從idea顯示的類結構我們可以看出，Result編譯後自動添加了get/set等方法

三、插件安裝

在ide中使用Lombok需要安裝插件，不然ide無法解析Lombok註解。

這裏簡單介紹兩種idea的安裝方式（如果已經打開ide，需要重啓才能生效，idea需要把所有窗口關了重啓）：

Eclipse：

下載lombok.jar，可以去官網下載也可以去maven repository下載（我這裏使用的是maven項目下載下來的lombok.jar）

安裝方式一（這種方式需要你的ide是安裝的，不然可能找不到ide）：

java -jar lombok.jar

安裝方式二（手動安裝）：

打開Eclipse安裝目錄，找到eclipse.ini並打開，在文件末尾加上兩句配置：
-Xbootclasspath/a:D:\DEVTOOLS\ApacheMavenRepositoryNew\org\projectlombok\lombok\1.16.18\lombok-1.16.18.jar
-javaagent:lombok-1.16.18.jar
配置描述：
-Xbootclasspath/a:lombok.jar的路徑
-javaagent:lombok.jar的文件名

InterlliJ IDEA：

在File中找到Setting並打開

選中Plugins，點擊Browse repositories

搜索Lombok

選中Lombok Plugin，點擊右側Install安裝，然後重啓idea就可以了（我這裏已經安裝過了，所有顯示的是Update）

四、註解介紹

構造方法：

AllArgsConstructor

生成一個全參數的構造方法；

屬性作用：

access：構造方法訪問級別

NoArgsConstructor

生成一個無參構造方法，即默認構造方法

屬性作用：

staticName：如果設置了這個屬性，那麼生成的構造方法訪問級別將變成private，並提供一個方法名爲staticName值的靜態方法調用private構造方法

設置staticName

RequiredArgsConstructor:

生成一個包含常量和NonNull標識的字段的構造方法；

校驗類

NonNull

非空校驗，如果是給屬性加上這個註解，那麼，在使用RequiredArgsConstructor註解時，這個標註了NonNull註解的參數將被作爲構造方法初始化，並且初始化參數不能爲null（爲null是拋出NullPointException）；

如果是給參數加上這個註解，那麼將校驗這個參數是否爲null，爲null則拋出Exception

日誌類

JBossLog、Log4j、Slf4j等

生成一個當前類的日誌對象

屬性操作類

Getter/Setter

生成get/set方法，默認public，可以通過access屬性控制方法訪問級別

Accessors

主要用於控制如何生成Getter/Setter

屬性作用：

fluent：控制生成的Getter/Setter方法是否帶get/set，默認false

chain：是否支持鏈式調用，默認false，值爲true時Setter方法返回當前對象，方便鏈式調用

其他

Builder

創建一個靜態內部類，使用該類可以使用鏈式調用創建對象

ToString

生成toString方法，打印類名和每個字段

屬性作用：

exclude：排除哪些字段

callSupper：是否調用父類的toString方法，默認false不調用

EqualsAndHashCode

生成equals和hashCode方法，默認情況下使用所有非靜態非transisent字段

屬性作用：

exclude：排除哪些字段

callSupper：是否調用父類的equals/hashCode方法，默認false不調用

Data

Data是一個“組合”類註解，包含ToString、EqualsAndHashCode、Getter、SetterRequiredArgsConstructor的功能

Synchronized

給方法加上同步鎖，只能用於方法上

Delegate

註釋在屬性上時，會把這個屬性對象的所有非靜態的public方法合到當前類

更多註解內容