(轉)使用Lombok插件來精簡你的項目代碼

什麼是Lombok

一言以蔽之:lombok是一種工具,提供了簡單的註解來簡化我們的重複冗長Java代碼。比如一個Java Bean,註解了lombok的@Data:

@Data  
public class NormalBean {  
    private String name;  
} 

 等價於以下代碼,Getter/Setter,toString,equals和hashCode方法會在編譯時自動生成。

public class NormalBean {  
    private String name;  
    public String getName() {  
    return name;  
    }  

    public void setName(String name) {  
        this.name = name;  
    }  

    @Override  
    public boolean equals(Object o) {  
        if (this == o) return true;  
        if (o == null || getClass() != o.getClass()) return false;  
        NormalBean that = (NormalBean) o;  
        return name != null ? name.equals(that.name) : that.name == null;  
    }  

    @Override  
    public int hashCode() {  
        return name != null ? name.hashCode() : 0;  
    }  

    @Override  
    public String toString() {  
        return "NormalBean{" +  "name='" + name + '\'' +  '}';  
    }  
} 

lombok的官網,官網上有比較詳細的文檔。


安裝

lombok不僅要在項目中添加jar包,也要通過插件的形式開啓IDE的支持。如果你的項目是maven構建的,那麼需要在pom.xml中添加以下依賴:

<dependency>  
<groupId>org.projectlombok</groupId>  
<artifactId>lombok</artifactId>  
<version>1.16.10</version>  
</dependency> 

這裏推薦使用bom的形式管理pom依賴。比如Spring io platform裏就包含了lombok的dependencyManagement。


idea

在idea下lombok的安裝比較簡單,在plugin裏面安裝lombok plugin即可


eclipse

  • 將lombok.jar 複製到 eclipse.ini所在文件夾的根目錄
  • 編輯 eclipse.ini ,在末尾加入:

-Xbootclasspath/a:lombok.jar  

-javaagent:lombok.jar 

  • 重啓

其他的IDE添加lombok支持請看這裏


用途

lombok包含了很多註解,如果全部用上,的確可以精簡很多的代碼。但在實際的項目中,我們常常只在定義Java Bean的時候用上lombok,而在業務代碼中很少用到。因爲lombok雖然能精簡代碼,但缺點也非常明顯:

  • 降低代碼的可讀性
  • 調試困難

大部分情況下,我們都應該將代碼的可讀性放在編碼要考慮因素的首位,以下這幾個是我覺得最常用的幾個lombok註解:

@Data

@Setter/Getter

@Log

@NoArgsConstructor, @RequiredArgsConstructor和 @AllArgsConstructor

@Builder

@Log和一系列相關注解(如@Log4j,@Slf4j)是我最喜歡的註解,不用寫一堆的getLogger。還有@Builder也很方便,應付簡單的Builder模式足以。


總結

lombok是個非常有用的工具,能夠幫助我們精簡很多臃腫冗長的代碼,不過也有其侷限性,推薦在定義Java Bean中使用


來源於:

http://developer.51cto.com/art/201610/518656.htm

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