背景

在日常的開發中,有很多工作都是重複的,比如:
- 我們會定義很多的domain實體類,需要給每個欄位手動新增setter/getter.
- 需要列印物件的時候,需要自己手動的新增toString()方法.
- 給domain新增無參建構函式和所有引數的建構函式.

如果domain修改了屬性的名字或者刪除屬性的名字,上面三種情況都需要程式設計師手動的去修改程式碼.
那Java中有沒有一種方式能夠避免這種重複的勞動呢？那就是使用lombok.

Lombok簡介

Lombok是一個可以通過簡單的註解形式來幫助我們簡化消除一些必須有但顯得很臃腫的Java程式碼的工具，通過使用對應的註解，可以在編譯原始碼的時候生成對應的方法,官網有詳細的使用說明和視訊.
官方地址：

Lombok安裝

要是用Lombok之前,需要在你的開發工具中安裝Lombok.下載lombok.jar

Eclipse的外掛的安裝步驟

先關閉Eclipse
雙擊執行lombok.jar或者使用CMD命令執行 java -jar lombok.jar命令
出現如下圖顯示的介面:

點選Specify location ... 關聯你的Eclipse工具的 eclipse.exe 檔案
選中之後,點選 Install/Update,接著重啟工具即可.
官網有Eclipse安裝lombok的視訊,就在首頁.

IntelliJ IDEA外掛的安裝步驟:

使用IntelliJ IDEA的同學直接去下載對應的lombok外掛,需要修改配置
settings—>Build,Execution,Deployment—>Compiler—>Annotation Processors中
將Enable annotation procession 複選框給勾選上.

Lombok的使用

安裝lombok之後,不要忘記要把lombok.jar這個包加入到你的專案中.
使用Maven的同學新增如下依賴:

<dependency>
    <groupId>
 
org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.6</version>
</dependency>

接下來就可以在我們的類中使用註解的方式給類新增setter/getter方法或者構造方法,下面給同學介紹比較常用的一些註解.

@Getter and @Setter

你可以給任意欄位新增@Getter/@Setter的註解,讓lombok給我們自動的生成setter/getter方法.
沒用lombok前你的程式碼需要這樣寫:

01 public class GetterSetterExample {
02   private int age = 10;
03   private String name;
04
05   public int getAge() {
06     return age;
07   }
08
09   public void setAge(int age) {
10     this.age = age;
11   }
12   
13   protected void setName(String name) {
14     this.name = name;
15   }
16 }

使用了lombok後你的程式碼是這樣的:

01 import lombok.Getter;
02 import lombok.Setter;
03 public class GetterSetterExample {
04    @Getter@Setter 
05    private int age = 10;
06    @Getter@Setter
07    private String name;  
08 }

使用了[email protected],瞬間程式碼簡潔了很多,而且也不用擔心欄位修改後,對應的setter和getter方法需要修改.
[email protected]可以貼在欄位上,是給該欄位提供setter/getter方法.如果貼在類上,表示給該類下的所有欄位新增setter和getter方法,上面的程式碼還可以這樣寫:

01 import lombok.Getter;
02 import lombok.Setter;
03 @Getter@Setter 
04 public class GetterSetterExample {
05    private int age = 10;
06    private String name;  
07 }

@ToString

所有的類都可以使用@ToString註解來生成該類的toString()方法.預設情況下,它將列印你的類名以及每個欄位,按逗號分隔.
沒用lombok前你的程式碼需要這樣寫:

01 public class ToStringExample {
02  private int age;
03  private String name;
04  @Override
05  public String toString() {
06      return "ToStringExample [age=" + age + ", name=" + name + "]";
07  }
08 }

使用了lombok後你的程式碼是這樣的:

01 @ToString
02 public class ToStringExample {
03  private int age;
04  private String name;
05 }

@NoArgsConstructor and @AllArgsConstructor

@NoArgsConstructor:可以給我們定義的類自動的新增無參建構函式.
@AllArgsConstructor:可以給我們定義的類新增所有引數的建構函式.
沒用lombok前你的程式碼需要這樣寫:

01 public class ConstructorExample {
02  private int age;
03  private String name;
04  public ConstructorExample() {
05      super();
06  }
07  public ConstructorExample(int age, String name) {
08      super();
09      this.age = age;
10      this.name = name;
11  }
12 }

使用了lombok後你的程式碼是這樣的:

01 @NoArgsConstructor@AllArgsConstructor
02 public class ConstructorExample {
03  private int age;
04  private String name;

@EqualsAndHashCode

預設情況下，會使用所有非瞬態(non-transient)和非靜態(non-static)欄位來生成equals和hascode方法，也可以指定具體使用哪些屬性。

@Data

是快捷方式,代表@ToString, @EqualsAndHashCode, @Getter(所有欄位), @Setter(所有欄位)
沒用lombok前你的程式碼需要這樣寫:

01 public class DataExample {
02  private int age;
03  private String name;
04  public int getAge() {
05      return age;
06  }
07  public void setAge(int age) {
08      this.age = age;
09  }
10  public String getName() {
11      return name;
12  }
13  public void setName(String name) {
14      this.name = name;
15  }
16  @Override
17  public String toString() {
18      return "DataExample [age=" + age + ", name=" + name + "]";
19  }
20 }

使用了lombok後你的程式碼是這樣的:

01 @Data
02 public class DataExample {
03  private int age;
04  private String name;
05 }