快捷導(dǎo)航

IDEA中安裝和使用Lombok插件的方法

更新時(shí)間：2021年06月03日 10:19:44 作者：魏曉蕾

Lombok是一個(gè)可以通過(guò)簡(jiǎn)單的注解形式來(lái)幫助我們簡(jiǎn)化消除一些必須有但顯得很臃腫的Java代碼的工具，通過(guò)使用對(duì)應(yīng)的注解，可以在編譯源碼的時(shí)候生成對(duì)應(yīng)的方法，本文重點(diǎn)給大家介紹IDEA中安裝和使用Lombok插件的方法，感興趣的朋友一起看看吧

背景

我們?cè)陂_(kāi)發(fā)過(guò)程中，通常都會(huì)定義大量的JavaBean，然后通過(guò)IDE去生成其屬性的構(gòu)造器、getter、setter、equals、hashcode、toString方法，當(dāng)要對(duì)某個(gè)屬性進(jìn)行改變時(shí)，比如命名、類(lèi)型等，都需要重新去生成上面提到的這些方法，那Java中有沒(méi)有一種方式能夠避免這種重復(fù)的勞動(dòng)呢？答案是有，我們來(lái)看一下下面這張圖，右面是一個(gè)簡(jiǎn)單的JavaBean，只定義了兩個(gè)屬性，在類(lèi)上加上了@Data，從左面的結(jié)構(gòu)圖上可以看到，已經(jīng)自動(dòng)生成了上面提到的方法。

Lombok簡(jiǎn)介

ombok是一個(gè)可以通過(guò)簡(jiǎn)單的注解的形式來(lái)幫助我們簡(jiǎn)化消除一些必須有但顯得很臃腫的 Java 代碼的工具，簡(jiǎn)單來(lái)說(shuō)，比如我們新建了一個(gè)類(lèi)，然后在其中寫(xiě)了幾個(gè)字段，然后通常情況下我們需要手動(dòng)去建立get、set、構(gòu)造方法、log、toString、hashCode、equals等等，尤其是一個(gè)類(lèi)有幾十個(gè)屬性時(shí)，那個(gè)長(zhǎng)長(zhǎng)的get、set方法真的是慘不忍睹。lombok的作用就是為了省去我們手動(dòng)創(chuàng)建這些代碼的麻煩，它能夠在我們編譯源碼的時(shí)候自動(dòng)幫我們生成這些方法。

官方地址：https://projectlombok.org/，github地址：https://github.com/rzwitserloot/lombok。

Lombok使用

IDEA中添加Lombok插件, File -> Setting -> Plugins 搜索Lombok Plugin，點(diǎn)擊install，安裝完成后重啟IDEA。

在Maven項(xiàng)目的pom.xml中添加配置：

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

注解介紹

下面只是介紹了幾個(gè)常用的注解，更多的請(qǐng)參見(jiàn)：https://projectlombok.org/features/index.html。

@Getter / @Setter

可以作用在類(lèi)上和屬性上，放在類(lèi)上，會(huì)對(duì)所有的非靜態(tài)（non-static）屬性生成Getter/Setter方法，放在屬性上，會(huì)對(duì)該屬性生成Getter/Setter方法。并可以指定Getter/Setter方法的訪(fǎng)問(wèn)級(jí)別。

@EqualsAndHashCode

默認(rèn)情況下，會(huì)使用所有非瞬態(tài)（non-transient）和非靜態(tài)（non-static）字段來(lái)生成equals和hascode方法，也可以指定具體使用哪些屬性。

@ToString

生成toString方法，默認(rèn)情況下，會(huì)輸出類(lèi)名、所有屬性，屬性會(huì)按照順序輸出，以逗號(hào)分割。

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

無(wú)參構(gòu)造器、部分參數(shù)構(gòu)造器、全參構(gòu)造器，當(dāng)我們需要重載多個(gè)構(gòu)造器的時(shí)候，Lombok就無(wú)能為力了。

@Data

@ToString, @EqualsAndHashCode, 所有屬性的@Getter, 所有non-final屬性的@Setter和@RequiredArgsConstructor的組合，通常情況下，我們使用這個(gè)注解就足夠了。

Lombok原理

了解了簡(jiǎn)單的使用之后，現(xiàn)在應(yīng)該比較好奇它是如何實(shí)現(xiàn)的。整個(gè)使用的過(guò)程中，只需要使用注解而已，不需要做其它額外的工作，那玄妙之處應(yīng)該是在注解的解析上。JDK5引入了注解的同時(shí)，也提供了兩種解析方式。

運(yùn)行時(shí)解析

運(yùn)行時(shí)能夠解析的注解，必須將@Retention設(shè)置為RUNTIME，這樣可以通過(guò)反射拿到該注解。java.lang.reflect反射包中提供了一個(gè)接口AnnotatedElement，該接口定義了獲取注解信息的幾個(gè)方法，Class、Constructor、Field、Method、Package等都實(shí)現(xiàn)了該接口，大部分開(kāi)發(fā)者應(yīng)該都很熟悉這種解析方式。

boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
<T extends Annotation> T getAnnotation(Class<T> annotationClass);
Annotation[] getAnnotations();
Annotation[] getDeclaredAnnotations();