你幹啥的？Lombok

時間  2019-12-06
標籤 幹啥 lombok 欄目 Java 简体版
原文   原文鏈接

0一、Lombok 的自我介紹

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

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

說實話，我英文不太好（不是找藉口，真的），但藉助金山詞霸，大體知道了這段英文的意思：Lombok 是個好類庫，能夠爲 Java 代碼添加一些「處理程序」，讓其變得更簡潔、更優雅。程序員

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

我相信你必定寫過很多的 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 等等的。ide

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

哎呀，源碼看起來苗條多了，對不對？工具

0二、添加 Lombok 的依賴

若是項目使用 Maven 構建的話，添加Lombok 的依賴就變得垂手可得了。ui

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

其中 scope=provided，就說明 Lombok 只在編譯階段生效。也就是說，Lombok 會在編譯期靜悄悄地將帶 Lombok 註解的源碼文件正確編譯爲完整的 class 文件。this

舒適提示：只在項目中追加 Lombok 的依賴還不夠，還要爲 IDE 添加 Lombok 支持，不然 Javabean 的 getter / setter 就沒法自動編譯，也就不能被調用。spa

0三、爲 Eclipse 添加 Lombok 支持

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

central.maven.org/maven2/org/…

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

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

第四步，重啓 Eclipse，完成項目的從新編譯。

能夠經過 Outline 視圖查看已經編譯好的 getter / setter。是否是感受很奇妙？

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

0四、使用 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 的教程，本身必定要親身實踐一番。

0五、使用其餘反編譯工具查看 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 文件視圖的話，能夠參照下圖哦。

0六、經常使用的 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 註解，待你解鎖哦。

0七、Lombok 的處理流程

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

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

  • javac 編譯過程當中調用實現了JSR 269 的 Lombok 程序

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

  • javac 使用修改後的抽象語法樹生成字節碼文件

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程