最近正在寫SpringBoot系列文章和錄製視訊教程，每次都要重複寫一些Getter/Setter、構造器方法、字串輸出的ToString方法和Equals/HashCode方法等。甚是浪費時間，也影響程式碼的可讀性。因此，今天就給大家推薦一款Java開發神器——Lombok，讓程式碼更簡單易讀。

什麼是Lombok

Lombok是一款Java開發外掛，可以通過它定義的註解來精簡冗長和繁瑣的程式碼，主要針對簡單的Java模型物件（POJO）。

好處就顯而易見了，可以節省大量重複工作，特別是當POJO類的屬性增減時，需要重複修改的Getter/Setter、構造器方法、equals方法和toString方法等。

而且Lombok針對這些內容的處理是在編譯期，而不是通過反射機制，這樣的好處是並不會降低系統的效能。

下面我們就看看具體的使用。

Lombok的安裝

Lombok的安裝分兩部分：Idea外掛的安裝和maven中pom檔案的匯入。

第一步，在Idea的外掛配置中搜索Lombok或官網下載本地安裝。

同時，在外掛的描述中也能夠看到它支援的註解。

第二步，引入pom中依賴，當前最細版本1.18.10。

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

如果是通過Idea建立Spring Boot專案，可在建立專案時直接在“Developer Tool”中選擇Lombok。

完成了以上兩步，就可以在程式碼中使用該款神器了。

Lombok的使用

@Data

@Data最常用的註解之一。註解在類上，提供該類所有屬性的getter/setter方法，還提供了equals、canEqual、hashCode、toString方法。

這裡的提供什麼意思？就是開發人員不用手寫相應的方法，而Lombok會幫你生成。

使用@Data示例如下，最直觀的就是不用寫getter/setter方法。

@Data
public class Demo {
 private int id;
 private String remark;
}

我們看該類編譯之後是什麼樣子。

public class Demo {
  private int id;
  private String remark;

  public Demo() {
  }

  public int getId() {
    return this.id;
  }

  public String getRemark() {
    return this.remark;
  }

  public void setId(final int id) {
    this.id = id;
  }

  public void setRemark(final String remark) {
    this.remark = remark;
  }

  public boolean equals(final Object o) {
    if (o == this) {
      return true;
    } else if (!(o instanceof Demo)) {
      return false;
    } else {
      Demo other = (Demo)o;
      if (!other.canEqual(this)) {
        return false;
      } else if (this.getId() != other.getId()) {
        return false;
      } else {
        Object this$remark = this.getRemark();
        Object other$remark = other.getRemark();
        if (this$remark == null) {
          if (other$remark != null) {
            return false;
          }
        } else if (!this$remark.equals(other$remark)) {
          return false;
        }

        return true;
      }
    }
  }

  protected boolean canEqual(final Object other) {
    return other instanceof Demo;
  }

  public int hashCode() {
    int PRIME = true;
    int result = 1;
    int result = result * 59  this.getId();
    Object $remark = this.getRemark();
    result = result * 59  ($remark == null ? 43 : $remark.hashCode());
    return result;
  }

  public String toString() {
    return "Demo(id="  this.getId()  ",remark="  this.getRemark()  ")";
  }
}

上面的反編譯程式碼，我們可以看到提供了預設的構造方法、屬性的getter/setter方法、equals、canEqual、hashCode、toString方法。

使用起來是不是很方便，最關鍵的是，當新增屬性或減少屬性時，直接刪除屬性定義即可，效率是否提升了很多？

為了節省篇幅，後面相關注解我們就不再看反編譯的效果了，大家使用idea直接開啟編譯之後對應的.class檔案即可看到。

@Setter

作用於屬性上，為該屬性提供setter方法; 作用與類上，為該類所有的屬性提供setter方法， 都提供預設構造方法。

public class Demo {
 private int id;
 @Setter
 private String remark;
}
 
@Setter
public class Demo {
 private int id;
 private String remark;
}

@Getter

基本使用同@Setter方法，不過提供的是getter方法，不再贅述。

@Log4j

作用於類上，為該類提供一個屬性名為log的log4j日誌物件。

@Log4j
public class Demo {
}

該屬性一般使用於Controller、Service等業務處理類上。與此註解相同的還有@Log4j2，顧名思義，針對Log4j2。

@AllArgsConstructor

作用於類上，為該類提供一個包含全部參的構造方法，注意此時預設構造方法不會提供。

@AllArgsConstructor
public class Demo {
 private int id;
 private String remark;
}

效果如下：

public class Demo {
  private int id;
  private String remark;

  public Demo(final int id,final String remark) {
    this.id = id;
    this.remark = remark;
  }
}

@NoArgsConstructor

作用於類上，提供一個無參的構造方法。可以和@AllArgsConstructor同時使用，此時會生成兩個構造方法：無參構造方法和全參構造方法。

@EqualsAndHashCode

作用於類上，生成equals、canEqual、hashCode方法。具體效果參看最開始的@Data效果。

@NonNull

作用於屬性上，提供關於此引數的非空檢查，如果引數為空，則丟擲空指標異常。

使用方法：

public class Demo {
 @NonNull
 private int id;
 private String remark;
}

效果如下：

public class Demo {
  @NonNull
  private int id;
  private String remark;
}

@RequiredArgsConstructor

作用於類上，由類中所有帶有@NonNull註解或者帶有final修飾的成員變數作為引數生成構造方法。

@Cleanup

作用於變數，保證該變數代表的資源會被自動關閉，預設呼叫資源的close()方法，如果該資源有其它關閉方法，可使用

@Cleanup(“methodName”)來指定。
public void jedisExample(String[] args) {
  try {
    @Cleanup Jedis jedis =  redisService.getJedis();
  } catch (Exception ex) {
    logger.error(“Jedis異常:”,ex)
  }
}

效果相當於：

public void jedisExample(String[] args) {

  Jedis jedis= null;
  try {
    jedis = redisService.getJedis();
  } catch (Exception e) {
    logger.error(“Jedis異常:”,ex)
  } finally {
    if (jedis != null) {
      try {
        jedis.close();
      } catch (Exception e) {
        e.printStackTrace();
      }
    }
  }
}

@ToString

作用於類上，生成包含所有引數的toString方法。見@Data中toString方法。

@Value

作用於類上，會生成全引數的構造方法、getter方法、equals、hashCode、toString方法。與@Data相比多了全參構造方法，少了預設構造方法、setter方法和canEqual方法。

該註解需要注意的是：會將欄位新增上final修飾，個人感覺此處有些失控，不太建議使用。

@SneakyThrows

作用於方法上，相當於把方法內的程式碼添加了一個try-catch處理，捕獲異常catch中用Lombok.sneakyThrow(e)丟擲異常。使用@SneakyThrows(BizException.class)指定丟擲具體異常。

@SneakyThrows
public int getValue(){
 int a = 1;
 int b = 0;
 return a/b;
}

效果如下：

public int getValue() {
  try {
    int a = 1;
    int b = 0;
    return a / b;
  } catch (Throwable var3) {
    throw var3;
  }
}

@Synchronized

作用於類方法或例項方法上，效果與synchronized相同。區別在於鎖物件不同，對於類方法和例項方法，synchronized關鍵字的鎖物件分別是類的class物件和this物件，而@Synchronized的鎖物件分別是私有靜態final物件lock和私有final物件lock。也可以指定鎖物件。

public class FooExample { 

 private final Object readLock = new Object(); 

 @Synchronized 
 public static void hello() { 
   System.out.println("world");  
 } 

 @Synchronized("readLock") 
 public void foo() { 
  System.out.println("bar"); 
 } 

}

效果相當於如下：

public class FooExample { 

 private static final Object $LOCK = new Object[0]; 
 private final Object readLock = new Object(); 

 public static void hello() { 
  synchronized($LOCK) { 
   System.out.println("world"); 
  } 
 }  

 public void foo() { 
  synchronized(readLock) { 
    System.out.println("bar");  
  } 
 } 

}

val

使用val作為區域性變數宣告的型別，而不是實際寫入型別。 執行此操作時，將從初始化表示式推斷出型別。

public Map<String,String> getMap() {
 val map = new HashMap<String,String>();
 map.put("1","a");
 return map;
}

效果如下：

public Map<String,String> getMap() {
  HashMap<String,String> map = new HashMap();
  map.put("1","a");
  return map;
}

也就是說在區域性變數中，Lombok幫你推斷出具體的型別，但只能用於區域性變數中。

@Builder

作用於類上，如果你喜歡使用Builder的流式操作，那麼@Builder可能是你喜歡的註解了。

使用方法：

@Builder
public class Demo {
 private int id;
 private String remark;
}

效果如下：

public class Demo {
  private int id;
  private String remark;

  Demo(final int id,final String remark) {
    this.id = id;
    this.remark = remark;
  }

  public static Demo.DemoBuilder builder() {
    return new Demo.DemoBuilder();
  }

  public static class DemoBuilder {
    private int id;
    private String remark;

    DemoBuilder() {
    }

    public Demo.DemoBuilder id(final int id) {
      this.id = id;
      return this;
    }

    public Demo.DemoBuilder remark(final String remark) {
      this.remark = remark;
      return this;
    }

    public Demo build() {
      return new Demo(this.id,this.remark);
    }

    public String toString() {
      return "Demo.DemoBuilder(id="  this.id  ",remark="  this.remark  ")";
    }
  }
}

我們可以看到，在該類內部提供了DemoBuilder類用來處理具體的流式操作。同時提供了全參的構造方法。

小結

最後，說一下個人的看法，此神器雖然好用，但也不建議大家無條件的使用，為了程式的效率等問題，該自己親手寫的程式碼還是要自己親手寫。畢竟，只有定製化的才能達到最優化和最符合當前場景。

到此這篇關於Java開發神器Lombok使用詳解的文章就介紹到這了,更多相關Java Lombok使用內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！