Lombok的詳細使用及優(yōu)缺點總結
什么是Lombok
Lombok是一款Java開發(fā)插件，可以通過它定義的注解來精簡冗長和繁瑣的代碼，主要針對簡單的Java模型對象（POJO）。
好處就顯而易見了，可以節(jié)省大量重復工作，特別是當POJO類的屬性增減時，需要重復修改的Getter/Setter、構造器方法、equals方法和toString方法等。
而且Lombok針對這些內容的處理是在編譯期，而不是通過反射機制，這樣的好處是并不會降低系統(tǒng)的性能。
下面我們就看看具體的使用。
Lombok的安裝
Lombok的安裝分兩部分：Idea插件的安裝和maven中pom文件的導入。
第一步，在Idea的插件配置中搜索Lombok或官網下載本地安裝。
第二步，引入pom中依賴，當前最細版本1.18.10。
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.10</version>
</dependency>
不知道什么原因，我在使用Idea安裝插件一直失敗，所以只在pom中引入了依賴，也是能正常使用。
Lombok的使用
@Data
@Data最常用的注解之一。注解在類上，提供該類所有屬性的getter/setter方法，還提供了equals、canEqual、hashCode、toString方法。
這里的提供什么意思？就是開發(fā)人員不用手寫相應的方法，而Lombok會幫你生成。
使用@Data示例如下，最直觀的就是不用寫getter/setter方法。
package pojo;
public class User {
private int id;
private String name;
private String pwd;
public User(int id, String hello, String pwd) {
}
public int getId() {
return id;
}
public String getName() {
return name;
}
public String getPwd() {
return pwd;
}
public void setId(int id) {
this.id = id;
}
public void setName(String name) {
this.name = name;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pwd='" + pwd + '\'' +
'}';
}
}
@Data
public class User {
private int id;
private String name;
private String pwd;
}
對比之下效果顯而易見。
@Setter
作用于屬性上，為該屬性提供setter方法; 作用與類上，為該類所有的屬性提供setter方法， 都提供默認構造方法。
public class Demo {
private int id;
@Setter
private String remark;
}
@Setter
public class Demo {
private int id;
private String remark;
}
@Getter
基本使用同@Setter方法，不過提供的是getter方法，不再贅述。
@Log4j
作用于類上，為該類提供一個屬性名為log的log4j日志對象。
@Log4j
public class Demo {
}
該屬性一般使用于Controller、Service等業(yè)務處理類上。與此注解相同的還有@Log4j2，顧名思義，針對Log4j2。
@AllArgsConstructor
作用于類上，為該類提供一個包含全部參的構造方法，注意此時默認構造方法不會提供。
@AllArgsConstructor
public class Demo {
private int id;
private String remark;
}
效果如下：
public class Demo {
private int id;
private String remark;
public Demo(final int id, final String remark) {
this.id = id;
this.remark = remark;
}
}
@NoArgsConstructor
作用于類上，提供一個無參的構造方法。可以和@AllArgsConstructor同時使用，此時會生成兩個構造方法：無參構造方法和全參構造方法。
@EqualsAndHashCode
作用于類上，生成equals、canEqual、hashCode方法。具體效果參看最開始的@Data效果。
@NonNull
作用于屬性上，提供關于此參數的非空檢查，如果參數為空，則拋出空指針異常。
public class Demo {
@NonNull
private int id;
private String remark;
}
@RequiredArgsConstructor
作用于類上，由類中所有帶有@NonNull注解或者帶有final修飾的成員變量作為參數生成構造方法。
@Cleanup
作用于變量，保證該變量代表的資源會被自動關閉，默認調用資源的close()方法，如果該資源有其它關閉方法，可使用@Cleanup(“methodName”)來指定。
public void jedisExample(String[] args) {
try {
@Cleanup Jedis jedis = redisService.getJedis();
} catch (Exception ex) {
logger.error(“Jedis異常:”,ex)
}
}
效果相當于：
public void jedisExample(String[] args) {
Jedis jedis= null;
try {
jedis = redisService.getJedis();
} catch (Exception e) {
logger.error(“Jedis異常:”,ex)
} finally {
if (jedis != null) {
try {
jedis.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
@ToString
作用于類上，生成包含所有參數的toString方法。見@Data中toString方法。
@Value
作用于類上，會生成全參數的構造方法、getter方法、equals、hashCode、toString方法。與@Data相比多了全參構造方法，少了默認構造方法、setter方法和canEqual方法。
該注解需要注意的是：會將字段添加上final修飾，個人感覺此處有些失控，不太建議使用。
@SneakyThrows
作用于方法上，相當于把方法內的代碼添加了一個try-catch處理，捕獲異常catch中用Lombok.sneakyThrow(e)拋出異常。使用@SneakyThrows(BizException.class)指定拋出具體異常。
@SneakyThrows
public int getValue(){
int a = 1;
int b = 0;
return a/b;
}
效果如下：
public int getValue() {
try {
int a = 1;
int b = 0;
return a / b;
} catch (Throwable var3) {
throw var3;
}
}
@Synchronized
作用于類方法或實例方法上，效果與synchronized相同。區(qū)別在于鎖對象不同，對于類方法和實例方法，synchronized關鍵字的鎖對象分別是類的class對象和this對象，而@Synchronized的鎖對象分別是私有靜態(tài)final對象lock和私有final對象lock。也可以指定鎖對象。
public class FooExample {
private final Object readLock = new Object();
@Synchronized
public static void hello() {
System.out.println("world");
}
@Synchronized("readLock")
public void foo() {
System.out.println("bar");
}
}
效果相當于：
public class FooExample {
private static final Object $LOCK = new Object[0];
private final Object readLock = new Object();
public static void hello() {
synchronized($LOCK) {
System.out.println("world");
}
}
public void foo() {
synchronized(readLock) {
System.out.println("bar");
}
}
}
val
使用val作為局部變量聲明的類型，而不是實際寫入類型。 執(zhí)行此操作時，將從初始化表達式推斷出類型。
public Map<String, String> getMap() {
val map = new HashMap<String, String>();
map.put("1", "a");
return map;
}
效果如下：
public Map<String, String> getMap() {
HashMap<String, String> map = new HashMap();
map.put("1", "a");
return map;
}
也就是說在局部變量中，Lombok幫你推斷出具體的類型，但只能用于局部變量中。
@Builder
作用于類上，如果你喜歡使用Builder的流式操作，那么@Builder可能是你喜歡的注解了。
@Builder
public class Demo {
private int id;
private String remark;
}
效果如下：
public class Demo {
private int id;
private String remark;
Demo(final int id, final String remark) {
this.id = id;
this.remark = remark;
}
public static Demo.DemoBuilder builder() {
return new Demo.DemoBuilder();
}
public static class DemoBuilder {
private int id;
private String remark;
DemoBuilder() {
}
public Demo.DemoBuilder id(final int id) {
this.id = id;
return this;
}
public Demo.DemoBuilder remark(final String remark) {
this.remark = remark;
return this;
}
public Demo build() {
return new Demo(this.id, this.remark);
}
public String toString() {
return "Demo.DemoBuilder(id=" this.id ", remark=" this.remark ")";
}
}
}
Lombok的優(yōu)缺點
優(yōu)點：
1、能通過注解的形式自動生成構造器、getter/setter、equals、hashcode、toString等方法，提高了一定的開發(fā)效率
2、讓代碼變得簡潔，不用過多的去關注相應的方法
3、屬性做修改時，也簡化了維護為這些屬性所生成的getter/setter方法等
缺點：
強X隊友
因為Lombok的使用要求開發(fā)者一定要在IDE中安裝對應的插件。如果未安裝插件的話，使用IDE打開一個基于Lombok的項目的話會提示找不到方法等錯誤。導致項目編譯失敗。也就是說，如果項目組中有一個人使用了Lombok，那么其他人就必須也要安裝IDE插件。否則就沒辦法協(xié)同開發(fā)。更重要的是，如果我們定義的一個jar包中使用了Lombok，那么就要求所有依賴這個jar包的所有應用都必須安裝插件，這種侵入性是很高的。代碼可讀性，可調試性低
在代碼中使用了Lombok，確實可以幫忙減少很多代碼，因為Lombok會幫忙自動生成很多代碼。
但是這些代碼是要在編譯階段才會生成的，所以在開發(fā)的過程中，其實很多代碼其實是缺失的。
在代碼中大量使用Lombok，就導致代碼的可讀性會低很多，而且也會給代碼調試帶來一定的問題。
比如，我們想要知道某個類中的某個屬性的getter方法都被哪些類引用的話，就沒那么簡單了。有坑
因為Lombok使代碼開發(fā)非常簡便，這就使得部分開發(fā)者對其產生過度依賴。在使用Lombok過程中，如果對于各種注解的底層原理不理解的話，很容易產生意想不到的結果。舉一個簡單的例子，我們知道，當我們使用@Data定義一個類的時候，會自動幫我們生成equals()方法 。但是如果只使用了@Data，而不使用@EqualsAndHashCode(callSuper=true)的話，會默認@EqualsAndHashCode(callSuper=false),這時候生成的equals()方法只會比較子類的屬性，不會考慮從父類繼承的屬性，無論父類屬性訪問權限是否開放。這就可能得到意想不到的結果。影響升級
因為Lombok對于代碼有很強的侵入性，就可能帶來一個比較大的問題，那就是會影響我們對JDK的升級。按照如今JDK的升級頻率，每半年都會推出一個新的版本，但是Lombok作為一個第三方工具，并且是由開源團隊維護的，那么他的迭代速度是無法保證的。所以，如果我們需要升級到某個新版本的JDK的時候，若其中的特性在Lombok中不支持的話就會受到影響。還有一個可能帶來的問題，就是Lombok自身的升級也會受到限制。因為一個應用可能依賴了多個jar包，而每個jar包可能又要依賴不同版本的Lombok，這就導致在應用中需要做版本仲裁，而我們知道，jar包版本仲裁是沒那么容易的，而且發(fā)生問題的概率也很高。破壞封裝性
以上幾個問題，我認為都是有辦法可以避免的。但是有些人排斥使用Lombok還有一個重要的原因，那就是他會破壞封裝性。眾所周知，Java的三大特性包括封裝性、繼承性和多態(tài)性。如果我們在代碼中直接使用Lombok，那么他會自動幫我們生成getter、setter 等方法，這就意味著，一個類中的所有參數都自動提供了設置和讀取方法。
參考博客：
Java開發(fā)神器Lombok使用詳解
Lombok插件的安裝與簡單使用步驟
到此這篇關于Lombok的詳細使用及優(yōu)缺點總結的文章就介紹到這了,更多相關Lombok使用內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
MybatisPlus3.3.0沒有MybatisPlusInterceptor類問題的解決方法
項目使用的是mybatis-plus-extension3.3.0依賴,然后在我使用分頁插件的時候,發(fā)現無法導入MybatisPlusInterceptor類所以本文給大家介紹了MybatisPlus3.3.0沒有MybatisPlusInterceptor類問題的解決方法,需要的朋友可以參考下2023-12-12
這篇文章主要介紹了Java 從Set里面取出有序的記錄詳解及實例的相關資料,需要的朋友可以參考下2017-06-06
在這篇文章中，我們將來帶大家看看?java.util.Arrays?，我們可以使用?Arrays?創(chuàng)建，比較，排序，搜索，stream?和轉化數組，感興趣的小伙伴可以了解一下2023-02-02
這篇文章主要介紹了Java中使用Preconditions來檢查傳入參數介紹,本文只是作為一個簡單的用法介紹,需要的朋友可以參考下2015-06-06
IntelliJ IDEA快速創(chuàng)建getter和setter方法
這篇文章主要介紹了IntelliJ IDEA快速創(chuàng)建getter和setter方法，本文通過圖文實例相結合給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-03-03
中秋佳節(jié),是我國傳統(tǒng)的重大節(jié)日之一,全國各地為了增強過節(jié)的氣氛,都有許多傳統(tǒng)的中秋活動,比如猜燈謎,所以本文就來用Java制作一個燈謎猜猜樂游戲,感興趣的可以了解下2023-09-09
在日常的開發(fā)工作中經常碰到要處理list中數據的問題。本文主要帶大家了解下Java8?stream流中map()方法的使用，感興趣的小伙伴可以跟隨小編一起學習一下2022-12-12
這篇文章主要為大家詳細介紹了Java中的static關鍵字，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2022-02-02
SpringBoot配置mybatis駝峰命名規(guī)則自動轉換的實現
這篇文章主要介紹了SpringBoot配置mybatis駝峰命名規(guī)則自動轉換的實現，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-09-09
Java concurrency集合之ConcurrentHashMap_動力節(jié)點Java學院整理
這篇文章主要介紹了Java concurrency集合之ConcurrentHashMap的相關資料,需要的朋友可以參考下2017-06-06