在JAVA開發中，因工作需要，你可能會學習或被迫去學習Lombok這個工具，這玩意用起來可以說是賊爽，很方便，可玄武老師實際上并不推薦大家使用，至于Lombok是什么？怎么入門？為什么不推薦使用？下面，玄武老師會慢慢跟你講解。
一、Lombok是什么？
1、官方網站地址：https://projectlombok.org/
2、官網對Lombok的描述如下：
Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.
簡單理解后說下意思：
Lombok項目其實就是一個java庫，它可以自動插入到編輯器和構建工具中，增強java的性能。以后你只需要一些簡單的注解，就可以再也不用在類中反復去寫get、equals等方法。
3、優點說明：
Lombok能以簡單的注解形式來簡化java代碼，提高開發人員的開發效率。例如開發中經常需要寫的javabean，都需要花時間去添加相應的getter/setter，也許還要去寫構造器、equals等方法，而且需要維護，當屬性多時會出現大量的getter/setter方法，這些顯得很冗長也沒有太多技術含量，一旦修改屬性，就容易出現忘記修改對應方法的失誤。
Lombok能通過注解的方式，在編譯時自動為屬性生成構造函數、getter/setter、equals、hashcode、toString等方法。奇妙之處在于源碼中沒有getter和setter方法，但是在編譯生成的字節碼文件中有getter和setter方法。這樣就省去了手動重建這些代碼的麻煩，使代碼看起來更簡潔明了。
二、Lombok安裝與使用
1、安裝Lombok插件
Lombok插件支持Eclipse、IntelliJ IDEA、MyEclispe等IDE，在這里我們使用IntelliJ IDEA來演示安裝：
1）打開File > Settings > Plugins >Marketplace，搜索Lombok，如圖，點擊install，彈窗Accept，然后安裝好后Restart IDEA。
2）設置Enable annotation processing
打開File > Settings > Build, Execution, Deployment > Compiler > Annotation Processors，勾選Enable annotation processing，然后Apply和OK。
2、新建Java項目，引入jar包
1、常用jar包引入方法有兩種，如下：
方法1：普通項目可以直接官網下載jar包，和使用普通jar包一樣，導入項目即可。jar下載地址：https://projectlombok.org/download
方法2：Maven項目可以在pom.xml中配置依賴坐標即可，依賴坐標如下：
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
</dependencies>
注意：
1、<scope>provided</scope>表示該包只在編譯和測試的時候用，項目真正打成包時不會將Lombok包打進去。
2、Lombok還支持其他構建方法，比如Ant、Gradle、Kobalt，有需要的可以參考官網的Install菜單下的Build Tools，其他使用方法也可以參考Install菜單
2、使用說明可以參考官方資料，也可以看我這里的常用注解代碼演示（重點關注：@NonNull，@Getter, @Setter，@AllArgsConstructor,@NoArgsConstructor, @ToString和@Data）
1）@NonNull該注解用在屬性或構造器上，Lombok會生成一個非空的聲明，可用于校驗參數，能幫助避免空指針。
示例代碼：
//成員方法參數加上@NonNull注解，構造方法也一樣，在此不做演示
public String getName(@NonNull Person p){
return p.getName();
}
實際效果相當于：
public String getName(Person p){
if(p==null){
throw new NullPointerException("person");
}
return p.getName();
}
2）@Getter和@Setter：在JavaBean或類JavaBean中使用，使用此注解相當于為成員變量生成對應的get和set方法，方法默認修飾符為public，同時還可以使用AccessLevel為生成的方法指定訪問修飾符。這兩個注解還可以直接用在類上，可以為此類里的所有非靜態成員變量生成對應的get和set方法。
示例代碼：
public class Student{
@Getter
@Setter
private String name;
@Setter(AccessLevel.PROTECTED)
private int age;
@Getter(AccessLevel.PUBLIC)
private String language;
}
實際效果相當于：
public class Student{
private String name;
private int age;
private String language;
public void setName(String name){
this.name = name;
}
public String getName(){
return name;
}
protected void setAge(int age){
this.age = age;
}
public String getLanguage(){
return language;
}
}
3）@Cleanup這個注解用在變量前面，可以保證此變量代表的資源會被自動關閉，默認是調用資源的close()方法，如果該資源有其它關閉方法，可使用@Cleanup(“methodName”)來指定要調用的方法。
示例代碼：
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[1024];
while (true) {
int r = in.read(b);
if (r == -1) break;
out.write(b, 0, r);
}
}
實際效果相當于：
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();
}
}
}
4）@ToString在JavaBean或類JavaBean中使用，使用此注解會自動重寫對應的toStirng方法，默認情況下，會輸出類名、所有屬性（會按照屬性定義順序），用逗號來分割，通過callSuper參數來指定是否引用父類，includeFieldNames參數設為true，就能明確的輸出toString()屬性。
<code>@ToString(exclude=”column”)</code>
意義：排除column列所對應的元素，即在生成toString方法時不包含column參數；
<code>@ToString(exclude={“column1″,”column2″})</code>
意義：排除多個column列所對應的元素，其中間用英文狀態下的逗號進行分割，即在生成toString方法時不包含多個column參數；
<code>@ToString(of=”column”)</code>
意義：只生成包含column列所對應的元素的參數的toString方法，即在生成toString方法時只包含column參數；；
<code>@ToString(of={“column1″,”column2”})</code>
意義：只生成包含多個column列所對應的元素的參數的toString方法，其中間用英文狀態下的逗號進行分割，即在生成toString方法時只包含多個column參數；
示例代碼：
復制代碼
@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;
}
}
}
實際效果相當于：
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) + ")";
}
}
5）@EqualsAndHashCode默認情況下，會使用所有非靜態（non-static）和非瞬態（non-transient）屬性來生成equals和hasCode，也能通過exclude注解來排除一些屬性。
示例代碼：
@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;
}
}
}
6）@NoArgsConstructor、@RequiredArgsConstructor和@AllArgsConstructor
這三個注解都是用在類上的，第一個和第三個都很好理解，就是為該類產生無參的構造方法和包含所有參數的構造方法，第二個注解則使用類中所有帶有@NonNull注解的或者帶有final修飾的成員變量生成對應的構造方法，當然，成員變量都是非靜態的，另外，如果類中含有final修飾的成員變量，是無法使用@NoArgsConstructor注解的。
三個注解都可以指定生成的構造方法的訪問權限，同時，第二個注解還可以用@RequiredArgsConstructor(staticName=”methodName”)的形式生成一個指定名稱的靜態方法，返回一個調用相應的構造方法產生的對象。
示例代碼：
復制代碼
@RequiredArgsConstructor(staticName = "myShape")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@NoArgsConstructor
public class Shape {
private int x;
@NonNull
private double y;
@NonNull
private String name;
}
實際效果相當于：
public class Shape {
private int x;
private double y;
private String name;
public Shape(){
}
protected Shape(int x,double y,String name){
this.x = x;
this.y = y;
this.name = name;
}
public Shape(double y,String name){
this.y = y;
this.name = name;
}
public static Shape myShape(double y,String name){
return new Shape(y,name);
}
}
7）@Data注解在類上，會為類的所有屬性自動生成setter/getter、equals、canEqual、hashCode、toString方法，如為final屬性，則不會為該屬性生成setter方法。@Value注解和@Data類似，區別在于它會把所有成員變量默認定義為private final修飾，并且不會生成set方法。
官方實例如下：
@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;
}
}
實際效果相當于：
復制代碼
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;
}
}
}
8）@SneakyThrows這個注解用在方法上，可以將方法中的代碼用try-catch語句包裹起來，捕獲異常并在catch中用Lombok.sneakyThrow(e)把異常拋出，可以使用@SneakyThrows(Exception.class)的形式指定拋出哪種異常，很簡單的注解，直接看個例子：
public class SneakyThrows implements Runnable {
@SneakyThrows(UnsupportedEncodingException.class)
public String utf8ToString(byte[] bytes) {
return new String(bytes, "UTF-8");
}
@SneakyThrows
public void run() {
throw new Throwable();
}
}
實際效果相當于：
public class SneakyThrows implements Runnable {
public String utf8ToString(byte[] bytes) {
try{
return new String(bytes, "UTF-8");
}catch(UnsupportedEncodingException uee){
throw Lombok.sneakyThrow(uee);
}
}
public void run() {
try{
throw new Throwable();
}catch(Throwable t){
throw Lombok.sneakyThrow(t);
}
}
}
9）@Synchronized這個注解用在類方法或者實例方法上，效果和synchronized關鍵字相同，區別在于鎖對象不同，對于類方法和實例方法，synchronized關鍵字的鎖對象分別是類的class對象和this對象，而@Synchronized得鎖對象分別是私有靜態final對象LOCK和私有final對象lock，當然，也可以自己指定鎖對象，例子也很簡單：
public class Synchronized {
private final Object readLock = new Object();
@Synchronized
public static void hello() {
System.out.println("world");
}
@Synchronized
public int answerToLife() {
return 42;
}
@Synchronized("readLock")
public void foo() {
System.out.println("bar");
}
}
實際效果相當于：
public class Synchronized {
private static final Object $LOCK = new Object[0];
private final Object $lock = new Object[0];
private final Object readLock = new Object();
public static void hello() {
synchronized($LOCK) {
System.out.println("world");
}
}
public int answerToLife() {
synchronized($lock) {
return 42;
}
}
public void foo() {
synchronized(readLock) {
System.out.println("bar");
}
}
}
10）@Log這個注解用在類上，可以省去從日志工廠生成日志對象這一步，直接進行日志記錄，具體注解根據日志工具的不同而不同，同時，可以在注解中使用topic來指定生成log對象時的類名。不同的日志注解總結如下(上面是注解，下面是實際作用)：
@CommonsLog
private static final org.Apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
@JBossLog
private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
@Log
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
@Log4j
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
@Log4j2
private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
@Slf4j
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
@XSlf4j
private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);
三、為什么不推薦使用Lombok？
Lombok的優點顯而易見，可以幫助我們省去很多冗余代碼，實際上，從潘老師個人角度來看，Java開發項目中，并不推薦使用Lombok，但潘老師還是介紹了它的使用方法，因為在一些公司存在這樣的使用場景，下面我們來看一下潘老師為什么不推薦使用Lombok，它都有哪些缺點？
1） 高侵入性，強迫隊友
Lombok插件的使用，要求開發者一定要在IDE中安裝對應的插件。不僅自己要安裝，任何和你協同開發的人都要安裝。如果有誰未安裝插件的話，使用IDE打開一個基于Lombok的項目的話會提示找不到方法等錯誤，導致項目編譯失敗。更重要的是，如果我們定義的一個jar包中使用了Lombok，那么就要求所有依賴這個jar包的所有應用都必須安裝插件，這種侵入性是很高的。
2）代碼可調試性降低
Lombok確實可以幫忙減少很多代碼，因為Lombok會幫忙自動生成很多代碼。但是，這些代碼是要在編譯階段才會生成的，所以在開發的過程中，其實很多代碼其實是缺失的。這就給代碼調試帶來一定的問題，我們想要知道某個類中的某個屬性的getter方法都被哪些類引用的話，就沒那么簡單了。
3） 影響版本升級
Lombok對于代碼有很強的侵入性，就可能帶來一個比較大的問題，那就是會影響我們對JDK的升級。按照如今JDK的升級頻率，每半年都會推出一個新的版本，但是Lombok作為一個第三方工具，并且是由開源團隊維護的，那么他的迭代速度是無法保證的。所以，如果我們需要升級到某個新版本的JDK的時候，若其中的特性在Lombok中不支持的話就會受到影響。還有一個可能帶來的問題，就是Lombok自身的升級也會受到限制。因為一個應用可能依賴了多個jar包，而每個jar包可能又要依賴不同版本的Lombok，這就導致在應用中需要做版本仲裁，而我們知道，jar包版本仲裁是沒那么容易的，而且發生問題的概率也很高。
4）注解使用有風險
在使用Lombok過程中，如果對于各種注解的底層原理不理解的話，很容易產生意想不到的結果。舉一個簡單的例子：我們知道，當我們使用@Data定義一個類的時候，會自動幫我們生成equals()方法 。但是如果只使用了@Data，而不使用@EqualsAndHashCode(callSuper=true)的話，會默認是@EqualsAndHashCode(callSuper=false)，這時候生成的equals()方法只會比較子類的屬性，不會考慮從父類繼承的屬性，無論父類屬性訪問權限是否開放，這就可能得到意想不到的結果。
5）可能會破壞封裝性
使用過程中如果不小心，在一定程度上就會破壞代碼的封裝性。舉個簡單的例子，我們定義一個購物車類，并且使用了@Data注解：
@Data
public class ShoppingCart {
//商品數目
private int itemsCount;
//總價格
private double totalPrice;
//商品明細
private List items = new ArrayList<>();
}
我們知道，購物車中商品數目、商品明細以及總價格三者之前其實是有關聯關系的，如果需要修改的話是要一起修改的。但是，我們使用了Lombok的@Data注解，對于itemsCount 和 totalPrice這兩個屬性，雖然我們將它們定義成 private 類型，但是提供了 public 的 getter、setter 方法。
外部可以通過 setter 方法隨意地修改這兩個屬性的值，我們可以隨意調用 setter 方法，來重新設置 itemsCount、totalPrice 屬性的值，這也會導致其跟 items 屬性的值不一致。
而面向對象封裝的定義是：通過訪問權限控制，隱藏內部數據，外部僅能通過類提供的有限的接口訪問、修改內部數據。所以，暴露不應該暴露的 setter 方法，明顯違反了面向對象的封裝特性。
好的做法應該是不提供getter/setter，而是只提供一個public的addItem方法，同時取修改itemsCount、totalPrice以及items三個屬性。
因此，在此種情況下，就不適合使用Lombok，或者只用@Getter不用@Setter，而別直接使用@Data，在使用過程中，需要多多小心。
四、總結
Lombok雖好，但缺點也不少，如果你在公司團隊開發中被強X了，你就只能使用，如果新項目開發，能不用就盡量別用了，否則坑也不少的！
