SpringBoot優雅編碼之：Lombok加持

時間 2019-11-24

原文原文鏈接

概述

Lombok 經過提供簡單的語法註解形式來幫助簡化消除一些必須有但顯得很臃腫的 java 代碼。典型的是對於 POJO對象的簡化（如自動幫咱們生成Setter和Getter等），有了Lombok的加持，開發人員能夠免去不少重複且臃腫的操做，極大地提升java代碼的信噪比，所以咱們必須嘗試並應用起來！java

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

IntelliJ IDEA上配置

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

首先進入Plugins界面：

而後搜索並安裝Lombok插件：

最後不要忘了開啓Annotation Processors的Enable選項：

上述安裝完成之後須要重啓IDEA生效！編程

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

有時因爲網絡緣由，上面方法一這種方式安裝失敗，所以只能手動下載安裝bash

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

重啓idea便可

IDE中設置完成之後須要在pom.xml中添加以下所示的lombok依賴才能使用app

<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」;
    }
}
複製代碼

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