對(duì)于 POJO, 我們需要為其中的每個(gè)字段生成 getter,setter 方法, 雖然能夠使用 IDE 快速為我們生成. 但如果需要修改字段名稱及字段類型, 那么就需要?jiǎng)h除在重新進(jìn)行生成, 終究還是有一些不方便. 如果使用 lombok, 可以通過一些簡(jiǎn)單的注解直接生成我們所需要的代碼, 能極大的提高開發(fā)體驗(yàn).
-
安裝插件
IDEA 安裝 lombok.png -
啟用插件
啟用插件. png -
在項(xiàng)目中使用
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.14</version> <scope>provided</scope> </dependency> -
lombok 常用注解介紹
-
使用 @NonNull 注解修飾的字段 通過 set 方法設(shè)置時(shí)如果為 null, 將拋出 NullPointerException
-
主要用來修飾 IO 流相關(guān)類, 會(huì)在 finally 代碼塊中對(duì)該資源進(jìn)行 close();
-
為字段生成 getter,setter 方法, 標(biāo)記到類上表明為所有字段生成
-
生成 toString 方法, 默認(rèn)打印所有非靜態(tài)字段
-
生成 equals 和 hashCode 方法
-
@NoArgsConstructor,@RequiredArgsConstructor,@AllArgsConstructor
NoArgsConstructor 無參構(gòu)造函數(shù)
RequiredArgsConstructor 為未初始化的 final 字段和使用 @NonNull 標(biāo)注的字段生成構(gòu)造函數(shù)
AllArgsConstructor 為所有字段生成構(gòu)造函數(shù)
7. @Data
> 相當(dāng)于同時(shí)使用 @Getter,@Setter,@ToString,@EqualsAndHashCode,@RequiredArgsConstructor
8. @Value
> 使用后, 類將使用 final 進(jìn)行修飾, 同時(shí)使用 @ToString,@EqualsAndHashCode,@AllArgsConstructor,@Getter -
創(chuàng)建一個(gè)靜態(tài)內(nèi)部類, 使用該類可以使用鏈?zhǔn)秸{(diào)用創(chuàng)建對(duì)象
如 User 對(duì)象中存在 name,age 字段, User user=User.builder().name("姓名").age(20).build()
10. @SneakyThrows
> 對(duì)標(biāo)注的方法進(jìn)行 try catch 后拋出異常, 可在 value 輸入需要 catch 的異常數(shù)組, 默認(rèn) catch Throwable -
在標(biāo)注的方法內(nèi) 使用 synchronized($lock) {} 對(duì)代碼進(jìn)行包裹 ,$lock 為 new Object[0]
12. @Log,@CommonsLog,@JBossLog,@Log,@Log4j,@Log4j2,@Slf4j,@XSlf4j
> 生成一個(gè)當(dāng)前類的日志對(duì)象, 可以使用 topic 指定要獲取的日志名稱
-
-
自定義配置
雖然 lombok 能為我們快速生成代碼, 但是有一些生成的代碼依然無法滿足我們的需求. 此時(shí)可配置 lombok.config 來解決問題
以下列出一些常用的配置
lombok.getter.noIsPrefix=true(默認(rèn): false) #lombok 默認(rèn)對(duì) boolean 類型字段生成的 get 方法使用 is 前綴, 通過此配置則使用 get 前綴 lombok.accessors.chain=true(默認(rèn): false) #默認(rèn)的 set 方法返回 void 設(shè)置為 true 返回調(diào)用對(duì)象本身 lombok.accessors.fluent=true(默認(rèn): false) #如果設(shè)置為 true. get,set 方法將不帶 get,set 前綴, 直接以字段名為方法名 lombok.log.fieldName=logger(默認(rèn): log) #設(shè)置 log 類注解返回的字段名稱** 注 **: 在 IDEA 中,
lombok.config文件 請(qǐng)放置于src\main\java目錄下, 在src\main\resources中將不生效 -
參考資料
