詳解Lombok安裝及Spring Boot集成Lombok

更新時間：2019年03月18日 09:18:56 作者：逆天子陸離

這篇文章主要介紹了詳解Lombok安裝及Spring Boot集成Lombok，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

Lombok有什么用

在我們實體Bean中有大量的Getter/Setter方法以及toString, hashCode等可能不會用到，但是某些時候仍然需要復(fù)寫；在使用Lombok之后，將由其來自動幫你實現(xiàn)代碼生成。注意，其是在編譯源碼過程中，幫你自動生成的。就是說，將極大減少你的代碼總量。

Lombok的官方地址： https://projectlombok.org/

使用Lombok時需要注意的點

在類需要序列化、反序列化時或者需要詳細控制字段時，應(yīng)該謹慎考慮是否要使用Lombok，因為在這種情況下容易出問題。例如：Jackson、Json序列化
使用Lombok雖然能夠省去手動創(chuàng)建setter和getter方法等繁瑣事情，但是卻降低了源代碼文件的可讀性和完整性，減低了閱讀源代碼的舒適度
使用@Slf4j還是@Log4j注解，需要根據(jù)實際項目中使用的日志框架來選擇。
Lombok并非處處適用，我們需要選擇適合的地方使用Lombok，例如pojo是一個好地方，因為pojo很單純

Lombok的安裝

eclipse安裝Lombok步驟：

下載最新的lombok.jar包，下載地址：https://projectlombok.org/download.html

進入cmd窗口，切到Lombok下載的目錄，運行命令： java -jar lombok.jar，會出現(xiàn)如下界面：

已經(jīng)默認選好了eclipse安裝目錄（這個可能是因為我只有一個盤，如果沒有默認選擇，可以自己點擊下方Specify location...按鈕選擇eclipse安裝目錄），點擊圖中紅色箭頭指向的按鈕，即可完成安裝。成功界面如下：

eclipse安裝目錄下的eclipse.ini文件末尾已經(jīng)加了一行內(nèi)容（這個路徑因人而異，和eclipse安裝目錄有關(guān)），如下：

而且安裝目錄下也多了一個lombok.jar

spring boot集成Lombok

先去http://start.spring.io/在線生成一個spring boot項目腳手架，導(dǎo)入eclipse。

在pom.xml里添加Lombok依賴：

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

在src/main/java/com/example/springbootlombok/entity下新建一個student.java的Java bean：

package com.example.springbootlombok.entity;

import lombok.Data;
    
@Data
public class Student {
  private String name;
  private int age;
}

在src/test/java/com/example/springbootlombok下新建一個TestEntity.java的測試類：

package com.example.springbootlombok;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
  
import com.example.springbootlombok.entity.Student;
  
import lombok.extern.slf4j.Slf4j;
  
@RunWith(SpringRunner.class)
@SpringBootTest
@Slf4j
public class TestEntity {
    
  Student student = new Student();
    
  @Test
  public void test() {
    student.setName("張三");
    student.setAge(12);
    log.info("測試結(jié)果:" + student.toString());
  }
}

執(zhí)行JUnit測試，成功的話，日志里會有打印測試結(jié)果:Student(name=張三, age=12)，至此，spring boot已經(jīng)成功集成Lombok了。

Lombok常用注解

@NonNull

這個注解可以用在成員方法或者構(gòu)造方法的參數(shù)前面，會自動產(chǎn)生一個關(guān)于此參數(shù)的非空檢查，如果參數(shù)為空，則拋出一個空指針異常，舉個例子：

編譯前的代碼：

//成員方法參數(shù)加上@NonNull注解
public String getName(@NonNull Person p) {
  return p.getName();
}

編譯后的代碼：

public String getName(@NonNull Person p) {
  if (p == null) {
    throw new NullPointerException("person");
  }
  return p.getName();
}

@Cleanup

這個注解用在變量前面，可以保證此變量代表的資源會被自動關(guān)閉，默認是調(diào)用資源的close()方法，如果該資源有其它關(guān)閉方法，可使用@Cleanup("methodName")來指定要調(diào)用的方法，就用輸入輸出流來舉個例子：

編譯前的代碼：

public static void main(String[] args) throws IOException {
  @Cleanup InputStream in = new FileInputStream(args[0]);
  @Cleanup OutputStream out = new FileOutputStream(args[1]);
  byte[] b = new byte[1024];
  while (true) {
    int r = in.read(b);
    if (r == -1) break;
    out.write(b, 0, r);
  }
 }

編譯后的代碼：

public static void main(String[] args) throws IOException {
  InputStream in = new FileInputStream(args[0]);
  try {
    OutputStream out = new FileOutputStream(args[1]);
    try {
      byte[] b = new byte[10000];
      while (true) {
        int r = in.read(b);
        if (r == -1) break;
        out.write(b, 0, r);
      }
    } finally {
      if (out != null) {
        out.close();
      }
    }
  } finally {
    if (in != null) {
      in.close();
    }
  }
}

@Getter/@Setter

這一對注解從名字上就很好理解，用在成員變量前面，相當于為成員變量生成對應(yīng)的get和set方法，同時還可以為生成的方法指定訪問修飾符，當然，默認為public，直接來看下面的簡單的例子：

編譯前的代碼：

public class Programmer {
  @Getter
  @Setter
  private String name;

  @Setter(AccessLevel.PROTECTED)
  private int age;

  @Getter(AccessLevel.PUBLIC)
  private String language;
}

編譯后的代碼：

public class Programmer {
  private String name;
  private int age;
  private String language;

  public void setName(String name) {
    this.name = name;
  }

  public String getName() {
    return name;
  }

  protected void setAge(int age) {
    this.age = age;
  }

  public String getLanguage() {
    return language;
  }
}

這兩個注解還可以直接用在類上，可以為此類里的所有非靜態(tài)成員變量生成對應(yīng)的get和set方法。

@Getter(lazy=true)

如果Bean的一個字段的初始化是代價比較高的操作，比如加載大量的數(shù)據(jù)；同時這個字段并不是必定使用的。那么使用懶加載機制，可以保證節(jié)省資源。

懶加載機制，是對象初始化時，該字段并不會真正的初始化，而是第一次訪問該字段時才進行初始化字段的操作。

@ToString/@EqualsAndHashCode

這兩個注解也比較好理解，就是生成toString，equals和hashcode方法，同時后者還會生成一個canEqual方法，用于判斷某個對象是否是當前類的實例，生成方法時只會使用類中的非靜態(tài)和非transient成員變量，這些都比較好理解，就不舉例子了。

當然，這兩個注解也可以添加限制條件，例如用@ToString(exclude={"param1","param2"})來排除param1和param2兩個成員變量，或者用@ToString(of={"param1","param2"})來指定使用param1和param2兩個成員變量，@EqualsAndHashCode注解也有同樣的用法。

@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor

這三個注解都是用在類上的，第一個和第三個都很好理解，就是為該類產(chǎn)生無參的構(gòu)造方法和包含所有參數(shù)的構(gòu)造方法，第二個注解則使用類中所有帶有@NonNull注解的或者帶有final修飾的成員變量生成對應(yīng)的構(gòu)造方法。當然，和前面幾個注解一樣，成員變量都是非靜態(tài)的，另外，如果類中含有final修飾的成員變量，是無法使用@NoArgsConstructor注解的。

三個注解都可以指定生成的構(gòu)造方法的訪問權(quán)限，同時，第二個注解還可以用@RequiredArgsConstructor(staticName="methodName")的形式生成一個指定名稱的靜態(tài)方法，返回一個調(diào)用相應(yīng)的構(gòu)造方法產(chǎn)生的對象，下面來看一個生動鮮活的例子：

編譯前的代碼：

@RequiredArgsConstructor(staticName = "sunsfan")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@NoArgsConstructor
public class Shape {
  private int x;
  @NonNull
  private double y;
  @NonNull
  private String name;
}

編譯后的代碼：

public class Shape {
  private int x;
  private double y;
  private String name;

  public Shape() {
  }

  protected Shape(int x, double y, String name) {
    this.x = x;
    this.y = y;
    this.name = name;
  }

  public Shape(double y, String name) {
    this.y = y;
    this.name = name;
  }

  public static Shape sunsfan(double y, String name) {
    return new Shape(y, name);
  }
}

@Data/@Value

@Data注解綜合了@Getter/@Setter，@ToString，@EqualsAndHashCode和@RequiredArgsConstructor注解，其中@RequiredArgsConstructor使用了類中的帶有@NonNull注解的或者final修飾的成員變量，它可以使用@Data(staticConstructor="methodName")來生成一個靜態(tài)方法，返回一個調(diào)用相應(yīng)的構(gòu)造方法產(chǎn)生的對象。

@Value注解和@Data類似，區(qū)別在于它會把所有成員變量默認定義為private final修飾，并且不會生成set方法。

@SneakyThrows

這個注解用在方法上，可以將方法中的代碼用try-catch語句包裹起來，捕獲異常并在catch中用Lombok.sneakyThrow(e)把異常拋出，可以使用@SneakyThrows(Exception.class)的形式指定拋出哪種異常，很簡單的注解，直接看個例子：

編譯前的代碼：

public class SneakyThrows implements Runnable {
  @SneakyThrows(UnsupportedEncodingException.class)
  public String utf8ToString(byte[] bytes) {
    return new String(bytes, "UTF-8");
  }

  @SneakyThrows
  public void run() {
    throw new Throwable();
  }
}

編譯后的代碼：

public class SneakyThrows implements Runnable {
  @SneakyThrows(UnsupportedEncodingException.class)
  public String utf8ToString(byte[] bytes) {
    try {
      return new String(bytes, "UTF-8");
    } catch(UnsupportedEncodingException uee) {
      throw Lombok.sneakyThrow(uee);
    }
  }

  @SneakyThrows
  public void run() {
    try {
      throw new Throwable();
    } catch(Throwable t) {
      throw Lombok.sneakyThrow(t);
    }
  }
}

@Synchronized

這個注解用在類方法或者實例方法上，效果和synchronized關(guān)鍵字相同，區(qū)別在于鎖對象不同，對于類方法和實例方法，synchronized關(guān)鍵字的鎖對象分別是類的class對象和this對象，而@Synchronized的鎖對象分別是私有靜態(tài)final對象LOCK和私有final對象lock，當然，也可以自己指定鎖對象，例子也很簡單，往下看：

編譯前的代碼：

public class Synchronized {
  private final Object readLock = new Object();

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

  @Synchronized
  public int answerToLife() {
    return 42;
  }

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

編譯后的代碼：

public class Synchronized {
  private static final Object $LOCK = new Object[0];
  private final Object $lock = new Object[0];
  private final Object readLock = new Object();

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

  public int answerToLife() {
    synchronized($lock) {
      return 42;
    }
  }

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

@Log

這個注解用在類上，可以省去從日志工廠生成日志對象這一步，直接進行日志記錄，具體注解根據(jù)日志工具的不同而不同，同時，可以在注解中使用topic來指定生成log對象時的類名。不同的日志注解總結(jié)如下(上面是注解，下面是編譯后的代碼)：

@CommonsLog
==> private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);

@JBossLog
==> private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);

@Log
==> private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());

@Log4j
==> private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);

@Log4j2
==> private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);

@Slf4j
==> private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);

@XSlf4j
==> private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);