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

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

Lombok是一個可以通過簡單的注解形式來幫助我們簡化消除一些必須有但顯得很臃腫的Java代碼的工具，通過使用對應的注解，可以在編譯源碼的時候生成對應的方法，本文重點給大家介紹IDEA中安裝和使用Lombok插件的方法，感興趣的朋友一起看看吧

背景

我們在開發(fā)過程中，通常都會定義大量的JavaBean，然后通過IDE去生成其屬性的構造器、getter、setter、equals、hashcode、toString方法，當要對某個屬性進行改變時，比如命名、類型等，都需要重新去生成上面提到的這些方法，那Java中有沒有一種方式能夠避免這種重復的勞動呢？答案是有，我們來看一下下面這張圖，右面是一個簡單的JavaBean，只定義了兩個屬性，在類上加上了@Data，從左面的結構圖上可以看到，已經自動生成了上面提到的方法。

Lombok簡介

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

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

Lombok使用

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

在Maven項目的pom.xml中添加配置：

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

注解介紹

下面只是介紹了幾個常用的注解，更多的請參見：https://projectlombok.org/features/index.html。

@Getter / @Setter

可以作用在類上和屬性上，放在類上，會對所有的非靜態(tài)（non-static）屬性生成Getter/Setter方法，放在屬性上，會對該屬性生成Getter/Setter方法。并可以指定Getter/Setter方法的訪問級別。

@EqualsAndHashCode

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

@ToString

生成toString方法，默認情況下，會輸出類名、所有屬性，屬性會按照順序輸出，以逗號分割。

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

無參構造器、部分參數(shù)構造器、全參構造器，當我們需要重載多個構造器的時候，Lombok就無能為力了。

@Data

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

Lombok原理

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

運行時解析

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

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