[[426490]]

本文轉載自微信公眾號「Java極客技術」，作者鴨血粉絲Tang。轉載本文請聯系Java極客技術公眾號。

一、介紹

Java，作為一款非常熱門的編程語言，盡管它有著非常豐富的語言特性，完全面向對象編程，編程高度規范化，但是也有一個最受大家詬病的一個缺點：啰嗦，尤其是當你開發了很多年之后，你會明顯的感受到，相比動態語言，java 定義變量之前，要先創建類，然后定義變量類型，每個類要寫很多的get/set/toString/hashCode/equals等等方法。

尤其是當一個實體類，高達幾十個變量時，寫完get、set方法之后，一個實體類的長度快接近一千行。

為了避免寫這些“羅嗦”的方法，很多程序員一直在尋覓著找一個能夠使他們擺脫這種重復勞動工作的工具，例如：idea、eclipse 開發工具的快捷生成get、set方法的工具，還有我們今天要談論的這個Lombok工具。

二、Lombok

Lombok 是一款非常流行的代碼簡潔工具，利用它的注解特性，直接就可以幫我們省去高大幾百行的get、set方法，操作非常方便。

如果是idea開發工具，可以直接在preferences -> plugins里面搜索lombok，然后點擊安裝即可!

接著，在項目工程中導入lombok依賴包!

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

 

最后，只需要在對應的實體類上加上@Data注解，即可完成類屬性get/set的注入。

import lombok.Data; 
 
@Data 
public class User { 
    private String id; 
    private String age; 
    private String name; 
  
 //可以不用顯式寫get、set方法 
} 

使用@Data注解在類上，這個實體類中的屬性就不需要顯式寫get、set方法了。

對這個類進行編譯之后，我們打開User.class文件，看看編譯后的文件內容長啥樣?

public class User { 
    private String id; 
    private String age; 
    private String name; 
 
    public User() { 
    } 
 
    public String getId() { 
        return this.id; 
    } 
 
    public String getAge() { 
        return this.age; 
    } 
 
    public String getName() { 
        return this.name; 
    } 
 
    public void setId(String id) { 
        this.id = id; 
    } 
 
    public void setAge(String age) { 
        this.age = age; 
    } 
 
    public void setName(String name) { 
        this.name = name; 
    } 
 
    public boolean equals(Object o) { 
        if (o == this) { 
            return true; 
        } else if (!(o instanceof User)) { 
            return false; 
        } else { 
            User other = (User)o; 
            if (!other.canEqual(this)) { 
                return false; 
            } else { 
                label47: { 
                    Object this$id = this.getId(); 
                    Object other$id = other.getId(); 
                    if (this$id == null) { 
                        if (other$id == null) { 
                            break label47; 
                        } 
                    } else if (this$id.equals(other$id)) { 
                        break label47; 
                    } 
 
                    return false; 
                } 
 
                Object this$age = this.getAge(); 
                Object other$age = other.getAge(); 
                if (this$age == null) { 
                    if (other$age != null) { 
                        return false; 
                    } 
                } else if (!this$age.equals(other$age)) { 
                    return false; 
                } 
 
                Object this$name = this.getName(); 
                Object other$name = other.getName(); 
                if (this$name == null) { 
                    if (other$name != null) { 
                        return false; 
                    } 
                } else if (!this$name.equals(other$name)) { 
                    return false; 
                } 
 
                return true; 
            } 
        } 
    } 
 
    protected boolean canEqual(Object other) { 
        return other instanceof User; 
    } 
 
    public int hashCode() { 
        int PRIME = true; 
        int result = 1; 
        Object $id = this.getId(); 
        int result = result * 59 + ($id == null ? 43 : $id.hashCode()); 
        Object $age = this.getAge(); 
        result = result * 59 + ($age == null ? 43 : $age.hashCode()); 
        Object $name = this.getName(); 
        result = result * 59 + ($name == null ? 43 : $name.hashCode()); 
        return result; 
    } 
 
    public String toString() { 
        return "User(id=" + this.getId() + ", age=" + this.getAge() + ", name=" + this.getName() + ")"; 
    } 
} 

很清晰的看到，使用@Data注解之后，User類新增了get、set、hashCode、equals和toString方法。

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

Lombok的工作原理是怎么實現的呢?

由于Java的官方版本沒有提供這種快速生成方法的注解工具，類似Lombok這樣的工具，其實都是使用了從Java 6和JSR 269的Annotation Processing技術中實現方法的注入。

簡單的說，就是使用了 Java 非公開的 API，在 javac 編譯代碼時，通過強類型轉換獲取JavacAnnotationProcessor對象，再從JavacAnnotationProcessor的方法里面拿到抽象語法樹(AST)做強制修改，注入get、set等方法。

使用Lombok這種方案，有個最大的好處，就是可以節省大量的重復代碼，讓代碼更佳簡潔!但是也有很多弊端!

三、有哪些壞處呢?

3.1、強迫隊友也安裝 Lombok

當你在使用Lombok工具插件來快速開發項目的時候，如果別的同事也要和你一起協作開發項目，那么他不得不也要安裝Lombok插件，不然項目編譯會報錯。

3.2、代碼可調試性降低

代碼可調試性會降低，為什么會這么說呢?

Lombok雖然給我們節省了get和set方法的編程，但是如果我想知道類的某個屬性被哪些方法操作給set了，如果用原生的方法，可以很好的知道調用方。但是如果使用Lombok插件來生成，這個時候你根本無從得知。甚至沒辦法調試!

3.3、不懂 Lombok 注解，會踩坑

我們知道，使用@Data會重寫hashCode()和equals()方法，如果是單個實體類，沒有繼承的話，你使用@Data不會產生問題。

但是如果這個實體類又繼承了父類，@Data只會重寫子類的hashCode()和equals()方法，不會把父類的屬性加進去，這樣就會導致，例如當你在使用HashMap的時候，用當前這個實體類作為key，可能會得到意想不到的結果。

遇到這種情況，你可以在類上加上這個注解@EqualsAndHashCode(callSuper=true)，子類的hashCode()和equals()方法會加入父類的屬性。

3.4、破壞封裝性

封裝是 java 面向對象編程中非常重要的一個特性。

例如，針對User實體類，我新加一個tag屬性，我只想暴露它的get方法，不想暴露set方法給外部，沒有用@Data注解的時候，我可以很靈活的進行編程，但是使用@Data注解之后，屬性tag被完全暴露在外界了。

public class User { 
 
    private String id; 
 
    private String age; 
 
    private String name; 
 
    private String tag = "學生"; 
 
    public String getTag() { 
        return tag; 
    } 
     
} 

3.5、影響 jdk 升級

其實以上的坑點，都不算什么很大的坑點，在我看來，最大的坑點其實就是Lombok的工作原理，使用了非官方支持的 API 接口，通過程序強制植入方式來修改類，實現get、set等方法的注入。

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

假如某天JDK把這種后門堵住了，那Lombok基本上就不能用了，到時候又是個麻煩事情。

四、總結

Lombok 作為一款非常流行的工具插件，肯定有它自身的優勢所在，到底建不建議在日常開發中使用，我個人其實是一個中立的態度，如果你們團隊的人都喜歡它，那推薦你使用，在使用之前，最好培訓一下，有哪些坑點，避免踩坑。

如果多數人不太喜歡用它，那就不推薦你使用，很多公司禁止你使用它的原因，其實這種插件有點類似那種流氓插件，工作原理不是官方所認可的方式來實現，假如某天新版本的 jdk 突然把這個漏洞給堵住了，那么項目想要升級 jdk，就比較困難。

因此大家在評估要不要在代碼中引入Lombok的時候，在想它的優點同時，能夠考慮到它會帶來的哪些問題，以便更好的做決定!

五、參考

https://projectlombok.org/

https://time.geekbang.org/column/article/164907

http://blog.itpub.net/69908877/viewspace-2676272/