lombok介紹、使用方法和總結

時間  2019-11-09
標籤 lombok 介紹 使用方法 總結 欄目 Java 简体版
原文   原文鏈接

lombok是一個能夠幫助咱們簡化java代碼編寫的工具類，尤爲是簡化javabean的編寫，即經過採用註解的方式，消除代碼中的構造方法，getter/setter等代碼，使咱們寫的類更加簡潔，固然，這帶來的反作用就是不易閱讀…不過，仍是能看得懂吧，廢話很少說，先看一下lombok支持的一些常見的註解。java

@NonNull
@Cleanup
@Getter/@Setter
@ToString
@EqualsAndHashCode
@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor
@Data
@Value
@SneakyThrows
@Synchronized
@Log
@NonNull
這個註解能夠用在成員方法或者構造方法的參數前面，會自動產生一個關於此參數的非空檢查，若是參數爲空，則拋出一個空指針異常，舉個例子來看看：git

//成員方法參數加上@NonNull註解github

public String getName(@NonNull Person p){
    return p.getName();
}

實際效果至關於：spring

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

用在構造方法的參數上效果相似，就再也不舉例子了。apache

@Cleanup
這個註解用在變量前面，能夠保證此變量表明的資源會被自動關閉，默認是調用資源的close()方法，若是該資源有其它關閉方法，可以使用@Cleanup(「methodName」)來指定要調用的方法，就用輸入輸出流來舉個例子吧：編程

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

實際效果至關於：api

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


是否是簡化了不少。mybatis

@Getter/@Setter
這一對註解從名字上就很好理解，用在成員變量前面，至關於爲成員變量生成對應的get和set方法，同時還能夠爲生成的方法指定訪問修飾符，固然，默認爲public，直接來看下面的簡單的例子：架構

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

    @Setter(AccessLevel.PROTECTED)
    private int age;

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

實際效果至關於：eclipse

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

這兩個註解還能夠直接用在類上，能夠爲此類裏的全部非靜態成員變量生成對應的get和set方法。

@ToString/@EqualsAndHashCode
這兩個註解也比較好理解，就是生成toString，equals和hashcode方法，同時後者還會生成一個canEqual方法，用於判斷某個對象是不是當前類的實例，生成方法時只會使用類中的非靜態和非transient成員變量，這些都比較好理解，就不舉例子了。 
固然，這兩個註解也能夠添加限制條件，例如用@ToString(exclude={「param1」，「param2」})來排除param1和param2兩個成員變量，或者用@ToString(of={「param1」，「param2」})來指定使用param1和param2兩個成員變量，@EqualsAndHashCode註解也有一樣的用法。

@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor
這三個註解都是用在類上的，第一個和第三個都很好理解，就是爲該類產生無參的構造方法和包含全部參數的構造方法，第二個註解則使用類中全部帶有@NonNull註解的或者帶有final修飾的成員變量生成對應的構造方法，固然，和前面幾個註解同樣，成員變量都是非靜態的，另外，若是類中含有final修飾的成員變量，是沒法使用@NoArgsConstructor註解的。 
三個註解均可以指定生成的構造方法的訪問權限，同時，第二個註解還能夠用@RequiredArgsConstructor(staticName=」methodName」)的形式生成一個指定名稱的靜態方法，返回一個調用相應的構造方法產生的對象，下面來看一個生動鮮活的例子：

@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註解綜合了3,4,5和6裏面的@RequiredArgsConstructor註解，其中@RequiredArgsConstructor使用了類中的帶有@NonNull註解的或者final修飾的成員變量，它可使用@Data(staticConstructor=」methodName」)來生成一個靜態方法，返回一個調用相應的構造方法產生的對象。這個例子就也省略了吧… 
@Value註解和@Data相似，區別在於它會把全部成員變量默認定義爲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關鍵字相同，區別在於鎖對象不一樣，對於類方法和實例方法，synchronized關鍵字的鎖對象分別是類的class對象和this對象，而@Synchronized得鎖對象分別是私有靜態final對象LOCK和私有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
這個註解用在類上，能夠省去從日誌工廠生成日誌對象這一步，直接進行日誌記錄，具體註解根據日誌工具的不一樣而不一樣，同時，能夠在註解中使用topic來指定生成log對象時的類名。不一樣的日誌註解總結以下(上面是註解，下面是實際做用)：

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

Lombok工做原理分析

會發如今Lombok使用的過程當中，只須要添加相應的註解，無需再爲此寫任何代碼。自動生成的代碼究竟是如何產生的呢？

核心之處就是對於註解的解析上。JDK5引入了註解的同時，也提供了兩種解析方式。

  • 運行時解析

運行時可以解析的註解，必須將@Retention設置爲RUNTIME，這樣就能夠經過反射拿到該註解。java.lang,reflect反射包中提供了一個接口AnnotatedElement，該接口定義了獲取註解信息的幾個方法，Class、Constructor、Field、Method、Package等都實現了該接口，對反射熟悉的朋友應該都會很熟悉這種解析方式。

  • 編譯時解析

編譯時解析有兩種機制，分別簡單描述下：

1）Annotation Processing Tool

apt自JDK5產生，JDK7已標記爲過時，不推薦使用，JDK8中已完全刪除，自JDK6開始，可使用Pluggable Annotation Processing API來替換它，apt被替換主要有2點緣由：

  • api都在com.sun.mirror非標準包下
  • 沒有集成到javac中，須要額外運行

2）Pluggable Annotation Processing API

JSR 269自JDK6加入，做爲apt的替代方案，它解決了apt的兩個問題，javac在執行的時候會調用實現了該API的程序，這樣咱們就能夠對編譯器作一些加強，這時javac執行的過程以下： 
這裏寫圖片描述

Lombok本質上就是一個實現了「JSR 269 API」的程序。在使用javac的過程當中，它產生做用的具體流程以下：

  1. javac對源代碼進行分析，生成了一棵抽象語法樹（AST）
  2. 運行過程當中調用實現了「JSR 269 API」的Lombok程序
  3. 此時Lombok就對第一步驟獲得的AST進行處理，找到@Data註解所在類對應的語法樹（AST），而後修改該語法樹（AST），增長getter和setter方法定義的相應樹節點
  4. javac使用修改後的抽象語法樹（AST）生成字節碼文件，即給class增長新的節點（代碼塊）

拜讀了Lombok源碼，對應註解的實現都在HandleXXX中，好比@Getter註解的實現時HandleGetter.handle()。還有一些其它類庫使用這種方式實現，好比Google Auto、Dagger等等。

Lombok的優缺點

優勢：

  1. 能經過註解的形式自動生成構造器、getter/setter、equals、hashcode、toString等方法，提升了必定的開發效率
  2. 讓代碼變得簡潔，不用過多的去關注相應的方法
  3. 屬性作修改時，也簡化了維護爲這些屬性所生成的getter/setter方法等

缺點：

  1. 不支持多種參數構造器的重載
  2. 雖然省去了手動建立getter/setter方法的麻煩，但大大下降了源代碼的可讀性和完整性，下降了閱讀源代碼的溫馨度

總結

Lombok雖然有不少優勢，但Lombok更相似於一種IDE插件，項目也須要依賴相應的jar包。Lombok依賴jar包是由於編譯時要用它的註解，爲何說它又相似插件？由於在使用時，eclipse或IntelliJ IDEA都須要安裝相應的插件，在編譯器編譯時經過操做AST（抽象語法樹）改變字節碼生成，變向的就是說它在改變java語法。它不像spring的依賴注入或者mybatis的ORM同樣是運行時的特性，而是編譯時的特性。這裏我我的最感受不爽的地方就是對插件的依賴！由於Lombok只是省去了一些人工生成代碼的麻煩，但IDE都有快捷鍵來協助生成getter/setter等方法，也很是方便。

知乎上有位大神發表過對Lombok的一些見解：

這是一種低級趣味的插件，不建議使用。JAVA發展到今天，各類插件層出不窮，如何甄別各類插件的優劣？能從架構上優化你的設計的，能提升應用程序性能的 ，
實現高度封裝可擴展的...， 像lombok這種，像這種插件，已經不只僅是插件了，改變了你如何編寫源碼，事實上，少去了代碼你寫上去又如何？ 
若是JAVA家族處處充斥這樣的東西，那隻不過是一坨披着金屬顏色的屎，早晚會被其它的語言取代。

雖然話糙但理確實不糙，試想一個項目有很是多相似Lombok這樣的插件，我的以爲真的會極大的下降閱讀源代碼的溫馨度。

雖然很是不建議在屬性的getter/setter寫一些業務代碼，但在多年項目的實戰中，有時經過給getter/setter加一點點業務代碼，能極大的簡化某些業務場景的代碼。所謂取捨，也許就是這時的捨棄必定的規範，取得極大的方便。

我如今很是堅信一條理念，任何編程語言或插件，都僅僅只是工具而已，即便工具再強大也在於用的人，就如同小米加步槍照樣能贏飛機大炮的道理同樣。結合具體業務場景和項目實際狀況，無需一味追求高大上的技術，適合的纔是王道。

Lombok有它的得天獨厚的優勢，也有它避之不及的缺點，熟知其優缺點，在實戰中靈活運用纔是王道。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程