[[173296]]

什么是Lombok

一言以蔽之：lombok是一種工具，提供了簡單的注解來簡化我們的重復(fù)冗長Java代碼。比如一個(gè)Java Bean,注解了lombok的@Data：

@Data  
public class NormalBean {  
private String name;  
} 

等價(jià)于以下代碼，Getter/Setter，toString，equals和hashCode方法會在編譯時(shí)自動(dòng)生成。

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的官網(wǎng)，官網(wǎng)上有比較詳細(xì)的文檔。

安裝

lombok不僅要在項(xiàng)目中添加jar包，也要通過插件的形式開啟IDE的支持。如果你的項(xiàng)目是maven構(gòu)建的，那么需要在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 復(fù)制到 eclipse.ini所在文件夾的根目錄
• 編輯 eclipse.ini ，在末尾加入：

-Xbootclasspath/a:lombok.jar  
-javaagent:lombok.jar 

• 重啟

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

用途

lombok包含了很多注解，如果全部用上，的確可以精簡很多的代碼。但在實(shí)際的項(xiàng)目中，我們常常只在定義Java Bean的時(shí)候用上lombok，而在業(yè)務(wù)代碼中很少用到。因?yàn)閘ombok雖然能精簡代碼，但缺點(diǎn)也非常明顯：

• 降低代碼的可讀性
• 調(diào)試?yán)щy

大部分情況下，我們都應(yīng)該將代碼的可讀性放在編碼要考慮因素的首位，以下這幾個(gè)是我覺得最常用的幾個(gè)lombok注解：

@Data

@Setter/Getter

@Log

@NoArgsConstructor, @RequiredArgsConstructor和 @AllArgsConstructor

@Builder

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

總結(jié)

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