Lombok的介紹與使用

目錄

 

什麼是Lombok

Lombok使用的注意事項

IDEA中使用Lombok教程:

   1.在IDEA中安裝Lombok插件

      2.導入相關依賴

       3.代碼中使用


什麼是Lombok

Lombok是一款非常實用的Java開發工具,它通過註釋可以實現幫助開發人員消除java冗長的代碼,尤其對於簡單的Java對象(pojo類)

Lombok使用的注意事項

因爲Lombok的使用要求開發者一定要在IDE中安裝對應的插件。

如果未安裝插件的話,使用IDE打開一個基於Lombok的項目的話會提示找不到方法等錯誤。導致項目編譯失敗。

也就是說,如果項目組中有一個人使用了Lombok,那麼其他人就必須也要安裝IDE插件。否則就沒辦法協同開發。

更重要的是,如果我們定義的一個jar包中使用了Lombok,那麼就要求所有依賴這個jar包的所有應用都必須安裝插件,這種侵入性是很高的。

代碼可讀性,可調試性低

在代碼中使用了Lombok,確實可以幫忙減少很多代碼,因爲Lombok會幫忙自動生成很多代碼。

但是這些代碼是要在編譯階段纔會生成的,所以在開發的過程中,其實很多代碼其實是缺失的。

在代碼中大量使用Lombok,就導致代碼的可讀性會低很多,而且也會給代碼調試帶來一定的問題。

比如,我們想要知道某個類中的某個屬性的getter方法都被哪些類引用的話,就沒那麼簡單了。

有坑

因爲Lombok使代碼開發非常簡便,這就使得部分開發者對其產生過度依賴。

在使用Lombok過程中,如果對於各種註解的底層原理不理解的話,很容易產生意想不到的結果。

舉一個簡單的例子,我們知道,當我們使用@Data定義一個類的時候,會自動幫我們生成equals()方法 。

但是如果只使用了@Data,而不使用@EqualsAndHashCode(callSuper=true)的話,會默認是@EqualsAndHashCode(callSuper=false),這時候生成的equals()方法只會比較子類的屬性,不會考慮從父類繼承的屬性,無論父類屬性訪問權限是否開放。

這就可能得到意想不到的結果。

影響升級

因爲Lombok對於代碼有很強的侵入性,就可能帶來一個比較大的問題,那就是會影響我們對JDK的升級。

按照如今JDK的升級頻率,每半年都會推出一個新的版本,但是Lombok作爲一個第三方工具,並且是由開源團隊維護的,那麼他的迭代速度是無法保證的。

所以,如果我們需要升級到某個新版本的JDK的時候,若其中的特性在Lombok中不支持的話就會受到影響。

還有一個可能帶來的問題,就是Lombok自身的升級也會受到限制。

因爲一個應用可能依賴了多個jar包,而每個jar包可能又要依賴不同版本的Lombok,這就導致在應用中需要做版本仲裁,而我們知道,jar包版本仲裁是沒那麼容易的,而且發生問題的概率也很高。

破壞封裝性

以上幾個問題,我認爲都是有辦法可以避免的。但是有些人排斥使用Lombok還有一個重要的原因,那就是他會破壞封裝性。

衆所周知,Java的三大特性包括封裝性、繼承性和多態性。

如果我們在代碼中直接使用Lombok,那麼他會自動幫我們生成getter、setter 等方法,這就意味着,一個類中的所有參數都自動提供了設置和讀取方法。

舉個簡單的例子,我們定義一個購物車類:

@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三個屬性。

IDEA中使用Lombok教程:

   1.在IDEA中安裝Lombok插件

目前Lombok支持多種IDE,其中包括主流的Eclips、Intellji IDEA、Myeclipse等都是支持的。

在IDEA中安裝方式如下:

        File  >   Settings  >  Plugins,如圖,安裝完之後重啓IDEA

      2.導入相關依賴

Lombok 支持使用多重構建工具進行導入依賴,目前主要支持maven、gardle、ant等均支持。

下面是maven依賴

<dependency>

    <groupId>org.projectlombok</groupId>

    <artifactId>lombok</artifactId>

    <version>1.18.12</version>

    <scope>provided</scope>

</dependency>

       3.代碼中使用

Lombok精簡代碼的方式主要是通過註解來實現,其中常用的有@Data、@Getter/@Setter、@Builder、@NonNull等。

如使用@Data註解,即可簡單的定義一個Java Bean:

使用@Data註解在類上,相當於同時使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor這些註解,對於POJO類十分有用。

即自動幫忙給例子中的Menu類中定義了toString、Getter、Setter等方法。

通過上面的例子,大家可以發現,我們使用@Data註解大大減少了代碼量,使代碼非常簡潔。這也是很多開發者熱衷於使用Lombok的主要原因。

但是使用Lombok也有很多的弊端,所以還是結合實際開發以及公司要求慎重使用

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章