還在編寫無聊枯燥又難以維護(hù)的POJO嗎芹啥？潔癖者的春天在哪里？請看Lombok！
在過往的Java項(xiàng)目中忍抽，充斥著太多不友好的代碼：POJO的getter/setter/toString捶索；異常處理插掂；I/O流的關(guān)閉操作等等，這些樣板代碼既沒有技術(shù)含量腥例，又影響著代碼的美觀辅甥，Lombok應(yīng)運(yùn)而生。
首先說明一下：任何技術(shù)的出現(xiàn)都是為了解決某一類問題的燎竖，如果在此基礎(chǔ)上再建立奇技淫巧璃弄，不如回歸Java本身。應(yīng)該保持合理使用而不濫用构回。
Lombok的使用非常簡單夏块，下面我們一起來看下：
1）引入相應(yīng)的maven包：
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.18</version>
<scope>provided</scope>
</dependency>
Lombok的scope=provided，說明它只在編譯階段生效纤掸，不需要打入包中脐供。事實(shí)正是如此，Lombok在編譯期將帶Lombok注解的Java文件正確編譯為完整的Class文件借跪。
2）添加IDE工具對Lombok的支持：
IDEA中引入Lombok支持如下：
點(diǎn)擊File-- Settings設(shè)置界面政己，安裝Lombok插件：
Eclipse的Lombok插件安裝可以自行百度歇由，也比較簡單，值得一提的是果港，由于Eclipse內(nèi)置的編譯器不是Oracle javac沦泌，而是eclipse自己實(shí)現(xiàn)的Eclipse Compiler for Java (ECJ).要讓ECJ支持Lombok，需要在eclipse.ini配置文件中添加如下兩項(xiàng)內(nèi)容：
-Xbootclasspath/a:[lombok.jar所在路徑]
-javaagent:[lombok.jar所在路徑]
3）Lombok實(shí)現(xiàn)原理：
自從Java 6起辛掠，javac就支持“JSR 269 Pluggable Annotation Processing API”規(guī)范谢谦，只要程序?qū)崿F(xiàn)了該API，就能在javac運(yùn)行的時(shí)候得到調(diào)用。
Lombok就是一個(gè)實(shí)現(xiàn)了"JSR 269 API"的程序他宛。在使用javac的過程中船侧，它產(chǎn)生作用的具體流程如下：
- javac對源代碼進(jìn)行分析，生成一棵抽象語法樹(AST)
- javac編譯過程中調(diào)用實(shí)現(xiàn)了JSR 269的Lombok程序
- 此時(shí)Lombok就對第一步驟得到的AST進(jìn)行處理厅各，找到Lombok注解所在類對應(yīng)的語法樹(AST)镜撩，然后修改該語法樹(AST)，增加Lombok注解定義的相應(yīng)樹節(jié)點(diǎn)
- javac使用修改后的抽象語法樹(AST)生成字節(jié)碼文件
4) Lombok注解的使用：
POJO類常用注解：
@Getter/@Setter: 作用類上队塘，生成所有成員變量的getter/setter方法袁梗；作用于成員變量上，生成該成員變量的getter/setter方法憔古≌诹可以設(shè)定訪問權(quán)限及是否懶加載等。
package com.trace;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
/**
* Created by Trace on 2018/5/19.<br/>
* DESC: 測試類
*/
@SuppressWarnings("unused")
public class TestClass {
public static void main(String[] args) {
}
@Getter(value = AccessLevel.PUBLIC)
@Setter(value = AccessLevel.PUBLIC)
public static class Person {
private String name;
private int age;
private boolean friendly;
}
public static class Animal {
private String name;
private int age;
@Getter @Setter private boolean funny;
}
}
編譯后的代碼如下：[這也是傳統(tǒng)Java編程需要編寫的樣板代碼]
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.trace;
public class TestClass {
public TestClass() {
}
public static void main(String[] args) {
}
public static class Animal {
private String name;
private int age;
private boolean funny;
public Animal() {
}
public boolean isFunny() {
return this.funny;
}
public void setFunny(boolean funny) {
this.funny = funny;
}
}
public static class Person {
private String name;
private int age;
private boolean friendly;
public Person() {
}
public String getName() {
return this.name;
}
public int getAge() {
return this.age;
}
public boolean isFriendly() {
return this.friendly;
}
public void setName(String name) {
this.name = name;
}
public void setAge(int age) {
this.age = age;
}
public void setFriendly(boolean friendly) {
this.friendly = friendly;
}
}
}
@EqualsAndHashCode：作用于類须肆，覆蓋默認(rèn)的equals和hashCode
@NonNull：主要作用于成員變量和參數(shù)中内舟，標(biāo)識不能為空合敦，否則拋出空指針異常。
@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：作用于類上验游，用于生成構(gòu)造函數(shù)充岛。有staticName、access等屬性耕蝉。
staticName屬性一旦設(shè)定崔梗，將采用靜態(tài)方法的方式生成實(shí)例，access屬性可以限定訪問權(quán)限赔硫。
@NoArgsConstructor：生成無參構(gòu)造器炒俱；
@RequiredArgsConstructor：生成包含final和@NonNull注解的成員變量的構(gòu)造器；
@AllArgsConstructor：生成全參構(gòu)造器爪膊。
編譯后結(jié)果：
public static class Person {
@NonNull
private String name;
private int age;
private boolean friendly;
public String toString() {
return "TestClass.Person(name=" + this.getName() + ", age=" + this.getAge() + ")";
}
@NonNull
public String getName() {
return this.name;
}
public int getAge() {
return this.age;
}
public boolean isFriendly() {
return this.friendly;
}
public void setName(@NonNull String name) {
if(name == null) {
throw new NullPointerException("name");
} else {
this.name = name;
}
}
public void setAge(int age) {
this.age = age;
}
public void setFriendly(boolean friendly) {
this.friendly = friendly;
}
private Person() {
}
private static TestClass.Person of() {
return new TestClass.Person();
}
@ConstructorProperties({"name"})
Person(@NonNull String name) {
if(name == null) {
throw new NullPointerException("name");
} else {
this.name = name;
}
}
@ConstructorProperties({"name", "age", "friendly"})
public Person(@NonNull String name, int age, boolean friendly) {
if(name == null) {
throw new NullPointerException("name");
} else {
this.name = name;
this.age = age;
this.friendly = friendly;
}
}
}
@Data：作用于類上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
@Builder：作用于類上砸王，將類轉(zhuǎn)變?yōu)榻ㄔ煺吣Ｊ?/p>
@Log：作用于類上推盛，生成日志變量。針對不同的日志實(shí)現(xiàn)產(chǎn)品谦铃，有不同的注解：
其他重要注解：
@Cleanup：自動(dòng)關(guān)閉資源耘成，針對實(shí)現(xiàn)了java.io.Closeable接口的對象有效，如：典型的IO流對象
@Synchronized：作用于方法級別撒会，可以替換synchronize關(guān)鍵字或lock鎖，用處不大师妙。
