我承認(rèn),要放棄使用Lombok了!
我承認(rèn),Lombok是一個(gè)很不錯(cuò)的 Java 庫,它可以讓你在少寫代碼的同時(shí)耍???,簡單的幾個(gè)注解,就可以干掉一大片模板代碼。
圖片來自 Pexels
但是,所有的源代碼很多時(shí)候是用來閱讀的,只有很少的時(shí)間是用來執(zhí)行的(你可以細(xì)品這句話)。
一年以前,我和大多數(shù)人都認(rèn)為 Lombok 的出現(xiàn)會(huì)讓 Java 的編碼體驗(yàn)會(huì)更好,并極力的在我的團(tuán)隊(duì)中推薦使用 Lombok。
一年以后,我開始對(duì)此產(chǎn)生顧慮,尤其是在我準(zhǔn)備為開源的博客系統(tǒng) Una-Boot 升級(jí) Java 版本時(shí),我才意識(shí)到 Lombok 自己掉入了一個(gè)戲法陷阱。
在我進(jìn)一步分析其源代碼并理解相關(guān)注解的工作原理后,發(fā)現(xiàn)我并不需要使用一個(gè)非標(biāo)準(zhǔn)的第三方庫將 Java 轉(zhuǎn)換為一個(gè)精巧而酷炫的語言。
引入 Lombok 讓我的項(xiàng)目一時(shí)爽,但一時(shí)爽的代價(jià)是隨著項(xiàng)目推進(jìn),技術(shù)債務(wù)開始累積。
接下來,我將用幾個(gè)大家耳熟能詳?shù)膱鼍?,重演自己是如何掉?Lombok 的戲法陷阱。
愛的開始,恨的起源
面對(duì) Lombok 提供的諸多“神走位”,你并不會(huì)介意在 IDE 上新增一個(gè)插件。對(duì)于 IntelliJ IDEA 玩家而言,只需搜索“Lombok Plugin”便可找到這款神器并安裝上它。愛上 Lombok 從安裝 Lombok 插件開始,恨也從此萌芽。
沒使用 Lombok 之前,我們的源代碼看起來是這一的:
- public class MyObject{
- private Long id;
- private String name;
- private int age;
- private int gender;
- public Long getId(){
- return id;
- }
- public void setId(Long id){
- this.id = id;
- }
- public String getName(){
- return name;
- }
- public void setName(String name){
- this.name = name;
- }
- public int getAge(){
- return age;
- }
- public void setAge(int age){
- this.age = age;
- }
- public int getGender(){
- return gender;
- }
- public void setGender(int gender){
- this.gender = gender;
- }
- @Override
- public boolean equals(Object o){
- if(this == o){
- return true;
- }
- if(o == null || getClass() != o.getClass()){
- return false;
- }
- MyObject obj = (MyObject) o;
- return age = obj.age &&
- gender = obj.gender &&
- Objects.equals(id,obj.id) &&
- Objects.queals(name,obj.name);
- }
- @Override
- public int hashCode(){
- return Objects.hash(id,name,age,gender);
- }
- @Override
- public String toString(){
- return "MyObject{"+
- "id="+id+
- "name="+name+
- "age="+age+
- "gender="+gander+
- "}";
- }
- }
每個(gè) JavaBean 都會(huì)充斥著如上述 getter,setter,equals,hashCode 和 toString 的模板代碼,這看起來像一個(gè)偏胖的人(不得不承認(rèn) Java 是一個(gè)有缺陷的編程語言)。
當(dāng)我們安裝好 Lombok 插件后,IDE 便可以識(shí)別其酷炫的注解,使用 Lombok 的 @Getter 和 @Setter 注解后,代碼會(huì)像下面這樣看起來很苗條:
- @Getter
- @Setter
- public class MyObject{
- private Long id;
- private String name;
- private int age;
- private int gender;
- @Override
- public boolean equals(Object o){
- if(this == o){
- return true;
- }
- if(o == null || getClass() != o.getClass()){
- return false;
- }
- MyObject obj = (MyObject) o;
- return age = obj.age &&
- gender = obj.gender &&
- Objects.equals(id,obj.id) &&
- Objects.queals(name,obj.name);
- }
- @Override
- public int hashCode(){
- return Objects.hash(id,name,age,gender);
- }
- @Override
- public String toString(){
- return "MyObject{"+
- "id="+id+
- "name="+name+
- "age="+age+
- "gender="+gander+
- "}";
- }
- }
現(xiàn)在的代碼是否看起來爽多了?但這還不是最爽的時(shí)候。既然其他方法都替換掉了,那把 toString 方法也一起拿掉吧.如你所愿,可以使用 @ToString 注解去掉對(duì)于的方法:
- @Getter
- @Setter
- @EqualsAndHashCode
- public class MyObject{
- private Long id;
- private String name;
- private int age;
- private int gender;
- @Override
- public String toString(){
- return "MyObject{"+
- "id="+id+
- "name="+name+
- "age="+age+
- "gender="+gander+
- "}";
- }
- }
經(jīng)過 Lombok 的戲法之后,相比一開始的代碼,看起來是不是很酷炫,很苗條,很性感?你以為到此為止了?
遠(yuǎn)不止于此,你會(huì)發(fā)現(xiàn)類名上一大坨注解看起來好別扭,Lombok 提供了一個(gè)組合注解 @Data,可以替換掉類名頭上那坨像翔一樣的東西:
- @Data
- public class MyObject{
- private Long id;
- private String name;
- private int age;
- private int gender;
- }
現(xiàn)在,Lombok 是否讓你的對(duì)象成為了你心目中完美的樣子?魔鬼的“身材”,酷炫精煉。
Lombok 還有其他一些注解,如 @Slf4j,@NoArgsConstructor,@AllArgsConstructor 等等,介紹 Lombok 用法不是本文重點(diǎn)。
以上代碼行數(shù)的變化過程,也許是無數(shù)程序員愛上 Lombok 的主要原因吧,這就像一個(gè)肥胖的人逐漸變成一個(gè)身材苗條的人。
同時(shí)也讓你看到了一個(gè)現(xiàn)象:你以為程序員很懶嗎?其他有些時(shí)候他們比你想象中的還要懶。在爽的同時(shí),也為代碼種下了禍根。
扭曲的審美,愛的隱患
扭曲的審美,導(dǎo)致了被審視的對(duì)象處于亞健康狀態(tài)。使用 Lombok 插件之后,我們的代碼也處于“亞健康”狀態(tài)。
還是回歸一開始的那句話:所有的源代碼很多時(shí)候是用來閱讀的,只有很少的時(shí)間是用來執(zhí)行的。
本質(zhì)上講,我們都追求減少程序中的樣板代碼以使其代碼更精煉簡潔,從而提高代碼的可讀性和可維護(hù)性。
但 Lombok 并沒有達(dá)到我們所追求的這一愿景,它僅僅是利用 Java 語言在編譯時(shí)的空檔期,使用一種很取巧的方式,將我們所需要的方法注入(寫入)到當(dāng)前的類中,這種過程很像在 hack 我們的代碼,只是一種看起來酷炫的把戲。
這種把戲并不智能和安全,反而會(huì)破壞 Java 代碼現(xiàn)有的特性以及代碼的可讀性。
下面,結(jié)合我自己使用 Lombok 之后的感受,談?wù)?Lombok 帶來的幾大痛點(diǎn)。
JDK 版本問題
當(dāng)我想要將現(xiàn)有項(xiàng)目的 JDK 從 Java 8 升級(jí)到 Java 11 時(shí),我發(fā)現(xiàn) Lombok 不能正常工作了。
于是我不得不將所有的 Lombok 注解從項(xiàng)目源代碼中清除,并使用 IDE 自帶的功能生成 getter/setter,equals,hashCode,toString 以及構(gòu)造器等方法。
你也可以使用 Delombok 工具完成這一過程,但這終究會(huì)消耗你很多的時(shí)間。
脅迫使用
當(dāng)你的源代碼中使用了 Lombok,恰好你的代碼又被其他的人所使用,那么依賴你代碼的人,也必須安裝 Lombok 插件(不管他們喜不喜歡),同時(shí)還要花費(fèi)時(shí)間去了解 Lombok 注解的使用情況,如果不那么做,代碼將無法正常運(yùn)行。使用過 Lombok 之后,我發(fā)現(xiàn)這是一種很流氓的行為。
可讀性差
Lombok 隱藏了 JavaBean 封裝的細(xì)節(jié),如果你使用 @AllArgsConstructor 注解,它將提供一個(gè)巨型構(gòu)造器,讓外界有機(jī)會(huì)在初始化對(duì)象時(shí)修改類中所有的屬性。
首先,這是極其不安全的,因?yàn)轭愔心诚祵傩晕覀兪遣幌M恍薷牡?另外,如果某個(gè)類中有幾十個(gè)屬性存在,就會(huì)有一個(gè)包含幾十個(gè)參數(shù)的構(gòu)造器被 Lombo k注入到類中,這是不理智的行為。
其次,構(gòu)造器參數(shù)的順序完全由 Lombok 所控制,我們并不能操控,只有當(dāng)你需要調(diào)試時(shí)才發(fā)現(xiàn)有一個(gè)奇怪的“小強(qiáng)”在等著你。
最后,在運(yùn)行代碼之前,所有 JavaBean 中的方法你只能想象他們長什么樣子,你并不能看見。
代碼耦合度增加
當(dāng)你使用 Lombok 來編寫某一個(gè)模塊的代碼后,其余依賴此模塊的其他代碼都需要引入 Lombok 依賴,同時(shí)還需要在 IDE 中安裝 Lombok 的插件。
雖然 Lombok 的依賴包并不大,但就因?yàn)槠渲幸粋€(gè)地方使用了 Lombok,其余所有的依賴方都要強(qiáng)制加入 Lombok 的 Jar 包,這是一種入侵式的耦合,如果再遇上 JDK 版本問題,這將是一場災(zāi)難。
得不償失
使用 Lombok,一時(shí)覺得很爽,但它卻污染了你的代碼,破壞了 Java 代碼的完整性,可讀性和安全性,同時(shí)還增加的團(tuán)隊(duì)的技術(shù)債務(wù),這是一種弊大于利,得不償失的操作。

如果你確實(shí)想讓自己的代碼更加精煉,同時(shí)又兼顧可讀性和編碼效率,不妨使用主流的 Scala 或 Kotlin 這一基于 JVM 的語言。
總結(jié)
Lombok 本身是一個(gè)優(yōu)秀的 Java 代碼庫,它采用了一種取巧的語法糖,簡化了 Java 的編碼,為 Java 代碼的精簡提供了一種方式,但在使用此代碼庫時(shí),需要了解到 Lombok 并非一個(gè)標(biāo)準(zhǔn)的 Java 庫。
使用 Lombok,會(huì)增加團(tuán)隊(duì)的技術(shù)債務(wù),降低代碼的可讀性,增大代碼的耦合度和調(diào)式難度。
雖然在一定程度上 Lombok 減少了樣板代碼的書寫,但也帶來了一些未知的風(fēng)險(xiǎn)。
如果你正在參與一個(gè)團(tuán)隊(duì)項(xiàng)目(或大型項(xiàng)目),考慮到后續(xù)的升級(jí)與擴(kuò)展,是否使用 Lombok,請與你的團(tuán)隊(duì)多溝通和三思。
作者:ramostear
編輯:陶家龍
出處:https://www.toutiao.com/a6820517160964588044/