使用 Project Lombok 增強 Java：簡化您的程式碼，提高您的工作效率

Java 以其冗長而聞名，尤其是在處理重複的樣板程式碼（如 getter、setter、建構子和 toString 方法）時。雖然有必要，但這種混亂會減慢開發速度，並使程式碼更難以閱讀和維護。 Lombok 專案透過在編譯時自動產生樣板程式碼來解決這個問題。

在本指南中，我們將深入探討為什麼Lombok 是Java 中的必備工具、如何設定它，並深入幕後了解Lombok 如何使用註釋處理來映射和修改Java 的抽象語法樹（AST），確保我們的程式碼簡潔而不犧牲功能。

為什麼我們需要龍目島？

Java 需要大量的樣板程式碼。考慮一個簡單的 POJO，其中包括欄位、建構子、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 + '}';
    }
}

這對於小型專案來說是可以管理的，但隨著應用程式規模的擴大，樣板檔案很快就會變得不堪重負。

解：龍目島

使用 Lombok，我們可以避免所有這些重複的程式碼。這是同一個類別在 Lombok 中的樣子：

import lombok.Data;

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

只需一個註解，Lombok 就可以產生 getter、setter、toString、equals 和 hashCode 方法，讓程式碼更乾淨、更易於維護。

如何設定龍目島

第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 設定

確保您的 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) 互動。註解處理器在編譯過程中分析並可能修改程式碼的結構。 Lombok 的註解處理器利用它來產生 getter、setter 和 toString 等方法，在程式碼編譯之前將它們直接插入 AST 中。

理解抽象語法樹 (AST)

AST 是程式碼的內部表示，將原始碼分解為編譯器可以處理的結構化樹。當您編寫 Java 程式碼時，每個元素（如類別、欄位、方法）都會對應到 AST 中的一個節點。

當Lombok的註解處理器遇到帶有Lombok註解的類別時，它會修改AST節點以將方法直接添加到樹中。這意味著樣板方法是在編譯期間產生的，而不是原始碼的一部分。當程式碼編譯時，它已經添加了所有必要的方法，這就是它們無縫工作的原因。

時機：Lombok 何時以及如何產生程式碼

Lombok 的註解在編譯階段（解析 Java 原始碼和產生字節碼之間）進行處理。以下是逐步過程：

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 + '}';
    }
}

因此，當您執行程式碼時，getter、setter 和其他方法看起來就像是原始原始碼的一部分，即使它們是在編譯時添加的。

Lombok 註解解釋

• @Getter 和 @Setter

這些註解會為您的欄位產生 getter 和 setter 方法，有效地節省您自己編寫它們的精力。

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 等集合中使用它們至關重要。

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

• @NoArgsConstructor、@AllArgsConstructor 和 @RequiredArgsConstructor

這些註解產生具有不同參數選項的建構子。

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.

• @數據

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

import lombok.Getter;
import lombok.Setter;

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

• @Builder

實作建構器模式，這對於建構具有多個參數的複雜物件特別有用。

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 實例，簡化日誌記錄設定。

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

Spring Boot 應用程式中的 Lombok

Lombok 的功能在 Spring Boot 應用程式中特別有用，在這些應用程式中，樣板程式碼可以輕鬆累積在服務、儲存庫和模型中。以下是在 Spring Boot 服務中使用 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;
}

結論

Lombok 對 Java 開發人員來說是一個非常寶貴的工具。它顯著減少了樣板程式碼，保持類別乾淨，並提高了生產力。透過使用註解處理來操作 AST，Lombok 在編譯期間直接注入方法，在不影響功能的情況下確保程式碼簡潔。

與 Spring Boot 結合使用時，Lombok 進一步簡化了開發。 @Data、@Builder 和 @Slf4j 等註釋提供了一種強大的方法來編寫乾淨、可維護的程式碼，並且易於擴展和調試。

如果您使用 Java，Lombok 是您工具包中的必備工具。當 Lombok 可以處理時，為什麼要寫不必要的程式碼呢？

以上是使用 Project Lombok 增強 Java：簡化您的程式碼，提高您的工作效率的詳細內容。更多資訊請關注PHP中文網其他相關文章！