SpringBoot優雅編碼之：Lombok加持

---

概述

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

注： 本文首發於 My 公眾號 CodeSheep ，可 長按 或 掃描 下面的 小心心 來訂閱 ↓ ↓ ↓

---

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依賴才能使用

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.16.16</version>
</dependency>
複製程式碼

---

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;
  }
}
複製程式碼

• Lombok加持後，寫法可簡化為：

@Data
public class UserLombok {
    private final String name;
    private int age;
    private double score;
    private String[] tags;
}
複製程式碼

在IDEA中使用時，Lombok的註解會自動補全，如下圖所示：

• 我們來寫POJO的測試程式碼

    public static void main( String[] args ) {
        UserLombok userLombok = new UserLombok("hansonwang99”);
        userLombok.setAge(18);
        String[] array = new String[]{"apple","juice”};
        userLombok.setTags( array );
        userLombok.setScore( 99.0 );
        System.out.println(userLombok);
    }
複製程式碼

由下圖我們可以看到IDEA依然可以自動為我們補全由Lombok自動生成的程式碼：

• 結果列印

由於Lombok為我們自動生成了toString方法，因此物件的列印結果如下：

UserLombok(name=hansonwang99, age=18, score=99.0, tags=[apple, juice])
複製程式碼

---

@Log註解實戰

在我的文章 Spring Boot日誌框架實踐 一文中，我們使用Log4j2來作為日誌物件，其寫法如下：

@RestController
@RequestMapping("/testlogging”)
public class LoggingTestController {

    private final Logger logger = LogManager.getLogger(this.getClass());

    @GetMapping("/hello”)
    public String hello() {
        for(int i=0;i<10_0000;i++){
            logger.info("info execute index method”);
            logger.warn("warn execute index method”);
            logger.error("error execute index method”);

        }

        return "My First SpringBoot Application”;
    }
}
複製程式碼

若改用Lombok後，寫法變得更加簡潔，我們只需要引入對應的@Log註解即可完成log物件的生成：

@RestController
@RequestMapping("/testloggingwithlombok”)
@Log4j2
public class LoggingTestControllerLombok {

    @GetMapping("/hello”)
    public String hello() {
        for(int i=0;i<10_0000;i++){
            log.info("info execute index method”);
            log.warn("warn execute index method”);
            log.error("error execute index method”);

        }

        return "My First SpringBoot Application”;
    }
}
複製程式碼

怎麼樣，是不是一切都是那麼地優雅！

---

後記

• 作者更多的原創文章在此，歡迎觀賞

• My Personal Blog

作者更多的SpringBt實踐文章在此：

• Spring Boot應用監控實戰
• SpringBoot應用部署於外接Tomcat容器
• ElasticSearch搜尋引擎在SpringBt中的實踐
• 初探Kotlin+SpringBoot聯合程式設計
• Spring Boot日誌框架實踐
• SpringBoot優雅編碼之：Lombok加持

---

如果有興趣，也可以抽點時間看看作者一些關於容器化、微服務化方面的文章：

• 利用K8S技術棧打造個人私有云 連載文章
• 從一份配置清單詳解Nginx伺服器配置
• Docker容器視覺化監控中心搭建
• 利用ELK搭建Docker容器化應用日誌中心
• RPC框架實踐之：Apache Thrift
• RPC框架實踐之：Google gRPC
• 微服務呼叫鏈追蹤中心搭建
• Docker容器跨主機通訊
• Docker Swarm叢集初探
• 高效編寫Dockerfile的幾條準則

---

---