Lombok是一款非常實用Java第三方工具,它可以幫助開發人員消除Java的冗長代碼,尤其是對於簡單的Java對象(POJO)。
Lombok在給我們帶來便利的同時,也帶來了不小的隱患。
鑑於自己踩過的許多坑,所以我從不主動推薦別人使用Lombok,但是,也並不會干涉他人使用。並且,因爲我身邊有些同事的代碼還是使用了的,所以我也被迫的要安裝Lombok的插件。
以上就是我對Lombok的態度。既然聊到這個話題,我們也來分析下Lombok的特點:
1、Lombok的使用
1.1 IDE中安裝Lombok插件
目前Lombok支持多種IDE,其中包括主流的Eclips、Intellji IDEA、Myeclipse等都是支持的。
在IDEA中安裝方式如下:
File → Settings → Plugins,輸入“lombok”,選中“install”進行安裝即可,安裝後需重啓IDEA才能運行。
1.2 導入相關依賴
Lombok 支持使用多重構建工具進行導入依賴,目前主要支持maven、gardle、ant等均支持。
如使用maven導入方式如下:
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
1.3 代碼中使用註解
Lombok精簡代碼的方式主要是通過註解來實現,其中常用的有@Data、@Getter/@Setter、@Builder、@NonNull等。
如使用@Data註解,即可簡單的定義一個Java Bean:
import lombok.Data;
@Data
public class User {
private String id;
private String age;
private String name;
private String job;
}
使用@Data註解在類上,這樣一來,這個實體類中的屬性就不需要get,set和toString方法了,這對於POJO類十分有用。
1.4 註釋的含義
- @Date:加在類上,相當於同時使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor這些註解;
- @AllArgsConstructor:加在類上,可以生成含實體類全參數的構造方法;
- @NoArgsConstructor:加在類上,可以生成無參構造方法;
- @RequiredArgsConstructor:加在類上,配合@NonNull註解使用,生成指定參數的構造方法。比如在age屬性前面加@NonNull註解,則User生成需要age參數的構造方法;
- @Getter:加在類上,可以生成實體類所有屬性的getter方法;
- @Setter:加在類上,可以生成實體類所有屬性的setter方法;
- @ToString:加在類上,調用toString()方法,可以輸出實體類中所有屬性的值。
2、Lombok有什麼好處?
通過上面的例子,大家可以發現,使用@Data註解大大減少了代碼量,使代碼非常簡潔,這也是很多開發者熱衷於使用Lombok的主要原因。
不僅如此,我還列舉了Lombok其它的優勢:
- 減少模板代碼:.lombok處理get,set,toString,hash,equal等方法,大量的模板代碼進行封裝,減少重複代碼,當增加新屬性的時候,以上方法都不需要再重新編寫;
- 增強代碼可讀性:專注於類的屬性定義,不需要再去爲排版浪費時間;
- 減少代碼維護:新增屬性的時候,會減少非常多的代碼維護工作。
3、Lombok有什麼壞處?
既然我從不主動推薦別人使用Lombok,那一定是踩過許多坑的經驗之談。
所以,接下來我們重點說一下Lombok在使用過程中會帶來哪些問題。
3.1 強迫隊友
Lombok插件的使用,要求開發者一定要在IDE中安裝對應的插件。不僅自己要安裝,任何和你協同開發的人都要安裝。
如果有誰未安裝插件的話,使用IDE打開一個基於Lombok的項目的話會提示找不到方法等錯誤,導致項目編譯失敗。
更重要的是,如果我們定義的一個jar包中使用了Lombok,那麼就要求所有依賴這個jar包的所有應用都必須安裝插件,這種侵入性是很高的。
只次一點,我就已經決定不在自己的代碼中使用Lombok註解了,但是,爲了項目編譯我依然會使用Lombok插件。
3.2 代碼可調試性降低
Lombok確實可以幫忙減少很多代碼,因爲Lombok會幫忙自動生成很多代碼。
但是,這些代碼是要在編譯階段纔會生成的,所以在開發的過程中,其實很多代碼其實是缺失的。
這就給代碼調試帶來一定的問題,我們想要知道某個類中的某個屬性的getter方法都被哪些類引用的話,就沒那麼簡單了。
3.3 影響版本升級
Lombok對於代碼有很強的侵入性,就可能帶來一個比較大的問題,那就是會影響我們對JDK的升級。
按照如今JDK的升級頻率,每半年都會推出一個新的版本,但是Lombok作爲一個第三方工具,並且是由開源團隊維護的,那麼他的迭代速度是無法保證的。
所以,如果我們需要升級到某個新版本的JDK的時候,若其中的特性在Lombok中不支持的話就會受到影響。
還有一個可能帶來的問題,就是Lombok自身的升級也會受到限制。
因爲一個應用可能依賴了多個jar包,而每個jar包可能又要依賴不同版本的Lombok,這就導致在應用中需要做版本仲裁,而我們知道,jar包版本仲裁是沒那麼容易的,而且發生問題的概率也很高。
3.4 談談踩過的坑
在使用Lombok過程中,如果對於各種註解的底層原理不理解的話,很容易產生意想不到的結果。
舉一個簡單的例子:
我們知道,當我們使用@Data定義一個類的時候,會自動幫我們生成equals()方法 。
但是如果只使用了@Data,而不使用@EqualsAndHashCode(callSuper=true)的話,會默認是@EqualsAndHashCode(callSuper=false),這時候生成的equals()方法只會比較子類的屬性,不會考慮從父類繼承的屬性,無論父類屬性訪問權限是否開放,這就可能得到意想不到的結果。
3.5 可能會破壞封裝性
如果說上面的4點問題都可以人爲避免,那麼,關於封裝性的問題就是Lombok的短板了。
舉個簡單的例子,我們定義一個購物車類:
@Data
public class ShoppingCart {
//商品數目
private int itemsCount;
//總價格
private double totalPrice;
//商品明細
private List items = new ArrayList<>();
}
我們知道,購物車中商品數目、商品明細以及總價格三者之前其實是有關聯關係的,如果需要修改的話是要一起修改的。
但是,我們使用了Lombok的@Data註解,對於itemsCount 和 totalPrice這兩個屬性,雖然我們將它們定義成 private 類型,但是提供了 public 的 getter、setter 方法。
外部可以通過 setter 方法隨意地修改這兩個屬性的值,我們可以隨意調用 setter 方法,來重新設置 itemsCount、totalPrice 屬性的值,這也會導致其跟 items 屬性的值不一致。
而面向對象封裝的定義是:通過訪問權限控制,隱藏內部數據,外部僅能通過類提供的有限的接口訪問、修改內部數據。所以,暴露不應該暴露的 setter 方法,明顯違反了面向對象的封裝特性。
好的做法應該是不提供getter/setter,而是隻提供一個public的addItem方法,同時取修改itemsCount、totalPrice以及items三個屬性。
4、總結
Lombok註解可以自動生成代碼,大大減少了代碼量,使代碼非常簡潔。
但是並不意味着Lombok的使用沒有任何問題,在使用Lombok的過程中,還可能存在對隊友不友好、對代碼不友好、對調試不友好、對升級不友好等問題。
雖然,使用Lombok還會導致破壞封裝性的問題,但是我更認爲Lombok的操作是遵循了Bean的使用初衷。
Bean尤其數據庫和Java類的映射Bean,Java對Bean的定義和使用就是無參數的構造方法和set和get方法,而不應該在bean中處理任何和業務有任何關係的邏輯。
總結下來,我對Lombok的態度是很模糊的,優缺點都很清楚,秉承“不使用就不會有問題”的觀點,所以我自己不使用,也不會主動推薦給別人使用。
少俠請留步 ... ヾ(◍°∇°◍)ノ゙ ...
歡迎點贊、評論、加關注,讓更多人看到學到賺到
更多精彩,請關注我的"今日頭條號":Java雲筆記