Lombok安裝及Spring Boot集成Lombok

時間  2019-11-10
標籤 lombok 安裝 spring boot 集成 欄目 Java 简体版
原文   原文鏈接

Lombok有什麼用

在咱們實體Bean中有大量的Getter/Setter方法以及toString, hashCode等可能不會用到，可是某些時候仍然須要複寫；在使用Lombok以後，將由其來自動幫你實現代碼生成。注意，其是在編譯源碼過程當中，幫你自動生成的。就是說，將極大減小你的代碼總量。html

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

使用Lombok時須要注意的點

  • 在類須要序列化、反序列化時或者須要詳細控制字段時，應該謹慎考慮是否要使用Lombok，由於在這種狀況下容易出問題。例如：Jackson、Json序列化
  • 使用Lombok雖然可以省去手動建立setter和getter方法等繁雜事情，可是卻下降了源代碼文件的可讀性和完整性，減低了閱讀源代碼的溫馨度
  • 使用@Slf4j仍是@Log4j註解，須要根據實際項目中使用的日誌框架來選擇。
  • Lombok並不是到處適用，咱們須要選擇適合的地方使用Lombok，例如pojo是一個好地方，由於pojo很單純

Lombok的安裝

eclipse安裝Lombok步驟：spring

  1. 下載最新的lombok.jar包，下載地址：https://projectlombok.org/download.html
  2. 進入cmd窗口，切到Lombok下載的目錄，運行命令： java -jar lombok.jar，會出現以下界面：

    安裝選項界面

    已經默認選好了eclipse安裝目錄（這個多是由於我只有一個盤，若是沒有默認選擇，能夠本身點擊下方Specify location...按鈕選擇eclipse安裝目錄），點擊圖中紅色箭頭指向的按鈕，便可完成安裝。成功界面以下：
    安裝成功界面apache

  3. eclipse安裝目錄下的eclipse.ini文件末尾已經加了一行內容（這個路徑因人而異，和eclipse安裝目錄有關），以下：
    eclipse.ini內容

    並且安裝目錄下也多了一個lombok.jarapi

spring boot集成Lombok

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

  2. 在pom.xml裏添加Lombok依賴：springboot

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

  3. 在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;
}

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

    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("測試結果:" + student.toString());
    }
}
  5. 執行JUnit測試，成功的話，日誌裏會有打印測試結果:Student(name=張三, age=12)，至此，spring boot已經成功集成Lombok了。

Lombok經常使用註解

@NonNull

這個註解能夠用在成員方法或者構造方法的參數前面，會自動產生一個關於此參數的非空檢查，若是參數爲空，則拋出一個空指針異常，舉個例子：工具

編譯前的代碼：測試

//成員方法參數加上@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

這個註解用在變量前面，能夠保證此變量表明的資源會被自動關閉，默認是調用資源的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);
    }
 }

編譯後的代碼：

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

這一對註解從名字上就很好理解，用在成員變量前面，至關於爲成員變量生成對應的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;
    }
}

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

@Getter(lazy=true)

若是Bean的一個字段的初始化是代價比較高的操做，好比加載大量的數據；同時這個字段並非一定使用的。那麼使用懶加載機制，能夠保證節省資源。

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

@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註解綜合了@Getter/@Setter，@ToString，@EqualsAndHashCode和@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，固然，也能夠本身指定鎖對象，例子也很簡單，往下看：

編譯前的代碼：

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

參考資料

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