當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

Lombok 介绍和使用详情

發布時間：2025/3/20 编程问答 36 豆豆

生活随笔收集整理的這篇文章主要介紹了 Lombok 介绍和使用详情小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

介紹

在項目中使用Lombok可以減少很多重復代碼的書寫。比如說getter/setter/toString等方法的編寫。

IDEA中的安裝

打開IDEA的Setting –> 選擇Plugins選項 –> 選擇Browse repositories –> 搜索lombok –> 點擊安裝 –> 安裝完成重啟IDEA –> 安裝成功
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-8Wxu6puV-1626182323785)(http://1.file.leanote.top/5a54370fab644126e2000c44/1515465239279_2.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:ECrRjWgXnbUD3XO3DQfOybg-xPc)]

引入依賴

在項目中添加Lombok依賴jar，在pom文件中添加如下部分。(不清楚版本可以在Maven倉庫中搜索)

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

使用

在對應的類或者方法上使用對應注解即可。

Lombok有哪些注解

@Setter
@Getter
@Data
@Log(這是一個泛型注解，具體有很多種形式)
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode
@NonNull
@Cleanup
@ToString
@RequiredArgsConstructor
@Value
@SneakyThrows
@Synchronized

注解詳情

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);

默認情況下，記錄器的主題（或名稱）將是使用注釋進行@Log注釋的類的類名稱。這可以通過指定topic參數來定制。例如：@XSlf4j(topic="reporting")。

該類型注解可以滿足不同的日志系統的日志使用，Lombok提供了一些自定義配置項可以參看官方說明文檔。

Log官方介紹

@Getter和@Setter

該注解使用在類或者屬性上，該注解可以使用在類上也可以使用在屬性上。生成的getter遵循布爾屬性的約定。例如：boolean類型的sex,getter方法為isSex而不是getSex

在使用該注解時，會默認生成一個無參構造。和對應的getterhe setter方法
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-1XlicXQE-1626182323786)(http://1.file.leanote.top/5a54370fab644126e2000c49/1515466096955_4.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:_z0z0eT_f5KIjw8coUCwgOPBiy8)]

該注解也可以使用在單個屬性上，會默認生成一個無參構造：
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-T7eXqMiW-1626182323787)(http://1.file.leanote.top/5a54370fab644126e2000c48/1515466294316_5.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:vRO2cgQmWTXc6JehUN8H8foZDoM)]

@Data

該注解使用在類上，該注解會提供getter、setter、equals、canEqual、hashCode、toString方法。

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-kZ3TLKRn-1626182323787)(http://1.file.leanote.top/5a54370fab644126e2000c43/1515466806437_6.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:K2BqAPlrfIj6nk1VyDkxv30ldfk)]

@NonNull

該注解使用在屬性上，該注解用于屬的非空檢查，當放在setter方法的字段上，將生成一個空檢查，如果為空，則拋出NullPointerException。
該注解會默認是生成一個無參構造。
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-KedikOaL-1626182323789)(http://1.file.leanote.top/5a54370fab644126e2000c47/1515467159376_7.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:0XIqPQzaJbSu9J-y51X_-lbXDDE)]

@toString

該注解使用在類上，該注解默認生成任何非講臺字段以名稱-值的形式輸出。
1、如果需要可以通過注釋參數includeFieldNames來控制輸出中是否包含的屬性名稱。
2、可以通過exclude參數中包含字段名稱，可以從生成的方法中排除特定字段。
3、可以通過callSuper參數控制父類的輸出。

includeFieldNames是否包含屬性名稱：
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-itT8rOPV-1626182323790)(http://1.file.leanote.top/5a54370fab644126e2000c42/1515467459770_8.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:KJKqvKXu0OldtrJUPekOe3S9ntI)]
exclude 排除指定字段
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-6obeCfoR-1626182323791)(http://1.file.leanote.top/5a54370fab644126e2000c45/1515468047413_9.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:zsKgxa2gTCpElZSWULvxn0aUef0)]
callSuper輸出父類屬性
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-OSZU4xTp-1626182323792)(http://1.file.leanote.top/5a543c1aab644126e2000d38/1515469434112_10.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:IqeKwFLMTuPPMpTtjedZLc6ddgE)]

注意：父類也要有toString方法，不然打印的是對象內存地址

//父類無toString方法 Person(super=com.motui.Person@3abfe836, firstName=motui, address=北京, dateOfBirth=Tue Jan 09 11:49:05 CST 2018, sex=true) //父類有toString方法 Person(super=People(id=111), firstName=motui, address=北京, dateOfBirth=Tue Jan 09 11:50:11 CST 2018, sex=true)

@EqualsAndHashCode

該注解使用在類上，該注解在類級別注釋會同時生成equals和hashCode。
注意繼承關系的時候該注解的使用。詳細介紹參照官方介紹
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-fRuCmuQ1-1626182323792)(http://1.file.leanote.top/5a543f5dab644126e2000d85/1515470235374_11.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:sjZmfKM8d3vCdzGvL5KwQeOzYP0)]

存在繼承關系需要設置callSuper參數為true。

@Data

該注解使用在類上，該注解是最常用的注解，它結合了@ToString，@EqualsAndHashCode， @Getter和@Setter。本質上使用@Data注解，類默認@ToString和@EqualsAndHashCode以及每個字段都有@Setter和@getter。該注解也會生成一個公共構造函數，可以將任何@NonNull和final字段作為參數。

雖然@Data注解非常有用，但是它沒有與其他注解相同的控制粒度。@Data提供了一個可以生成靜態工廠的單一參數，將staticConstructor參數設置為所需要的名稱，Lombok自動生成的構造函數設置為私有，并提供公開的給定名稱的靜態工廠方法。
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-wG4cFd7M-1626182323793)(http://1.file.leanote.top/5a546265ab644126e2001263/1515476412751_12.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:qp8aGxlfa2DcAnWco2d57bk2C-w)]

@AllArgsConstructor

該注解使用在類上，該注解提供一個全參數的構造方法，默認不提供無參構造。
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-vRhg5MFG-1626182323794)(http://1.file.leanote.top/5a546265ab644126e2001260/1515478142533_16.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:UO-4ANEldw7j5lZuR66tEWy-4io)]

@NoArgsConstructor

該注解使用在類上，該注解提供一個無參構造
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-774Dk3A0-1626182323794)(http://1.file.leanote.top/5a546266ab644126e2001264/1515478200493_17.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:ng0PugDk_lmiDlCNC1IIrrMxZ3U)]

@RequiredArgsConstructor

該注解使用在類上，使用類中所有帶有 @NonNull 注解的或者帶有 final 修飾的成員變量生成對應的構造方法。

@Value

這個注解用在類上，會生成含所有參數的構造方法，get 方法，此外還提供了equals、hashCode、toString 方法。
注意：沒有setter

@Cleanup

該注解使用在屬性前，該注解是用來保證分配的資源被釋放。在本地變量上使用該注解，任何后續代碼都將封裝在try/finally中，確保當前作用于中的資源被釋放。默認@Cleanup清理的方法為close，可以使用value指定不同的方法名稱。
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-nZQZAVZR-1626182323795)(http://1.file.leanote.top/5a546266ab644126e2001266/1515476968925_13.png?e=1531792696&token=ym9ZIrtxjozPN4G9he3-FHPOPxAe-OQmxzol5EOk:Fvl9zn1Xyw34UHGa3aatB03-pDs)]

@Synchronized

該注解使用在類或者實例方法上，Synchronized在一個方法上，使用關鍵字可能會導致結果和想要的結果不同，因為多線程情況下會出現異常情況。Synchronized
關鍵字將在this示例方法情況下鎖定當前對象，或者class講臺方法的對象上多鎖定。這可能會導致死鎖現象。一般情況下建議鎖定一個專門用于此目的的獨立鎖，而不是允許公共對象進行鎖定。該注解也是為了達到該目的。

@SneakyThrows

該注解使用在方法上，這個注解用在方法上，可以將方法中的代碼用 try-catch 語句包裹起來，捕獲異常并在 catch 中用 Lombok.sneakyThrow(e) 把異常拋出，可以使用 @SneakyThrows(Exception.class) 的形式指定拋出哪種異常。該注解需要謹慎使用。詳情參看官方介紹

結語

Lombok的目的是減少代碼的重復編寫，并提供比較好的解決方案。當然也存在一些爭議性的注解，可以根據實際場景進項使用。Lombok有一些實驗注解可以在官網查看。

出處：https://blog.csdn.net/motui/article/details/79012846

總結

以上是生活随笔為你收集整理的Lombok 介绍和使用详情的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：微信小程序Java登录流程（ssm实现具
下一篇： SSM三大框架整合Springfox(S