Lombok安裝及Spring Boot集成Lombok

Lombok有什么用

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

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

使用Lombok時需要注意的點

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

Lombok的安裝

eclipse安裝Lombok步驟：

  1. 下載最新的lombok.jar包惧蛹，下載地址：https://projectlombok.org/download.html
  2. 進入cmd窗口扇救，切到Lombok下載的目錄，運行命令： java -jar lombok.jar香嗓，會出現(xiàn)如下界面：
    安裝選項界面

    已經(jīng)默認選好了eclipse安裝目錄（這個可能是因為我只有一個盤迅腔，如果沒有默認選擇，可以自己點擊下方Specify location...按鈕選擇eclipse安裝目錄）靠娱，點擊圖中紅色箭頭指向的按鈕沧烈，即可完成安裝。成功界面如下：
    安裝成功界面
  3. eclipse安裝目錄下的eclipse.ini文件末尾已經(jīng)加了一行內(nèi)容（這個路徑因人而異像云，和eclipse安裝目錄有關(guān)）锌雀，如下：
    eclipse.ini內(nèi)容

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

spring boot集成Lombok

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

  2. 在pom.xml里添加Lombok依賴：

    <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的測試類：

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

  5. 執(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

這一對注解從名字上就很好理解抑党，用在成員變量前面，相當于為成員變量生成對應的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)成員變量生成對應的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修飾的成員變量生成對應的構(gòu)造方法床佳。當然滋早，和前面幾個注解一樣，成員變量都是非靜態(tài)的砌们，另外杆麸，如果類中含有final修飾的成員變量，是無法使用@NoArgsConstructor注解的浪感。

三個注解都可以指定生成的構(gòu)造方法的訪問權(quán)限眯漩，同時擎值，第二個注解還可以用@RequiredArgsConstructor(staticName="methodName")的形式生成一個指定名稱的靜態(tài)方法矫付，返回一個調(diào)用相應的構(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)用相應的構(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);

參考資料

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末后德，一起剝皮案震驚了整個濱河市，隨后出現(xiàn)的幾起案子抄腔，更是在濱河造成了極大的恐慌，老刑警劉巖理张，帶你破解...
    沈念sama閱讀 211,123評論 6贊 490
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件赫蛇，死亡現(xiàn)場離奇詭異，居然都是意外死亡雾叭，警方通過查閱死者的電腦和手機悟耘，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,031評論 2贊 384
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來织狐，“玉大人暂幼，你說我怎么就攤上這事筏勒。” “怎么了旺嬉？”我有些...
    開封第一講書人閱讀 156,723評論 0贊 345
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵管行，是天一觀的道長。 經(jīng)常有香客問我邪媳，道長捐顷，這世上最難降的妖魔是什么？ 我笑而不...
    開封第一講書人閱讀 56,357評論 1贊 283
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任雨效，我火速辦了婚禮迅涮，結(jié)果婚禮上，老公的妹妹穿的比我還像新娘徽龟。我一直安慰自己叮姑，他們只是感情好，可當我...
    茶點故事閱讀 65,412評論 5贊 384
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布据悔。 她就那樣靜靜地躺著戏溺，像睡著了一般。 火紅的嫁衣襯著肌膚如雪屠尊。 梳的紋絲不亂的頭發(fā)上旷祸，一...
    開封第一講書人閱讀 49,760評論 1贊 289
  • 城市分裂傳說
    那天，我揣著相機與錄音讼昆，去河邊找鬼托享。 笑死，一個胖子當著我的面吹牛浸赫，可吹牛的內(nèi)容都是我干的闰围。 我是一名探鬼主播，決...
    沈念sama閱讀 38,904評論 3贊 405
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼既峡，長吁一口氣：“原來是場噩夢啊……” “哼羡榴！你這毒婦竟也來了？” 一聲冷哼從身側(cè)響起运敢，我...
    開封第一講書人閱讀 37,672評論 0贊 266
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤校仑，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后传惠，有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體迄沫，經(jīng)...
    沈念sama閱讀 44,118評論 1贊 303
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,456評論 2贊 325
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年卦方，在試婚紗的時候發(fā)現(xiàn)自己被綠了羊瘩。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,599評論 1贊 340
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖尘吗，靈堂內(nèi)的尸體忽然破棺而出逝她，到底是詐尸還是另有隱情，我是刑警寧澤睬捶，帶...
    沈念sama閱讀 34,264評論 4贊 328
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布黔宛，位于F島的核電站，受9級特大地震影響侧戴，放射性物質(zhì)發(fā)生泄漏宁昭。R本人自食惡果不足惜，卻給世界環(huán)境...
    茶點故事閱讀 39,857評論 3贊 312
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一酗宋、第九天 我趴在偏房一處隱蔽的房頂上張望积仗。 院中可真熱鬧，春花似錦蜕猫、人聲如沸寂曹。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,731評論 0贊 21
  • 一樁弒父案回右，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽隆圆。三九已至，卻和暖如春翔烁，著一層夾襖步出監(jiān)牢的瞬間渺氧，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,956評論 1贊 264
  • 情欲美人皮
    我被黑心中介騙來泰國打工蹬屹， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留侣背，地道東北人。 一個月前我還...
    沈念sama閱讀 46,286評論 2贊 360
  • 代替公主和親
    正文 我出身青樓慨默，卻偏偏與公主長得像贩耐，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子厦取，可洞房花燭夜當晚...
    茶點故事閱讀 43,465評論 2贊 348