Lombok！代碼簡(jiǎn)潔神器還是代碼“亞健康”元兇？

如果您正在閱讀此文，想必您對(duì)Project Lombok已經(jīng)有了一段時(shí)間的了解。您是否正準(zhǔn)備擁抱Lombok?還是正準(zhǔn)備將如此酷炫的項(xiàng)目推薦給你的團(tuán)隊(duì)？如果您準(zhǔn)備那么做，不妨聽(tīng)聽(tīng)我在使用Lombok一年后的一些感受。

我承認(rèn)，Lombok是一個(gè)很不錯(cuò)的Java庫(kù)，它可以讓你在少寫(xiě)代碼的同時(shí)耍?？?，簡(jiǎn)單的幾個(gè)注解，就可以干掉一大片模板代碼。但是，所有的源代碼很多時(shí)候是用來(lái)閱讀的，只有很少的時(shí)間是用來(lái)執(zhí)行的(你可以細(xì)品這句話)。

一年以前，我和大多數(shù)人都認(rèn)為L(zhǎng)ombok的出現(xiàn)會(huì)讓Java的編碼體驗(yàn)會(huì)更好，并極力的在我的團(tuán)隊(duì)中推薦使用Lombok。一年以后，我開(kāi)始對(duì)此產(chǎn)生顧慮，尤其是在我準(zhǔn)備為開(kāi)源的博客系統(tǒng)Una-Boot升級(jí)Java版本時(shí)，我才意識(shí)到Lombok自己掉入了一個(gè)戲法陷阱。在我進(jìn)一步分析其源代碼并理解相關(guān)注解的工作原理后，發(fā)現(xiàn)我并不需要使用一個(gè)非標(biāo)準(zhǔn)的第三方庫(kù)將Java轉(zhuǎn)換為一個(gè)精巧而酷炫的語(yǔ)言。引入Lombok讓我的項(xiàng)目一時(shí)爽，但一時(shí)爽的代價(jià)是隨著項(xiàng)目推進(jìn)，技術(shù)債務(wù)開(kāi)始累積。

接下來(lái)，我將用幾個(gè)大家耳熟能詳?shù)膱?chǎng)景，重演自己是如何掉入Lombok的戲法陷阱。 

愛(ài)的開(kāi)始，恨的起源

面對(duì)Lombok提供的諸多“神走位”，你并不會(huì)介意在IDE上新增一個(gè)插件。對(duì)于IntelliJ IDEA玩家而言，只需搜索“Lombok Plugin”便可找到這款神器并安裝上它。愛(ài)上Lombok從安裝Lombok插件開(kāi)始，恨也從此萌芽。

沒(méi)使用Lombok之前，我們的源代碼看起來(lái)是這一的：

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的模板代碼，這看起來(lái)像一個(gè)偏胖的人（不得不承認(rèn)Java是一個(gè)有缺陷的編程語(yǔ)言）。當(dāng)我們安裝好Lombok插件后，IDE便可以識(shí)別其酷炫的注解，使用Lombok的@Getter和@Setter注解后，代碼會(huì)像下面這樣看起來(lái)很苗條：

@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+
            "}";
    }
}

你以為L(zhǎng)ombok就這點(diǎn)能耐？它還能讓你代碼的“身材”更苗條，更魔鬼。上面的代碼仍然還有改進(jìn)的空間，我們可以用@EqualsAndHashCod注解替換到equals和hashCode方法：

@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+
            "}";
    }
}

@Getter
@Setter
@EqualsAndHashCode
@ToString
public class MyObject{
    private Long id;
    private String name;
    private int age;
    private int gender;
}

@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ù)的變化過(guò)程，也許是無(wú)數(shù)程序員愛(ài)上Lombok的主要原因吧，這就像一個(gè)肥胖的人逐漸變成一個(gè)身材苗條的人。同時(shí)也讓你看到了一個(gè)現(xiàn)象：你以為程序員很懶嗎？其他有些時(shí)候他們比你想象中的還要懶。在爽的同時(shí)，也為代碼種下了禍根。

扭曲的審美，愛(ài)的隱患

扭曲的審美，導(dǎo)致了被審視的對(duì)象出于亞健康狀態(tài)。使用Lombok插件之后，我們的代碼也處于“亞健康”狀態(tài)。還是回歸一開(kāi)始的那句話：所有的源代碼很多時(shí)候是用來(lái)閱讀的，只有很少的時(shí)間是用來(lái)執(zhí)行的。

本質(zhì)上講，我們都追求減少程序中的樣板代碼以使其代碼更精煉簡(jiǎn)潔，從而提高代碼的可讀性和可維護(hù)性。但Lombok并沒(méi)有達(dá)到我們所追求的這一愿景，它僅僅是利用Java語(yǔ)言在編譯時(shí)的空檔期，使用一種很取巧的方式，將我們所需要的方法注入（寫(xiě)入）到當(dāng)前的類中，這種過(guò)程很像在hack我們的代碼，只是一種看起來(lái)酷炫的把戲。這種把戲并不智能和安全，反而會(huì)破壞Java代碼現(xiàn)有的特性以及代碼的可讀性。下面，結(jié)合我自己使用Lombok之后的感受，談?wù)凩ombok帶來(lái)的幾大痛點(diǎn)。

1. JDK版本問(wèn)題

當(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工具完成這一過(guò)程。但這終究會(huì)消耗你很多的時(shí)間。

2. 脅迫使用

當(dāng)你的源代碼中使用了Lombok，恰好你的代碼又被其他的人所使用，那么依賴你代碼的人，也必須安裝Lombok插件(不管他們喜不喜歡)，同時(shí)還要花費(fèi)時(shí)間去了解Lombok注解的使用情況，如果不那么做，代碼將無(wú)法正常運(yùn)行。使用過(guò)Lombok之后，我發(fā)現(xiàn)這是一種很流氓的行為。

3. 可讀性差

4. 代碼耦合度增加

當(dāng)你使用Lombok來(lái)編寫(xiě)某一個(gè)模塊的代碼后，其余依賴此模塊的其他代碼都需要引入Lombok依賴，同時(shí)還需要在IDE中安裝Lombok的插件。雖然Lombok的依賴包并不大，但就因?yàn)槠渲幸粋€(gè)地方使用了Lombok，其余所有的依賴方都要強(qiáng)制加入Lombok的Jar包，這是一種入侵式的耦合，如果再遇上JDK版本問(wèn)題，這將是一場(chǎng)災(zāi)難。

5. 得不償失

使用Lombok，一時(shí)覺(jué)得很爽，但它卻污染了你的代碼，破壞了Java代碼的完整性，可讀性和安全性，同時(shí)還增加的團(tuán)隊(duì)的技術(shù)債務(wù)，這是一種弊大于利，得不償失的操作。如果你確實(shí)想讓自己的代碼更加精煉，同時(shí)又兼顧可讀性和編碼效率，不妨使用主流的Scala或Kotlin這一基于JVM的語(yǔ)言。

 

總結(jié)

Lombok本身是一個(gè)優(yōu)秀的Java代碼庫(kù)，它采用了一種取巧的語(yǔ)法糖，簡(jiǎn)化了Java的編碼，為Java代碼的精簡(jiǎn)提供了一種方式，但在使用此代碼庫(kù)時(shí)，需要了解到Lombok并非一個(gè)標(biāo)準(zhǔn)的Java庫(kù)。使用Lombok，會(huì)增加團(tuán)隊(duì)的技術(shù)債務(wù)，降低代碼的可讀性，增大代碼的耦合度和調(diào)式難度。雖然在一定程度上Lombok減少了樣板代碼的書(shū)寫(xiě)，但也帶來(lái)了一些未知的風(fēng)險(xiǎn)。如果你正在參與一個(gè)團(tuán)隊(duì)項(xiàng)目（或大型項(xiàng)目）,考慮到后續(xù)的升級(jí)與擴(kuò)展，是否使用Lombok，請(qǐng)與你的團(tuán)隊(duì)多溝通和三思。