SpringBoot 優雅編碼之：Lombok 加持

dxw555 2018-04-13

展開全文

摘要: Lombok 通過提供簡單的語法注解形式來幫助簡化消除一些必須有但顯得很臃腫的 java 代碼。典型的是對于 POJO對象的簡化（如自動幫我們生成Setter和Getter等），有了Lombok的加持，開發人員可以免去很多重復且臃腫的操作，**極大地提高java代碼的信噪比**，因此我們必須嘗試并應用起來

概述

Lombok 通過提供簡單的語法注解形式來幫助簡化消除一些必須有但顯得很臃腫的 java 代碼。典型的是對于 POJO對象的簡化（如自動幫我們生成Setter和Getter等），有了Lombok的加持，開發人員可以免去很多重復且臃腫的操作，極大地提高java代碼的信噪比，因此我們必須嘗試并應用起來！

IntelliJ IDEA上配置

方法一：直接在IDEA界面中配置

首先進入Plugins界面：

然后搜索并安裝Lombok插件：

最后不要忘了開啟Annotation Processors的Enable選項：

上述安裝完成以后需要重啟IDEA生效！

方法二：手動下載Lombok插件安裝

有時由于網絡原因，上面方法一這種方式安裝失敗，因此只能手動下載安裝

下載lombok插件： https://github.com/mplushnikov/lombok-intellij-plugin/releases
Plugins -> Install plugin from disk... 選擇下載的zip包安裝

重啟idea即可

IDE中設置完成以后需要在pom.xml中添加如下所示的lombok依賴才能使用

Lombok 主要注解

@Getter and @Setter / 自動為屬性提供 Set和Get 方法
@ToString / 該注解的作用是為類自動生成toString()方法
@EqualsAndHashCode / 為對象字段自動生成hashCode和equals實現
@AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor / 顧名思義，為類自動生成對應參數的constructor
@Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @CommonsLog, @JBossLog / 自動為類添加對應的log支持
@Data / 自動為所有字段添加@ToString, @EqualsAndHashCode, @Getter，為非final字段添加@Setter,和@RequiredArgsConstructor，本質上相當于幾個注解的綜合效果
@NonNull / 自動幫助我們避免空指針。作用在方法參數上的注解，用于自動生成空值參數檢查
@Cleanup / 自動幫我們調用close()方法。作用在局部變量上，在作用域結束時會自動調用close方法釋放資源

下文就Lombok中用的最為頻繁的@Data和@Log注解進行代碼實戰！

@Data 注解使用

官網關于@Data注解的解釋如下：

All together now: A shortcut for @ToString, @EqualsAndHashCode, @Getter on all fields, @Setter on all non-final fields, and @RequiredArgsConstructor!

不難理解，其可以看成是多個Lombok注解的集成，因此使用很方便！

先來創建一個POJO實體UserLombok，普通的寫法如下：

public class UserLombok {
private final String name;
private int age;
private double score;
private String[] tags;

public UserLombok(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;
}
}