一、項(xiàng)目背景

在寫Java程序的時(shí)候經(jīng)常會(huì)遇到如下情形：

新建了一個(gè)Class類，然后在其中設(shè)置了幾個(gè)字段，最后還需要花費(fèi)很多時(shí)間來建立getter和setter方法。

lombok項(xiàng)目的產(chǎn)生就是為了省去我們手動(dòng)創(chuàng)建getter和setter方法的麻煩，它能夠在我們編譯源碼的時(shí)候自動(dòng)幫我們生成getter和setter方法。即它最終能夠達(dá)到的效果是：在源碼中沒有g(shù)etter和setter方法，但是在編譯生成的字節(jié)碼文件中有g(shù)etter和setter方法。

比如源碼文件： 

import java.io.Serializable; 
  
import lombok.Data; 
  
@Data 
public class BasicClusterInfo implements Serializable { 
  
  private static final long serialVersionUID = 3478135817352393604L; 
  private String      hbaseKey; 
  private int        receiverCount; 
} 

以下是編譯上述源碼文件得到的字節(jié)碼文件，對(duì)其反編譯得到的結(jié)果  

public class BasicClusterInfo extends java.lang.Object implements java.io.Serializable{ 
  public BasicClusterInfo(); 
  public java.lang.String getHbaseKey(); 
  public int getReceiverCount(); 
  public void setHbaseKey(java.lang.String); 
  public void setReceiverCount(int); 
  public boolean equals(java.lang.Object); 
  public boolean canEqual(java.lang.Object); 
  public int hashCode(); 
  public java.lang.String toString(); 
} 

二、eclipse安裝lombok

為IDE安裝lombok插件非常簡單，以eclipse環(huán)境為例，其安裝過程分為以下幾個(gè)步驟：

1)下載lombok.jar包
            lombok的官網(wǎng)地址：https://projectlombok.org/
            lombok的下載地址：https://projectlombok.org/download.html
            lombok項(xiàng)目的Github地址：https://github.com/rzwitserloot/lombok

2)運(yùn)行l(wèi)ombok.jar
            在windows命令行中輸入以下命令： 

java -jar D:\software\lombok.jar 

其中D:\software\lombok.jar這是windows下lombok.jar所在的位置， 數(shù)秒后將彈出以下對(duì)話框，以指定eclipse的安裝路徑。  

3)確認(rèn)完eclipse的安裝路徑后，點(diǎn)擊install/update按鈕，即可完成安裝。

4)安裝完成之后，請(qǐng)確認(rèn)eclipse安裝路徑下是否多了一個(gè)lombok.jar包，并且其配置文件eclipse.ini中是否 添加了如下內(nèi)容: 

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

那么恭喜你已經(jīng)安裝成功，否則將缺少的部分添加到相應(yīng)的位置即可 。

5)重啟eclipse。  

三、項(xiàng)目中使用lombok

在項(xiàng)目中使用lombok的方法很簡單，分為四個(gè)步驟：
           1)在需要自動(dòng)生成getter和setter方法的類上，加上@Data注解。
           2)在編譯類路徑中加入lombok.jar包，若是maven工程，引入相關(guān)依賴即可。 

<dependencies>
  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.18</version>
  </dependency>
</dependencies>

           3)使用支持lombok的編譯工具編譯源代碼（關(guān)于支持lombok的編譯工具，見“五、支持lombok的編譯工具”）。
           4)編譯得到的字節(jié)碼文件中自動(dòng)生成了getter和setter方法。 

四、原理分析

接下來對(duì)lombok的工作原理進(jìn)行分析，以O(shè)racle的javac編譯工具為例。

自從Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”規(guī)范，只要程序?qū)崿F(xiàn)了該API，就能在javac運(yùn)行的時(shí)候得到調(diào)用。

舉例來說，現(xiàn)在有一個(gè)實(shí)現(xiàn)了"JSR 269 API"的程序A,那么使用javac編譯源碼的時(shí)候具體流程如下：
           1)javac對(duì)源代碼進(jìn)行分析，生成一棵抽象語法樹(AST)。
           2)運(yùn)行過程中調(diào)用實(shí)現(xiàn)了"JSR 269 API"的A程序。
           3)此時(shí)A程序就可以完成它自己的邏輯，包括修改第一步驟得到的抽象語法樹(AST)。
           4)javac使用修改后的抽象語法樹(AST)生成字節(jié)碼文件。 

詳細(xì)的流程圖如下： 

五、支持lombok的編譯工具

1)由“四、原理分析”可知，Oracle javac直接支持lombok。
           2)常用的項(xiàng)目管理工具M(jìn)aven所使用的java編譯工具來源于配置的第三方工具，如果我們配置這個(gè)第三方工具為Oracle javac的話，那么Maven也就直接支持lombok了。
           3)Intellij Idea配置的編譯工具為Oracle javac的話，也就直接支持lombok了。
           4)Eclipse中使用的不是Oracle javac這個(gè)編譯工具，而是自己實(shí)現(xiàn)的Eclipse Compiler for Java (ECJ).要想使ECJ支持lombok，得進(jìn)行設(shè)置，具體是在Eclipse程序目錄中的eclipse.ini文件中添加如下兩行設(shè)置： 

-javaagent:[lombok.jar所在路徑]
-Xbootclasspath/a:[lombok.jar所在路徑]

六、常用lombok注解

lombok 提供的注解不多，可以參考官方視頻的講解和官方文檔。
           Lombok 注解在線幫助文檔：http://projectlombok.org/features/index
           下面是幾個(gè)比較常用的 lombok 注解：
        @Data   ：注解在類上；提供類所有屬性的 getting 和 setting 方法，此外還提供了equals、canEqual、hashCode、toString 方法
        @Setter：注解在屬性上；為屬性提供 setting 方法
        @Getter：注解在屬性上；為屬性提供 getting 方法
        @Log4j ：注解在類上；為類提供一個(gè) 屬性名為log 的 log4j 日志對(duì)象
        @NoArgsConstructor：注解在類上；為類提供一個(gè)無參的構(gòu)造方法
        @AllArgsConstructor：注解在類上；為類提供一個(gè)全參的構(gòu)造方法  

七、其他問題

現(xiàn)在使用Intellij Idea作為Java項(xiàng)目的IDE，配置Oracle javac作為編譯工具。

現(xiàn)在有一個(gè)A類，其中有一些字段，沒有創(chuàng)建它們的setter和getter方法，使用了lombok的@Data注解，另外有一個(gè)B類，它調(diào)用了A類實(shí)例的相應(yīng)字段的setter和getter方法。

編譯A類和B類所在的項(xiàng)目，并不會(huì)報(bào)錯(cuò)，因?yàn)樽罱K生成的A類字節(jié)碼文件中存在相應(yīng)字段的setter和getter方法。但是，IDE發(fā)現(xiàn)B類源代碼中所使用的A類實(shí)例的setter和getter方法在A類源代碼中找不到定義，IDE會(huì)認(rèn)為這是錯(cuò)誤。

要解決以上這個(gè)不是真正錯(cuò)誤的錯(cuò)誤，可以下載安裝Intellij Idea中的"Lombok plugin"。  

八、lombok的罪惡

使用lombok雖然能夠省去手動(dòng)創(chuàng)建setter和getter方法的麻煩，但是卻大大降低了源代碼文件的可讀性和完整性，降低了閱讀源代碼的舒適度。  

參考文獻(xiàn)：

           [1] http://stackoverflow.com/questions/6107197/how-does-lombok-work
           [2] https://projectlombok.org/download.html
           [3] http://stackoverflow.com/questions/3061654/what-is-the-difference-between-javac-and-the-eclipse-compiler
           [4] http://www.ibm.com/developerworks/library/j-lombok/
           [5] http://notatube.blogspot.com/2010/12/project-lombok-creating-custom.html 

到此這篇關(guān)于Java使用lombok消除冗余代碼的方法步驟的文章就介紹到這了,更多相關(guān)Java lombok消除冗余代碼內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論