lombok注解介紹小結(jié)

更新時(shí)間：2018年11月25日 12:09:25 作者：sunsfan

lombok是一個(gè)可以幫助我們簡(jiǎn)化java代碼編寫的工具類，這篇文章主要介紹了lombok注解介紹小結(jié)，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

lombok注解介紹

lombok是一個(gè)可以幫助我們簡(jiǎn)化java代碼編寫的工具類，尤其是簡(jiǎn)化javabean的編寫，即通過采用注解的方式，消除代碼中的構(gòu)造方法，getter/setter等代碼，使我們寫的類更加簡(jiǎn)潔，當(dāng)然，這帶來的副作用就是不易閱讀…不過，還是能看得懂吧，廢話不多說，先看一下lombok支持的一些常見的注解。

@NonNull
@Cleanup
@Getter/@Setter
@ToString
@EqualsAndHashCode
@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor
@Data
@Value
@SneakyThrows
@Synchronized
@Log

@NonNull

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

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

實(shí)際效果相當(dāng)于：

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

用在構(gòu)造方法的參數(shù)上效果類似，就不再舉例子了。

@Cleanup

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

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);
   }
 }

實(shí)際效果相當(dāng)于：

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();
    }
  }
}

是不是簡(jiǎn)化了很多。

@Getter/@Setter

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

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

  @Setter(AccessLevel.PROTECTED)
  private int age;

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

實(shí)際效果相當(dāng)于：

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;
  }
}

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

@ToString/@EqualsAndHashCode

這兩個(gè)注解也比較好理解，就是生成toString，equals和hashcode方法，同時(shí)后者還會(huì)生成一個(gè)canEqual方法，用于判斷某個(gè)對(duì)象是否是當(dāng)前類的實(shí)例，生成方法時(shí)只會(huì)使用類中的非靜態(tài)和非transient成員變量，這些都比較好理解，就不舉例子了。
當(dāng)然，這兩個(gè)注解也可以添加限制條件，例如用@ToString(exclude={“param1”，“param2”})來排除param1和param2兩個(gè)成員變量，或者用@ToString(of={“param1”，“param2”})來指定使用param1和param2兩個(gè)成員變量，@EqualsAndHashCode注解也有同樣的用法。

@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor

這三個(gè)注解都是用在類上的，第一個(gè)和第三個(gè)都很好理解，就是為該類產(chǎn)生無參的構(gòu)造方法和包含所有參數(shù)的構(gòu)造方法，第二個(gè)注解則使用類中所有帶有@NonNull注解的或者帶有final修飾的成員變量生成對(duì)應(yīng)的構(gòu)造方法，當(dāng)然，和前面幾個(gè)注解一樣，成員變量都是非靜態(tài)的，另外，如果類中含有final修飾的成員變量，是無法使用@NoArgsConstructor注解的。
三個(gè)注解都可以指定生成的構(gòu)造方法的訪問權(quán)限，同時(shí)，第二個(gè)注解還可以用@RequiredArgsConstructor(staticName=”methodName”)的形式生成一個(gè)指定名稱的靜態(tài)方法，返回一個(gè)調(diào)用相應(yīng)的構(gòu)造方法產(chǎn)生的對(duì)象，下面來看一個(gè)生動(dòng)鮮活的例子：

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

實(shí)際效果相當(dāng)于：

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注解綜合了3,4,5和6里面的@RequiredArgsConstructor注解，其中@RequiredArgsConstructor使用了類中的帶有@NonNull注解的或者final修飾的成員變量，它可以使用@Data(staticConstructor=”methodName”)來生成一個(gè)靜態(tài)方法，返回一個(gè)調(diào)用相應(yīng)的構(gòu)造方法產(chǎn)生的對(duì)象。這個(gè)例子就也省略了吧…

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

@SneakyThrows

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

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();
  }
}

實(shí)際效果相當(dāng)于：

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

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

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");
  }
}

實(shí)際效果相當(dāng)于：

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

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

@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);

關(guān)于lombok的注解先寫到這里，當(dāng)然，還有其他一些注解需要大家自己去摸索，同時(shí)lombok一直在擴(kuò)展，將來肯定會(huì)加入更多的注解元素，拭目以待了。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: