到底應不應該使用 lombok

語言: CN / TW / HK

對使用 lombok 還是有很多爭議的,有些公司不建議使用,有些公司又大量使用。

1_Jt34KK87zw10NOLYqU-CNQ

我們的想法是:可以使用,但是不要濫用。

什麼是 lombok

Lombok是 一種Java™實用工具,可用來幫助開發人員消除Java的冗長程式碼,尤其是對於簡單的Java物件(POJO) 。 它通過註釋實現這一目的。 通過在開發環境中實現Lombok,開發人員可以節省構建諸如hashCode() 和 equals()這樣的方法以及以往用來分類各種 accessor和 mutator的大量時間。

我們都知道使用 Java 定義物件的時候都會用到 Getter 和 Setter 方法。

雖然我們有工具幫我們快速生成這些方法,但是實際上還是有點麻煩。

lombok 就可以通過一行註釋來實現所有的這些方法。

lombok 可以做的不僅僅是這個,還可以通過註釋 @Slf4j 來幫你實現自動定義 log。

我們就不用寫冗長的 private static final Logger logger = LoggerFactory.getLogger(ListingProcessor.class) 這句話了。

而且針對 log 的類不同,這句話也是不同的。

如何使用

如果使用 Maven 的話,直接新增下面的依賴到 pom 檔案中就可以了。

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

IDEA 的外掛是自動安裝的,你直接啟用就可以了。

IDEA 會提示你是不是在當前的專案中啟用 lombok,你可以選擇啟用或者不啟用。

2022-07-12_11-51-23

隨後就是在程式碼中使用註釋就可以了。

如下面的程式碼,我們直接簡化使用註解就可以了。

2022-07-12_11-52-23

需要注意的是,使用 log 來標記日誌。

2022-07-12_11-53-33

這樣看起來,程式碼就優雅很多,也能減少不少不需要的程式碼。

lombok 的原理和濫用

Java 程式的解析分為:執行時解析編譯時解析

通常我們通過反射獲取類、方法、註解和成員變數就是執行時解析。但是這種方式效率其實不高,要在程式執行起來才能解析。

這時候編譯時解析就體現出它的價值了。

編譯時解析又分為:註解處理器(Annotation Processing Tool)
JSR 269 插入式註解處理器(Pluggable Annotation Processing API)

第一種處理器它最早是在 JDK 1.5 與註解(Annotation) 一起引入的,它是一個命令列工具,能夠提供構建時基於原始碼對程式結構的讀取功能,能夠通過執行註解處理器來生成新的中間檔案,進而影響編譯過程。

不過在JDK 1.8以後,第一種處理器被淘汰了,取而代之的是第二種處理器。

這樣就導致了 lombok 對 JDK 的相容性出現了一些問題。

當你更換 JDK 版本的時候,lombok 的版本也需要一併進行更換,否則你就會出現錯誤。

如果下面文章討論的錯誤: Java 專案編譯錯誤 Error:java: java.lang.ExceptionInInitializer

就是因為 JDK 不相容的問題導致的整個專案無法編譯。

如果上游系統中提供的fegin client 使用了 lombok,那麼下游系統必須也使用 lombok,否則會報錯,上下游系統構成了強依賴。

如果你需要對 getter 或者 setter 方法進行一些編碼的話,lombok 也不是不能用,但是會有一點點的學習曲線。

綜合上面的考慮, lombok 還是可以用的,但是不要嘗試所有地方都用 lombok,避免濫用。

哪怕就是為了使用 @Slf4j 來考慮的話,也是值得的。

http://www.ossez.com/t/lombok/14036