1 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通過(guò)增加一些“處理程序”，可以讓java變得簡(jiǎn)潔、快速。

2 Lombok使用方法

Lombok能以簡(jiǎn)單的注解形式來(lái)簡(jiǎn)化java代碼，提高開(kāi)發(fā)人員的開(kāi)發(fā)效率。例如開(kāi)發(fā)中經(jīng)常需要寫的javabean，都需要花時(shí)間去添加相應(yīng)的getter/setter，也許還要去寫構(gòu)造器、equals等方法，而且需要維護(hù)，當(dāng)屬性多時(shí)會(huì)出現(xiàn)大量的getter/setter方法，這些顯得很冗長(zhǎng)也沒(méi)有太多技術(shù)含量，一旦修改屬性，就容易出現(xiàn)忘記修改對(duì)應(yīng)方法的失誤。

Lombok能通過(guò)注解的方式，在編譯時(shí)自動(dòng)為屬性生成構(gòu)造器、getter/setter、equals、hashcode、toString方法。出現(xiàn)的神奇就是在源碼中沒(méi)有g(shù)etter和setter方法，但是在編譯生成的字節(jié)碼文件中有g(shù)etter和setter方法。這樣就省去了手動(dòng)重建這些代碼的麻煩，使代碼看起來(lái)更簡(jiǎn)潔些。

Lombok的使用跟引用jar包一樣，可以在官網(wǎng)（https://projectlombok.org/download）下載jar包，也可以使用maven添加依賴：

<dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <version>1.16.20</version>
 <scope>provided</scope>
</dependency>

接下來(lái)我們來(lái)分析Lombok中注解的具體用法。

2.1 @Data

@Data注解在類上，會(huì)為類的所有屬性自動(dòng)生成setter/getter、equals、canEqual、hashCode、toString方法，如為final屬性，則不會(huì)為該屬性生成setter方法。

官方實(shí)例如下：

 import lombok.AccessLevel;
import lombok.Setter;
import lombok.Data;
import lombok.ToString;

@Data public class DataExample {
 private final String name;
 @Setter(AccessLevel.PACKAGE) private int age;
 private double score;
 private String[] tags;
 
 @ToString(includeFieldNames=true)
 @Data(staticConstructor="of")
 public static class Exercise<T> {
 private final String name;
 private final T value;
 }
}

如不使用Lombok，則實(shí)現(xiàn)如下：

 import java.util.Arrays;

public class DataExample {
 private final String name;
 private int age;
 private double score;
 private String[] tags;
 
 public DataExample(String name) {
 this.name = name;
 }
 
 public String getName() {
 return this.name;
 }
 
 void setAge(int age) {
 this.age = age;
 }
 
 public int getAge() {
 return this.age;
 }
 
 public void setScore(double score) {
 this.score = score;
 }
 
 public double getScore() {
 return this.score;
 }
 
 public String[] getTags() {
 return this.tags;
 }
 
 public void setTags(String[] tags) {
 this.tags = tags;
 }
 
 @Override public String toString() {
 return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + ")";
 }
 
 protected boolean canEqual(Object other) {
 return other instanceof DataExample;
 }
 
 @Override public boolean equals(Object o) {
 if (o == this) return true;
 if (!(o instanceof DataExample)) return false;
 DataExample other = (DataExample) o;
 if (!other.canEqual((Object)this)) return false;
 if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
 if (this.getAge() != other.getAge()) return false;
 if (Double.compare(this.getScore(), other.getScore()) != 0) return false;
 if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;
 return true;
 }
 
 @Override public int hashCode() {
 final int PRIME = 59;
 int result = 1;
 final long temp1 = Double.doubleToLongBits(this.getScore());
 result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
 result = (result*PRIME) + this.getAge();
 result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
 result = (result*PRIME) + Arrays.deepHashCode(this.getTags());
 return result;
 }
 
 public static class Exercise<T> {
 private final String name;
 private final T value;
 
 private Exercise(String name, T value) {
 this.name = name;
 this.value = value;
 }
 
 public static <T> Exercise<T> of(String name, T value) {
 return new Exercise<T>(name, value);
 }
 
 public String getName() {
 return this.name;
 }
 
 public T getValue() {
 return this.value;
 }
 
 @Override public String toString() {
 return "Exercise(name=" + this.getName() + ", value=" + this.getValue() + ")";
 }
 
 protected boolean canEqual(Object other) {
 return other instanceof Exercise;
 }
 
 @Override public boolean equals(Object o) {
 if (o == this) return true;
 if (!(o instanceof Exercise)) return false;
 Exercise<?> other = (Exercise<?>) o;
 if (!other.canEqual((Object)this)) return false;
 if (this.getName() == null ? other.getValue() != null : !this.getName().equals(other.getName())) return false;
 if (this.getValue() == null ? other.getValue() != null : !this.getValue().equals(other.getValue())) return false;
 return true;
 }
 
 @Override public int hashCode() {
 final int PRIME = 59;
 int result = 1;
 result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
 result = (result*PRIME) + (this.getValue() == null ? 43 : this.getValue().hashCode());
 return result;
 }
 }
}

2.2 @Getter/@Setter

如果覺(jué)得@Data太過(guò)殘暴（因?yàn)锧Data集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性）不夠精細(xì)，可以使用@Getter/@Setter注解，此注解在屬性上，可以為相應(yīng)的屬性自動(dòng)生成Getter/Setter方法，示例如下：

 import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

public class GetterSetterExample {

 @Getter @Setter private int age = 10;
 
 @Setter(AccessLevel.PROTECTED) private String name;
 
 @Override public String toString() {
 return String.format("%s (age: %d)", name, age);
 }
}

如果不使用Lombok：

 public class GetterSetterExample {

 private int age = 10;

 private String name;
 
 @Override public String toString() {
 return String.format("%s (age: %d)", name, age);
 }
 
 public int getAge() {
 return age;
 }
 
 public void setAge(int age) {
 this.age = age;
 }
 
 protected void setName(String name) {
 this.name = name;
 }
}

2.3 @NonNull

該注解用在屬性或構(gòu)造器上，Lombok會(huì)生成一個(gè)非空的聲明，可用于校驗(yàn)參數(shù)，能幫助避免空指針。

示例如下：

import lombok.NonNull;

public class NonNullExample extends Something {
 private String name;
 
 public NonNullExample(@NonNull Person person) {
 super("Hello");
 this.name = person.getName();
 }
}

不使用Lombok：

import lombok.NonNull;

public class NonNullExample extends Something {
 private String name;
 
 public NonNullExample(@NonNull Person person) {
 super("Hello");
 if (person == null) {
 throw new NullPointerException("person");
 }
 this.name = person.getName();
 }
}

2.4 @Cleanup

該注解能幫助我們自動(dòng)調(diào)用close()方法，很大的簡(jiǎn)化了代碼。

示例如下：

import lombok.Cleanup;
import java.io.*;

public class CleanupExample {
 public static void main(String[] args) throws IOException {
 @Cleanup InputStream in = new FileInputStream(args[0]);
 @Cleanup OutputStream out = new FileOutputStream(args[1]);
 byte[] b = new byte[10000];
 while (true) {
 int r = in.read(b);
 if (r == -1) break;
 out.write(b, 0, r);
 }
 }
}

如不使用Lombok，則需如下：

import java.io.*;

public class CleanupExample {
 public static void main(String[] args) throws IOException {
 InputStream in = new FileInputStream(args[0]);
 try {
 OutputStream out = new FileOutputStream(args[1]);
 try {
 byte[] b = new byte[10000];
 while (true) {
 int r = in.read(b);
 if (r == -1) break;
 out.write(b, 0, r);
 }
 } finally {
 if (out != null) {
 out.close();
 }
 }
 } finally {
 if (in != null) {
 in.close();
 }
 }
 }
}

2.5 @EqualsAndHashCode

默認(rèn)情況下，會(huì)使用所有非靜態(tài)（non-static）和非瞬態(tài)（non-transient）屬性來(lái)生成equals和hasCode，也能通過(guò)exclude注解來(lái)排除一些屬性。

示例如下：

import lombok.EqualsAndHashCode;

@EqualsAndHashCode(exclude={"id", "shape"})
public class EqualsAndHashCodeExample {
 private transient int transientVar = 10;
 private String name;
 private double score;
 private Shape shape = new Square(5, 10);
 private String[] tags;
 private int id;
 
 public String getName() {
 return this.name;
 }
 
 @EqualsAndHashCode(callSuper=true)
 public static class Square extends Shape {
 private final int width, height;
 
 public Square(int width, int height) {
 this.width = width;
 this.height = height;
 }
 }
}

2.6 @ToString

類使用@ToString注解，Lombok會(huì)生成一個(gè)toString()方法，默認(rèn)情況下，會(huì)輸出類名、所有屬性（會(huì)按照屬性定義順序），用逗號(hào)來(lái)分割。

通過(guò)將includeFieldNames參數(shù)設(shè)為true，就能明確的輸出toString()屬性。這一點(diǎn)是不是有點(diǎn)繞口，通過(guò)代碼來(lái)看會(huì)更清晰些。

使用Lombok的示例：

import lombok.ToString;

@ToString(exclude="id")
public class ToStringExample {
 private static final int STATIC_VAR = 10;
 private String name;
 private Shape shape = new Square(5, 10);
 private String[] tags;
 private int id;
 
 public String getName() {
 return this.getName();
 }
 
 @ToString(callSuper=true, includeFieldNames=true)
 public static class Square extends Shape {
 private final int width, height;
 
 public Square(int width, int height) {
 this.width = width;
 this.height = height;
 }
 }
}

不使用Lombok的示例如下：

import java.util.Arrays;

public class ToStringExample {
 private static final int STATIC_VAR = 10;
 private String name;
 private Shape shape = new Square(5, 10);
 private String[] tags;
 private int id;
 
 public String getName() {
 return this.getName();
 }
 
 public static class Square extends Shape {
 private final int width, height;
 
 public Square(int width, int height) {
 this.width = width;
 this.height = height;
 }
 
 @Override public String toString() {
 return "Square(super=" + super.toString() + ", width=" + this.width + ", height=" + this.height + ")";
 }
 }
 
 @Override public String toString() {
 return "ToStringExample(" + this.getName() + ", " + this.shape + ", " + Arrays.deepToString(this.tags) + ")";
 }
}

2.7 @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

無(wú)參構(gòu)造器、部分參數(shù)構(gòu)造器、全參構(gòu)造器。Lombok沒(méi)法實(shí)現(xiàn)多種參數(shù)構(gòu)造器的重載。

Lombok示例代碼如下：

import lombok.AccessLevel; import lombok.RequiredArgsConstructor; import lombok.AllArgsConstructor; import lombok.NonNull; @RequiredArgsConstructor(staticName = "of") @AllArgsConstructor(access = AccessLevel.PROTECTED) public class ConstructorExample<T> { private int x, y; @NonNull private T description; @NoArgsConstructor public static class NoArgsExample { @NonNull private String field; } }

不使用Lombok的示例如下：

public class ConstructorExample<T> { private int x, y; @NonNull private T description; private ConstructorExample(T description) { if (description == null) throw new NullPointerException("description"); this.description = description; } public static <T> ConstructorExample<T> of(T description) { return new ConstructorExample<T>(description); } @java.beans.ConstructorProperties({"x", "y", "description"}) protected ConstructorExample(int x, int y, T description) { if (description == null) throw new NullPointerException("description"); this.x = x; this.y = y; this.description = description; } public static class NoArgsExample { @NonNull private String field; public NoArgsExample() { } } }

3 Lombok工作原理分析

會(huì)發(fā)現(xiàn)在Lombok使用的過(guò)程中，只需要添加相應(yīng)的注解，無(wú)需再為此寫任何代碼。自動(dòng)生成的代碼到底是如何產(chǎn)生的呢？

核心之處就是對(duì)于注解的解析上。JDK5引入了注解的同時(shí)，也提供了兩種解析方式。

運(yùn)行時(shí)解析

運(yùn)行時(shí)能夠解析的注解，必須將@Retention設(shè)置為RUNTIME，這樣就可以通過(guò)反射拿到該注解。java.lang,reflect反射包中提供了一個(gè)接口AnnotatedElement，該接口定義了獲取注解信息的幾個(gè)方法，Class、Constructor、Field、Method、Package等都實(shí)現(xiàn)了該接口，對(duì)反射熟悉的朋友應(yīng)該都會(huì)很熟悉這種解析方式。

編譯時(shí)解析

編譯時(shí)解析有兩種機(jī)制，分別簡(jiǎn)單描述下：

1）Annotation Processing Tool

apt自JDK5產(chǎn)生，JDK7已標(biāo)記為過(guò)期，不推薦使用，JDK8中已徹底刪除，自JDK6開(kāi)始，可以使用Pluggable Annotation Processing API來(lái)替換它，apt被替換主要有2點(diǎn)原因：

api都在com.sun.mirror非標(biāo)準(zhǔn)包下
沒(méi)有集成到j(luò)avac中，需要額外運(yùn)行

2）Pluggable Annotation Processing API

JSR 269自JDK6加入，作為apt的替代方案，它解決了apt的兩個(gè)問(wèn)題，javac在執(zhí)行的時(shí)候會(huì)調(diào)用實(shí)現(xiàn)了該API的程序，這樣我們就可以對(duì)編譯器做一些增強(qiáng)，這時(shí)javac執(zhí)行的過(guò)程如下：

Lombok本質(zhì)上就是一個(gè)實(shí)現(xiàn)了“JSR 269 API”的程序。在使用javac的過(guò)程中，它產(chǎn)生作用的具體流程如下：

javac對(duì)源代碼進(jìn)行分析，生成了一棵抽象語(yǔ)法樹(shù)（AST）
運(yùn)行過(guò)程中調(diào)用實(shí)現(xiàn)了“JSR 269 API”的Lombok程序
此時(shí)Lombok就對(duì)第一步驟得到的AST進(jìn)行處理，找到@Data注解所在類對(duì)應(yīng)的語(yǔ)法樹(shù)（AST），然后修改該語(yǔ)法樹(shù)（AST），增加getter和setter方法定義的相應(yīng)樹(shù)節(jié)點(diǎn)
javac使用修改后的抽象語(yǔ)法樹(shù)（AST）生成字節(jié)碼文件，即給class增加新的節(jié)點(diǎn)（代碼塊）

拜讀了Lombok源碼，對(duì)應(yīng)注解的實(shí)現(xiàn)都在HandleXXX中，比如@Getter注解的實(shí)現(xiàn)時(shí)HandleGetter.handle()。還有一些其它類庫(kù)使用這種方式實(shí)現(xiàn)，比如google Auto、Dagger等等。

4. Lombok的優(yōu)缺點(diǎn)

優(yōu)點(diǎn)：

能通過(guò)注解的形式自動(dòng)生成構(gòu)造器、getter/setter、equals、hashcode、toString等方法，提高了一定的開(kāi)發(fā)效率
讓代碼變得簡(jiǎn)潔，不用過(guò)多的去關(guān)注相應(yīng)的方法
屬性做修改時(shí)，也簡(jiǎn)化了維護(hù)為這些屬性所生成的getter/setter方法等

缺點(diǎn)：

不支持多種參數(shù)構(gòu)造器的重載
雖然省去了手動(dòng)創(chuàng)建getter/setter方法的麻煩，但大大降低了源代碼的可讀性和完整性，降低了閱讀源代碼的舒適度

5. 總結(jié)

Lombok雖然有很多優(yōu)點(diǎn)，但Lombok更類似于一種IDE插件，項(xiàng)目也需要依賴相應(yīng)的jar包。Lombok依賴jar包是因?yàn)榫幾g時(shí)要用它的注解，為什么說(shuō)它又類似插件？因?yàn)樵谑褂脮r(shí)，eclipse或IntelliJ IDEA都需要安裝相應(yīng)的插件，在編譯器編譯時(shí)通過(guò)操作AST（抽象語(yǔ)法樹(shù)）改變字節(jié)碼生成，變向的就是說(shuō)它在改變java語(yǔ)法。它不像spring的依賴注入或者mybatis的ORM一樣是運(yùn)行時(shí)的特性，而是編譯時(shí)的特性。這里我個(gè)人最感覺(jué)不爽的地方就是對(duì)插件的依賴！因?yàn)長(zhǎng)ombok只是省去了一些人工生成代碼的麻煩，但I(xiàn)DE都有快捷鍵來(lái)協(xié)助生成getter/setter等方法，也非常方便。

知乎上有位大神發(fā)表過(guò)對(duì)Lombok的一些看法：

這是一種低級(jí)趣味的插件，不建議使用。JAVA發(fā)展到今天，各種插件層出不窮，如何甄別各種插件的優(yōu)劣？能從架構(gòu)上優(yōu)化你的設(shè)計(jì)的，能提高應(yīng)用程序性能的 ，
實(shí)現(xiàn)高度封裝可擴(kuò)展的...， 像lombok這種，像這種插件，已經(jīng)不僅僅是插件了，改變了你如何編寫源碼，事實(shí)上，少去了代碼你寫上去又如何？ 
如果JAVA家族到處充斥這樣的東西，那只不過(guò)是一坨披著金屬顏色的屎，遲早會(huì)被其它的語(yǔ)言取代。

雖然話糙但理確實(shí)不糙，試想一個(gè)項(xiàng)目有非常多類似Lombok這樣的插件，個(gè)人覺(jué)得真的會(huì)極大的降低閱讀源代碼的舒適度。

雖然非常不建議在屬性的getter/setter寫一些業(yè)務(wù)代碼，但在多年項(xiàng)目的實(shí)戰(zhàn)中，有時(shí)通過(guò)給getter/setter加一點(diǎn)點(diǎn)業(yè)務(wù)代碼，能極大的簡(jiǎn)化某些業(yè)務(wù)場(chǎng)景的代碼。所謂取舍，也許就是這時(shí)的舍棄一定的規(guī)范，取得極大的方便。

我現(xiàn)在非常堅(jiān)信一條理念，任何編程語(yǔ)言或插件，都僅僅只是工具而已，即使工具再?gòu)?qiáng)大也在于用的人，就如同小米加步槍照樣能贏飛機(jī)大炮的道理一樣。結(jié)合具體業(yè)務(wù)場(chǎng)景和項(xiàng)目實(shí)際情況，無(wú)需一味追求高大上的技術(shù)，適合的才是王道。

Lombok有它的得天獨(dú)厚的優(yōu)點(diǎn)，也有它避之不及的缺點(diǎn)，熟知其優(yōu)缺點(diǎn)，在實(shí)戰(zhàn)中靈活運(yùn)用才是王道。