Java 以其冗長而聞名，尤其是在處理重復(fù)的樣板代碼（如 getter、setter、構(gòu)造函數(shù)和 toString 方法）時。雖然有必要，但這種混亂會減慢開發(fā)速度，并使代碼更難以閱讀和維護。 Lombok 項目通過在編譯時自動生成樣板代碼來解決這個問題。

在本指南中，我們將深入探討為什么 Lombok 是 Java 中的必備工具、如何設(shè)置它，并深入幕后了解 Lombok 如何使用注釋處理來映射和修改 Java 的抽象語法樹（AST），確保我們的代碼簡潔而不犧牲功能。

為什么我們需要龍目島？

Java 需要大量的樣板代碼?？紤]一個簡單的 POJO，其中包括字段、構(gòu)造函數(shù)、getter、setter 和 toString 方法：

public class User {
    private String name;
    private int age;

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{name='" + name + "', age=" + age + '}';
    }
}

這對于小型項目來說是可以管理的，但隨著應(yīng)用程序規(guī)模的擴大，樣板文件很快就會變得不堪重負。

解決方案：龍目島

使用 Lombok，我們可以避免所有這些重復(fù)的代碼。這是同一個類在 Lombok 中的樣子：

import lombok.Data;

@Data
public class User {
    private String name;
    private int age;
}

只需一個注解，Lombok 就可以生成 getter、setter、toString、equals 和 hashCode 方法，使代碼更干凈、更易于維護。

如何設(shè)置龍目島

第1步：添加Lombok依賴

要在 Maven 項目中使用 Lombok，請將此依賴項添加到 pom.xml：

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

對于 Gradle：

compileOnly 'org.projectlombok:lombok:1.18.28'
annotationProcessor 'org.projectlombok:lombok:1.18.28'

第 2 步：IDE 設(shè)置

確保您的 IDE 已安裝 Lombok 插件。在 IntelliJ IDEA 中：

1.  Go to Settings > Plugins.
2.  Search for Lombok.
3.  Install the Lombok plugin.
4.  Enable annotation processing under Settings > Build, Execution, Deployment > Compiler > Annotation Processors.

Lombok 的工作原理：幕后花絮

注釋處理的力量

Lombok 使用 Java 注釋處理器與 Java 抽象語法樹 (AST) 進行交互。注釋處理器在編譯過程中分析并可能修改代碼的結(jié)構(gòu)。 Lombok 的注釋處理器利用它來生成 getter、setter 和 toString 等方法，在代碼編譯之前將它們直接插入到 AST 中。

理解抽象語法樹 (AST)

AST 是代碼的內(nèi)部表示，將源代碼分解為編譯器可以處理的結(jié)構(gòu)化樹。當(dāng)您編寫 Java 代碼時，每個元素（如類、字段、方法）都會映射到 AST 中的一個節(jié)點。

當(dāng)Lombok的注釋處理器遇到帶有Lombok注釋的類時，它會修改AST節(jié)點以將方法直接添加到樹中。這意味著樣板方法是在編譯期間生成的，而不是源代碼的一部分。當(dāng)代碼編譯時，它已經(jīng)添加了所有必要的方法，這就是它們無縫工作的原因。

時機：Lombok 何時以及如何生成代碼

Lombok 的注釋在編譯階段（解析 Java 源代碼和生成字節(jié)碼之間）進行處理。以下是分步過程：

public class User {
    private String name;
    private int age;

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{name='" + name + "', age=" + age + '}';
    }
}

因此，當(dāng)您運行代碼時，getter、setter 和其他方法看起來就像是原始源代碼的一部分，即使它們是在編譯時添加的。

Lombok 注解解釋

• @Getter 和 @Setter

這些注釋會為您的字段生成 getter 和 setter 方法，有效地節(jié)省您自己編寫它們的精力。

import lombok.Data;

@Data
public class User {
    private String name;
    private int age;
}

• @ToString

@ToString 生成一個 toString 方法，默認包含所有字段，并且可以選擇排除特定字段。

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

• @EqualsAndHashCode

生成 equals 和 hashCode 方法。這些方法對于比較對象以及在 HashMap 或 HashSet 等集合中使用它們至關(guān)重要。

compileOnly 'org.projectlombok:lombok:1.18.28'
annotationProcessor 'org.projectlombok:lombok:1.18.28'

• @NoArgsConstructor、@AllArgsConstructor 和 @RequiredArgsConstructor

這些注釋生成具有不同參數(shù)選項的構(gòu)造函數(shù)。

1.  Go to Settings > Plugins.
2.  Search for Lombok.
3.  Install the Lombok plugin.
4.  Enable annotation processing under Settings > Build, Execution, Deployment > Compiler > Annotation Processors.

1.  AST Creation: The compiler reads the Java source code and generates the AST.
2.  Annotation Processing: Lombok’s annotation processor scans the AST for Lombok annotations.
3.  AST Manipulation: When an annotation like @Getter or @Setter is found, Lombok adds nodes to the AST to represent the corresponding methods.
4.  Bytecode Generation: The modified AST is used to generate the final bytecode, which includes the methods added by Lombok.

• @數(shù)據(jù)

組合@Getter、@Setter、@ToString、@EqualsAndHashCode 和@RequiredArgsConstructor。

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class User {
    private String name;
    private int age;
}

• @Builder

實現(xiàn)構(gòu)建器模式，這對于構(gòu)造具有多個參數(shù)的復(fù)雜對象特別有用。

import lombok.ToString;

@ToString(exclude = ?password“)
public class User {
    private String name;
    private int age;
    private String password;
}

用法：

import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class User {
    private String name;
    private int age;
}

• @Slf4j（日志記錄）

提供 SLF4J Logger 實例，簡化日志記錄設(shè)置。

? @NoArgsConstructor: No-argument constructor.
? @AllArgsConstructor: Constructor with parameters for all fields.
? @RequiredArgsConstructor: Constructor for fields marked final or @NonNull.

Spring Boot 應(yīng)用程序中的 Lombok

Lombok 的功能在 Spring Boot 應(yīng)用程序中特別有用，在這些應(yīng)用程序中，樣板代碼可以輕松地累積在服務(wù)、存儲庫和模型中。以下是在 Spring Boot 服務(wù)中使用 Lombok 的示例：

import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.RequiredArgsConstructor;

@NoArgsConstructor
@AllArgsConstructor
@RequiredArgsConstructor
public class User {
    private final String name;
    private int age;
}

在此示例中：

import lombok.Data;

@Data
public class User {
    private String name;
    private int age;
}

結(jié)論

Lombok 對于 Java 開發(fā)人員來說是一個非常寶貴的工具。它顯著減少了樣板代碼，保持類干凈，并提高了生產(chǎn)力。通過使用注解處理來操作 AST，Lombok 在編譯期間直接注入方法，在不影響功能的情況下確保代碼簡潔。

與 Spring Boot 結(jié)合使用時，Lombok 進一步簡化了開發(fā)。 @Data、@Builder 和 @Slf4j 等注釋提供了一種強大的方法來編寫干凈、可維護的代碼，并且易于擴展和調(diào)試。

如果您使用 Java，Lombok 是您工具包中的必備工具。當(dāng) Lombok 可以處理時，為什么要編寫不必要的代碼呢？

以上是使用 Project Lombok 增強 Java：簡化您的代碼，提高您的工作效率的詳細內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！