介紹

Lombok 是一個(gè)充當(dāng) Java 注釋處理器的庫，旨在消除代碼中的冗余。它的主要功能是自動(dòng)生成重復(fù)代碼或“樣板文件”——這些元素雖然必要，但不會(huì)為我們的程序邏輯添加直接價(jià)值。主要用于在編譯時(shí)自動(dòng)生成 getter 和 setter 方法、構(gòu)造函數(shù)、equals()、hashCode()、toString() 方法以及 Java 類中的其他常見元素。

無需為這些基本功能手動(dòng)編寫數(shù)十行代碼，Lombok 允許您使用簡(jiǎn)單的注釋來定義它們，從而產(chǎn)生更干凈、更易于維護(hù)且不易出錯(cuò)的代碼。

設(shè)施

要在Java項(xiàng)目中使用Lombok，除了安裝之外，還需要在pom.xml文件（如果是Maven項(xiàng)目）或build.gradle（如果是Gradle項(xiàng)目）中添加相應(yīng)的依賴我們正在使用的IDE中的相應(yīng)插件。在這篇文章中，我們將使用 Maven 和 IntelliJ IDEA 作為示例。

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.36</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

如有任何疑問，您可以隨時(shí)查看Lombok的官方文檔：

• Lombok 與 Maven
• IntelliJ IDEA 中的 Lombok

@數(shù)據(jù)

當(dāng)我們創(chuàng)建一個(gè)類時(shí)，我們會(huì)定期執(zhí)行以下操作，無論是手動(dòng)還是使用 IDE 提供的快捷方式：

• 封裝屬性并生成其getter和setter方法
• 生成一個(gè)空的構(gòu)造函數(shù)和另一個(gè)接收所有屬性的
• 實(shí)現(xiàn) equals()、hashCode() 和 toString() 方法

嗯，Lombok 有 @Data 注釋，它允許我們?cè)谝恍兄型瓿伤羞@些操作，生成與 POJO（普通舊 Java 對(duì)象） 相關(guān)的所有內(nèi)容。這個(gè)注解是 @Getter、@Setter、@EqualsAndHashCode、@NoArgsConstructor 和 @AllArgsConstructor 注解的組合，我們稍后會(huì)看到。

import lombok.Data;

@Data
public class Persona {
    private String nombre;
}

public class Main {
    public static void main(String[] args) {
        Persona p1 = new Persona();
        p2.setNombre("Maria");

        System.out.println(p1.getNombre());
    }
}

@NoArgsConstructor、@AllArgsConstructor 和 @RequiredArgsConstructor

這些注釋允許我們自動(dòng)生成具有不同參數(shù)組合的構(gòu)造函數(shù)，考慮到屬性是根據(jù)它們?cè)陬愔新暶鞯捻樞蚴褂玫摹?/p>

• @NoArgsConstructor：生成一個(gè)無參構(gòu)造函數(shù)（空），如果無法生成，則會(huì)拋出異常，為了避免這種情況，只需使用如下注解 @NoArgsConstructor(force = true)。
• @AllArgsConstructor：生成一個(gè)構(gòu)造函數(shù)，以類的所有屬性作為參數(shù)。
• @RequiredArgsConstructor：為所有最終字段生成構(gòu)造函數(shù)和/或用 @NonNull 注釋進(jìn)行標(biāo)記。

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.36</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

@Getter 和 @setter

這些注解可以讓我們自動(dòng)為類的所有屬性生成 getter 和 setter 方法，或者只為那些標(biāo)有相應(yīng)注解的屬性生成 getter 和 setter 方法，即可以在類或?qū)傩约?jí)別使用。

import lombok.Data;

@Data
public class Persona {
    private String nombre;
}

public class Main {
    public static void main(String[] args) {
        Persona p1 = new Persona();
        p2.setNombre("Maria");

        System.out.println(p1.getNombre());
    }
}

@ToString

該注解自動(dòng)生成 toString() 方法，該方法返回類及其屬性的字符串表示形式，格式如下：ClassName(attribute1=value1, attribute2=value2, ...)。默認(rèn)情況下，類的所有非靜態(tài)屬性都包含在結(jié)果中，但可以使用 @ToString.Exclude 屬性排除特定屬性。如果您只想顯示屬性的值而不是聲明的名稱，可以使用 @ToString(includeFieldNames = false)。

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Persona {
    private String nombre;
}

@EqualsAndHashCode

允許您從類的所有屬性生成 equals() 和 hashCode() 方法，如果您想排除或包含某個(gè)屬性，可以使用注釋 @EqualsAndHashCode.Exclude 和 @EqualsAndHashCode.Include 來實(shí)現(xiàn)。分別。

import lombok.*;

@Getter
@Setter
public class Persona {
    private String nombre;
    private String apellido;
}

@價(jià)值

以前，在 Java 中創(chuàng)建不可變類需要執(zhí)行一系列步驟，例如使類和/或?qū)傩猿蔀樽罱K類型，并且不會(huì)生成 setter 方法。 Lombok 使我們可以輕松地使用 @Value 注解創(chuàng)建不可變類，該注解結(jié)合了 @Getter、@ToString、@EqualsAndHashCode 和 @AllArgsConstructor 注解來生成不可變類。所有屬性都標(biāo)記為 private Final，并且不會(huì)生成 setter 方法。它是 @Data 的不可變變體。

import lombok.*;

public class Persona {
    @Getter @Setter
    private String nombre;
    private String apellido;
}

在 Java 的最新版本中，與使用記錄相比，此注釋失去了意義，因?yàn)樗鼈兙哂邢嗤哪康?，并且使用記錄更?shí)用。如果您有興趣了解更多有關(guān)此主題的信息，博客上還有更多有關(guān)記錄的帖子。

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.36</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

@val

這個(gè)注解允許我們將一個(gè)變量聲明為final并自動(dòng)推斷它的數(shù)據(jù)類型，也就是說，不需要指定變量的數(shù)據(jù)類型，Lombok會(huì)負(fù)責(zé)推斷它。如果變量數(shù)據(jù)類型很長(zhǎng)或很復(fù)雜，它很有用，這樣可以避免重復(fù)。

import lombok.Data;

@Data
public class Persona {
    private String nombre;
}

如果我們直接使用final var或者簡(jiǎn)單的var進(jìn)行類型推斷，這個(gè)注解可能會(huì)失去意義，因?yàn)檫@是語言的特性，這樣更方便。如果您有興趣了解更多，可以參考以下帖子

public class Main {
    public static void main(String[] args) {
        Persona p1 = new Persona();
        p2.setNombre("Maria");

        System.out.println(p1.getNombre());
    }
}

@var

它的工作方式與@val完全相同，但它不將變量聲明為final，它只是推斷其類型。有必要考慮類型推斷的概念，因?yàn)槟荒苈暶?String 類型的內(nèi)容，并且想要為其分配 int 類型的值也不是最終的。同樣，在最新版本的 Java 中，該注釋被 var 取代。

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Persona {
    private String nombre;
}

@非空

這個(gè)注解可以用在類的屬性和方法的參數(shù)上，它基本上表明屬性的值不能為空，如果嘗試將空值分配給標(biāo)記為@NonNull的屬性，它會(huì)拋出 NullPointerException，即使用 if (param == null) throw new NullPointerException("param is tagged non-null but is null"); 。無論它生成什么異常，它的使用在 IDE 本身中都更加明顯，因?yàn)樗鼤?huì)以某種方式向我們表明該值不能為空。

import lombok.*;

@Getter
@Setter
public class Persona {
    private String nombre;
    private String apellido;
}

@清理

此注釋允許我們確保任何使用它的資源（如果它具有 close() 方法或?qū)崿F(xiàn) AutoCloseable 或 Closeable 接口）都會(huì)在其所在代碼塊的末尾自動(dòng)關(guān)閉。它在處理需要釋放的資源時(shí)非常有用，例如文件、數(shù)據(jù)庫連接等。

import lombok.*;

public class Persona {
    @Getter @Setter
    private String nombre;
    private String apellido;
}

如果我們使用資源嘗試，可以手動(dòng)獲得此結(jié)果。

import lombok.*;

@AllArgsConstructor
@ToString
public class Persona {
    private String nombre;
    @ToString.Exclude
    private String apellido;
}

// Output: Persona(nombre=Maria)

@builder

這個(gè)注解可以讓我們自動(dòng)生成一個(gè)設(shè)計(jì)模式Builder，即一個(gè)可以讓我們一步步構(gòu)建復(fù)雜對(duì)象的對(duì)象，這樣就可以配置一個(gè)對(duì)象的不同屬性，而無需調(diào)用帶有多個(gè)參數(shù)的構(gòu)造函數(shù)。如果一個(gè)類有很多屬性并且我們不希望有一個(gè)帶有很多參數(shù)的構(gòu)造函數(shù)，那么它很有用。

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.36</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

@和

這個(gè)注解允許我們創(chuàng)建一個(gè)方法，該方法返回帶有修改屬性的當(dāng)前對(duì)象的副本，即它生成一個(gè)方法 withAttributeName(Object object) ，該方法允許我們用該對(duì)象創(chuàng)建當(dāng)前對(duì)象的副本屬性由我們作為參數(shù)傳遞的值修改。當(dāng)我們想要修改對(duì)象的屬性而不修改原始對(duì)象時(shí)，它非常有用。

import lombok.Data;

@Data
public class Persona {
    private String nombre;
}

public class Main {
    public static void main(String[] args) {
        Persona p1 = new Persona();
        p2.setNombre("Maria");

        System.out.println(p1.getNombre());
    }
}

到目前為止，我們已經(jīng)看到了一些最常用的注釋，每個(gè)注釋可能接受也可能不接受額外的配置，同樣還有其他注釋被標(biāo)記為實(shí)驗(yàn)性的，無論如何，參考很重要官方文檔，以充分利用 Lombok 為我們提供的所有功能以及重復(fù)代碼生成方面的優(yōu)勢(shì)。

以上是Java 中的 Lombok 項(xiàng)目的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！