你幹啥的？Lombok

01、Lombok 的自我介紹

Lombok 在官網是這樣作自我介紹的：

Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code.

說實話，我英文不太好（不是找藉口，真的），但藉助金山詞霸，大致知道了這段英文的意思：Lombok 是個好類庫，可以為 Java 程式碼新增一些“處理程式”，讓其變得更簡潔、更優雅。

據我已有的經驗來看，Lombok 最大的好處就在於通過註解的形式來簡化 Java 程式碼，簡化到什麼程度呢？

我相信你一定寫過不少的 getter / setter，儘管可以藉助 IDE 來自動生成，可一旦 Javabean 的屬性很多，就免不了要產生大量的 getter / setter，這會讓程式碼看起來不夠簡練，就像老太婆的裹腳布一樣，又臭又長。

class Cmower {
	private int age;
	private String name;
	private BigDecimal money;

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public String getName() {
		return name;
	}

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

	public BigDecimal getMoney() {
		return money;
	}

	public void setMoney(BigDecimal money) {
		this.money = money;
	}
}
複製程式碼

Lombok 可以通過註解的方式，在編譯的時候自動為 Javabean 的屬性生成 getter / setter，不僅如此，還可以生成構造方法、equals、hashCode，以及 toString。注意是在編譯的時候哦，原始碼當中是沒有 getter / setter 等等的。

@Getter
@Setter
class CmowerLombok {
	private int age;
	private String name;
	private BigDecimal money;
}
複製程式碼

哎呀，原始碼看起來苗條多了，對不對？

02、新增 Lombok 的依賴

如果專案使用 Maven 構建的話，新增Lombok 的依賴就變得輕而易舉了。

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.6</version>
	<scope>provided</scope>
</dependency>
複製程式碼

其中 scope=provided，就說明 Lombok 只在編譯階段生效。也就是說，Lombok 會在編譯期靜悄悄地將帶 Lombok 註解的原始碼檔案正確編譯為完整的 class 檔案。

溫馨提示：只在專案中追加 Lombok 的依賴還不夠，還要為 IDE 新增 Lombok 支援，否則 Javabean 的 getter / setter 就無法自動編譯，也就不能被呼叫。

03、為 Eclipse 新增 Lombok 支援

第一步，下載 Lombok 的 jar 包。下載地址如下：

central.maven.org/maven2/org/…

第二步，雙擊執行該 jar 包。

第三步，點選「Install / Update」進行安裝。

第四步，重啟 Eclipse，完成專案的重新編譯。

可以通過 Outline 檢視檢視已經編譯好的 getter / setter。是不是感覺很奇妙？

這時候，我們就可以使用 Lombok 註解過的 Javabean 了。

04、使用 Jad 檢視 Lombok 位元組碼

曾經有一段時間，每個人選擇的反編譯工具都是 Jad。雖然 Jad 已經死了，不再更新了，但仍然有許多人需要它。比如說我就是其中一個。甚至在我的心目中，Jad 是最佳的 Java 反編譯工具，排名在 JD-GUI 之前。

Jad 的下載地址如下，包含各種平臺的版本： www.javadecompilers.com/jad

下載完成後解壓，並不需要任何的安裝步驟。怎麼使用 Jad 呢？

jad CmowerLombok.class
// Parsing CmowerLombok.class... Generating CmowerLombok.jad
複製程式碼

執行完以上命令後，會生成一個新的檔案，字尾為 .jad，使用文字編輯器開啟後，內容如下：

// Decompiled by Jad v1.5.8g. Copyright 2001 Pavel Kouznetsov.
// Jad home page: http://www.kpdus.com/jad.html
// Decompiler options: packimports(3) 
// Source File Name:   CmowerLombok.java

package com.cmower.java_demo.lombok;

import java.math.BigDecimal;

class CmowerLombok
{

    CmowerLombok()
    {
    }

    public int getAge()
    {
        return age;
    }

    public String getName()
    {
        return name;
    }

    public BigDecimal getMoney()
    {
        return money;
    }

    public void setAge(int age)
    {
        this.age = age;
    }

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

    public void setMoney(BigDecimal money)
    {
        this.money = money;
    }

    private int age;
    private String name;
    private BigDecimal money;
}
複製程式碼

嘿嘿，果然 getter / setter 就在裡面，這真是一件令人開心的事情，開心得我一巴掌拍在桌子上，差一點沒把手拍骨折，也不知道桌子疼不疼。

很早就有朋友勸我使用 Lombok，但我總覺得增加一個能夠產生任何現代 IDE 都能輕易產生的程式碼的類庫沒有多大的價值（句子有點長，注意斷句）。現在我再也不會這麼覺得了，Lombok 為我節省了大量的生成樣板程式碼的時間。

PS：需要註明一點的是，我首次檢視 class 檔案的時候遇到了巨坑，getter / setter 竟然不在其中，但是可以呼叫。試了很多的反編譯工具都不行。

於是我不得不在很多個群裡面發起了諮詢，很多大神都請教了，最後的結論是 Eclipse 的 Lombok 外掛可能出了 bug。為此，我還下載了程式設計師開發利器——IntelliJ IDEA，但我用起來蹩手蹩腳，最後還是放棄了。

折騰了大概 3 個多小時候後，沒辦法，我只得重啟了 Eclipse（解決編譯問題的終極殺招），class 檔案中莫名其妙地又出現了 getter / setter（還記得我拍桌子的興奮勁嗎？）。由此我得出的結論是，不管別人有沒有寫 Lombok 的教程，自己一定要親身實踐一番。

05、使用其他反編譯工具檢視 Lombok 位元組碼

既然說到反編譯工具，我覺得有必要介紹另外一款優秀的反編譯工具——Enhanced Class Decompiler。

它將 JD、Jad、FernFlow、CFR、Procyon 與 Eclipse 無縫整合，並且允許 Java 開發人員直接除錯類檔案而不需要原始碼。這還不算完啊，它還整合了 Eclipse 類編輯器 M2E 外掛，支援 Javadoc、參考搜尋、庫源附加、位元組碼檢視和 JDK 8 lambda 表示式的語法。

總之，Enhanced Class Decompiler 要取代 Jad 在我心目中的位置了。

第一步，在 Eclipse Marketplace 搜尋 jad。

第二步，直接點選「Installed」按鈕進行安裝。安裝完成後重啟 Eclipse。

第三步，右鍵 target，選擇「Show In Remote Systems View」。

第四步，右鍵需要檢視的 class 檔案，依次選擇「Open With」→「Class Decompiler Viewer」。

看到反編譯後的程式碼如下所示。

package com.cmower.java_demo.lombok;

import java.math.BigDecimal;

class CmowerLombok {
	private int age;
	private String name;
	private BigDecimal money;

	public int getAge() {
		return this.age;
	}

	public String getName() {
		return this.name;
	}

	public BigDecimal getMoney() {
		return this.money;
	}

	public void setAge(int age) {
		this.age = age;
	}

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

	public void setMoney(BigDecimal money) {
		this.money = money;
	}
}
複製程式碼

PS：如果你想把 Enhanced Class Decompiler 設定為預設的 class 檔案檢視的話，可以參照下圖哦。

06、常用的 Lombok 註解

1）@Getter / @Setter

@Getter / @Setter 用起來很靈活，比如說像下面這樣：

class CmowerLombok {
	@Getter @Setter private int age;
	@Getter private String name;
	@Setter private BigDecimal money;
}
複製程式碼

位元組碼檔案反編譯後的內容是：

class CmowerLombok {
	private int age;
	private String name;
	private BigDecimal money;

	public int getAge() {
		return this.age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public String getName() {
		return this.name;
	}

	public void setMoney(BigDecimal money) {
		this.money = money;
	}
}
複製程式碼

2）@ToString

列印日誌的好幫手哦。

@ToString
class CmowerLombok {
	private int age;
	private String name;
	private BigDecimal money;
}
複製程式碼

位元組碼檔案反編譯後的內容是：

class CmowerLombok {
	private int age;
	private String name;
	private BigDecimal money;

	public String toString() {
		return "CmowerLombok(age=" + this.age + ", name=" + this.name + ", money=" + this.money + ")";
	}
}
複製程式碼

3）val

在編寫 JavaScript 程式碼時，我一直覺得 var 這個變數宣告型別用起來特別方便。Lombok 也提供了一個類似的。

class CmowerLombok {
	public void test() {
		val names = new ArrayList<String>();
		names.add("沉默王二");
		val name = names.get(0);
		System.out.println(name);
	}
}
複製程式碼

位元組碼檔案反編譯後的內容是：

class CmowerLombok {
	public void test() {
		ArrayList<String> names = new ArrayList();
		names.add("沉默王二");
		String name = (String) names.get(0);
		System.out.println(name);
	}
}
複製程式碼

4）@Data

@Data 註解可以生成 getter / setter、equals、hashCode，以及 toString，是個總和的選項。

@Data
class CmowerLombok {
	private int age;
	private String name;
	private BigDecimal money;
}
複製程式碼

位元組碼檔案反編譯後的內容是：

class CmowerLombok {
	private int age;
	private String name;
	private BigDecimal money;

	public int getAge() {
		return this.age;
	}

	public String getName() {
		return this.name;
	}

	public BigDecimal getMoney() {
		return this.money;
	}

	public void setAge(int age) {
		this.age = age;
	}

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

	public void setMoney(BigDecimal money) {
		this.money = money;
	}

	public boolean equals(Object o) {
		if (o == this) {
			return true;
		} else if (!(o instanceof CmowerLombok)) {
			return false;
		} else {
			CmowerLombok other = (CmowerLombok) o;
			if (!other.canEqual(this)) {
				return false;
			} else if (this.getAge() != other.getAge()) {
				return false;
			} else {
				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;
				}

				Object this$money = this.getMoney();
				Object other$money = other.getMoney();
				if (this$money == null) {
					if (other$money != null) {
						return false;
					}
				} else if (!this$money.equals(other$money)) {
					return false;
				}

				return true;
			}
		}
	}

	protected boolean canEqual(Object other) {
		return other instanceof CmowerLombok;
	}

	public int hashCode() {
		int PRIME = true;
		int result = 1;
		int result = result * 59 + this.getAge();
		Object $name = this.getName();
		result = result * 59 + ($name == null ? 43 : $name.hashCode());
		Object $money = this.getMoney();
		result = result * 59 + ($money == null ? 43 : $money.hashCode());
		return result;
	}

	public String toString() {
		return "CmowerLombok(age=" + this.getAge() + ", name=" + this.getName() + ", money=" + this.getMoney() + ")";
	}
}
複製程式碼

5）更多的 Lombok 註解，待你解鎖哦。

07、Lombok 的處理流程

一圖勝千言，我就先上圖了。

• javac 對原始碼進行分析，生成一棵抽象語法樹（AST）

• javac 編譯過程中呼叫實現了JSR 269 的 Lombok 程式

• Lombok 對 AST 進行處理，找到 Lombok 註解所在類對應的語法樹（AST），然後修改該語法樹，增加 Lombok 註解定義的相應樹節點（所謂程式碼）

• javac 使用修改後的抽象語法樹生成位元組碼檔案