Lombok的基本使用

以前的Java項(xiàng)目中杨耙,充斥著太多不友好的代碼:POJO的getter/setter/toString衬廷;異常處理鲤氢;I/O流的關(guān)閉操作等等搀擂,這些樣板代碼既沒(méi)有技術(shù)含量,又影響著代碼的美觀卷玉,Lombok應(yīng)運(yùn)而生哨颂。

為什么推薦使用Lombok:

@Lombok有啥牛皮的?SpringBoot和IDEA官方都要支持它相种!

最近IDEA 2020最后一個(gè)版本發(fā)布了威恼,已經(jīng)內(nèi)置了Lombok插件,SpringBoot 2.1.x之后的版本也在Starter中內(nèi)置了Lombok依賴寝并。為什么他們都要支持Lombok呢箫措?今天我來(lái)講講Lombok的使用,看看它有何神奇之處食茎!

任何技術(shù)的出現(xiàn)都是為了解決某一類問(wèn)題蒂破,如果在此基礎(chǔ)上再建立奇技淫巧,不如回歸Java本身别渔,應(yīng)該保持合理使用而不濫用。

Lombok的使用非常簡(jiǎn)單:

1)引入相應(yīng)的maven包

????<dependency>

? ????????<groupId>org.projectlombok</groupId>

? ????????<artifactId>lombok</artifactId>

? ????????<version>1.16.18</version>

????????? <scope>provided</scope>

????</dependency>

Lombok的scope=provided惧互,說(shuō)明它只在編譯階段生效哎媚,不需要打入包中。事實(shí)正是如此喊儡,Lombok在編譯期將帶Lombok注解的Java文件正確編譯為完整的Class文件拨与。

2)添加IDE工具對(duì)Lombok的支持

????IDEA中引入Lombok支持如下:

????點(diǎn)擊File-- Settings設(shè)置界面,安裝Lombok插件:



點(diǎn)擊File-- Settings設(shè)置界面艾猜,開(kāi)啟 AnnocationProcessors:

開(kāi)啟該項(xiàng)是為了讓Lombok注解在編譯階段起到作用买喧。

Eclipse的Lombok插件安裝可以自行百度捻悯,也比較簡(jiǎn)單,值得一提的是淤毛,由于Eclipse內(nèi)置的編譯器不是Oracle javac今缚,而是eclipse自己實(shí)現(xiàn)的Eclipse Compiler for Java (ECJ).要讓ECJ支持Lombok,需要在eclipse.ini配置文件中添加如下兩項(xiàng)內(nèi)容:

????-Xbootclasspath/a:[lombok.jar所在路徑

3)Lombok實(shí)現(xiàn)原理

自從Java 6起低淡,javac就支持“JSR 269 Pluggable Annotation Processing API”規(guī)范姓言,只要程序?qū)崿F(xiàn)了該API,就能在javac運(yùn)行的時(shí)候得到調(diào)用蔗蹋。

Lombok就是一個(gè)實(shí)現(xiàn)了"JSR 269 API"的程序何荚。在使用javac的過(guò)程中,它產(chǎn)生作用的具體流程如下:


1. javac對(duì)源代碼進(jìn)行分析猪杭,生成一棵抽象語(yǔ)法樹(shù)(AST)

2. javac編譯過(guò)程中調(diào)用實(shí)現(xiàn)了JSR 269的Lombok程序

3. 此時(shí)Lombok就對(duì)第一步驟得到的AST進(jìn)行處理餐塘,找到Lombok注解所在類對(duì)應(yīng)的語(yǔ)法樹(shù)? ?????(AST),然后修改該語(yǔ)法樹(shù)(AST)皂吮,增加Lombok注解定義的相應(yīng)樹(shù)節(jié)點(diǎn)

4. javac使用修改后的抽象語(yǔ)法樹(shù)(AST)生成字節(jié)碼文件


4)?Lombok注解的使用

POJO類常用注解:

@Getter/@Setter: 作用類上唠倦,生成所有成員變量的getter/setter方法;作用于成員變量上涮较,生成該成員變量的getter/setter方法稠鼻。可以設(shè)定訪問(wèn)權(quán)限及是否懶加載等狂票。

package com.kaplan.pojo;

import lombok.*;

import lombok.extern.log4j.Log4j;

@Getter

@Setter

public class TestDemo {

private String name;

private int age ; private String email;

private String address; private String password;

@Getter @Setter private boolean funny;

}

@ToString:作用于類候齿,覆蓋默認(rèn)的toString()方法,可以通過(guò)of屬性限定顯示某些字段闺属,通過(guò)exclude屬性排除某些字段慌盯。


@EqualsAndHashCode:作用于類,覆蓋默認(rèn)的equals和hashCode

@NonNull:主要作用于成員變量和參數(shù)中掂器,標(biāo)識(shí)不能為空亚皂,否則拋出空指針異常。

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor:作用于類上国瓮,用于生成構(gòu)造函數(shù)灭必。有staticName、access等屬性乃摹。

staticName屬性一旦設(shè)定禁漓,將采用靜態(tài)方法的方式生成實(shí)例,access屬性可以限定訪問(wèn)權(quán)限孵睬。

@NoArgsConstructor:生成無(wú)參構(gòu)造器播歼;

@RequiredArgsConstructor:生成包含final和@NonNull注解的成員變量的構(gòu)造器;

@AllArgsConstructor:生成全參構(gòu)造器

@Data:作用于類上掰读,是以下注解的集合:@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

@Builder:作用于類上秘狞,將類轉(zhuǎn)變?yōu)榻ㄔ煺吣J?/b>

@Log:作用于類上叭莫,生成日志變量。針對(duì)不同的日志實(shí)現(xiàn)產(chǎn)品烁试,有不同的注解:

其他重要注解:

@Cleanup:自動(dòng)關(guān)閉資源雇初,針對(duì)實(shí)現(xiàn)了java.io.Closeable接口的對(duì)象有效,如:典型的IO流對(duì)象

編譯后結(jié)果如下:

@SneakyThrows:可以對(duì)受檢異常進(jìn)行捕捉并拋出廓潜,可以改寫(xiě)上述的main方法如下:

@Synchronized:作用于方法級(jí)別抵皱,可以替換synchronize關(guān)鍵字或lock鎖,用處不大.

@作者原文

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末辩蛋,一起剝皮案震驚了整個(gè)濱河市呻畸,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌悼院,老刑警劉巖伤为,帶你破解...
    沈念sama閱讀 217,542評(píng)論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異据途,居然都是意外死亡绞愚,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門(mén)颖医,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)位衩,“玉大人,你說(shuō)我怎么就攤上這事熔萧√锹浚” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 163,912評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵佛致,是天一觀的道長(zhǎng)贮缕。 經(jīng)常有香客問(wèn)我,道長(zhǎng)俺榆,這世上最難降的妖魔是什么感昼? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,449評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮罐脊,結(jié)果婚禮上定嗓,老公的妹妹穿的比我還像新娘。我一直安慰自己爹殊,他們只是感情好蜕乡,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,500評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著梗夸,像睡著了一般。 火紅的嫁衣襯著肌膚如雪号醉。 梳的紋絲不亂的頭發(fā)上反症,一...
    開(kāi)封第一講書(shū)人閱讀 51,370評(píng)論 1 302
  • 那天辛块,我揣著相機(jī)與錄音,去河邊找鬼铅碍。 笑死润绵,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的胞谈。 我是一名探鬼主播尘盼,決...
    沈念sama閱讀 40,193評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼烦绳!你這毒婦竟也來(lái)了卿捎?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,074評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤径密,失蹤者是張志新(化名)和其女友劉穎午阵,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體享扔,經(jīng)...
    沈念sama閱讀 45,505評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡底桂,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,722評(píng)論 3 335
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了惧眠。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片籽懦。...
    茶點(diǎn)故事閱讀 39,841評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖氛魁,靈堂內(nèi)的尸體忽然破棺而出暮顺,到底是詐尸還是另有隱情,我是刑警寧澤呆盖,帶...
    沈念sama閱讀 35,569評(píng)論 5 345
  • 正文 年R本政府宣布拖云,位于F島的核電站,受9級(jí)特大地震影響应又,放射性物質(zhì)發(fā)生泄漏宙项。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,168評(píng)論 3 328
  • 文/蒙蒙 一株扛、第九天 我趴在偏房一處隱蔽的房頂上張望尤筐。 院中可真熱鬧,春花似錦洞就、人聲如沸盆繁。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,783評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)油昂。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間冕碟,已是汗流浹背拦惋。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,918評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留安寺,地道東北人厕妖。 一個(gè)月前我還...
    沈念sama閱讀 47,962評(píng)論 2 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像挑庶,于是被迫代替她去往敵國(guó)和親言秸。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,781評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容