Java中Lombok工具庫使用的技術指南
1、簡述
Lombok 是 Java 開發(fā)中常用的工具庫，通過注解的方式大大簡化了代碼開發(fā)，尤其是在 Getter/Setter、構造方法、日志工具 等常見場景中，能夠極大地減少樣板代碼 (boilerplate)。本篇文章將從基礎入門到高級用法，深入講解 Lombok 的使用技巧和注意事項。
2、什么是 Lombok
Lombok 是一個 Java 注解處理工具，主要通過 編譯時注解 自動生成代碼。開發(fā)者在代碼中添加簡短的注解，Lombok 就能自動為類生成常見方法，從而減少冗余代碼，提高開發(fā)效率。
主要功能
- 自動生成 Getter/Setter。
- 生成 equals、hashCode、toString。
- 構造器的自動生成。
- 支持 Builder 模式。
- 集成日志工具。
- 提供高級功能，如鏈式調(diào)用、自定義訪問級別等。
2.1 Maven 依賴
在項目的 pom.xml 中引入 Lombok：
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.30</version>
<scope>provided</scope>
</dependency>
注意: provided 表示 Lombok 僅在編譯時有效，運行時不需要依賴它。
2.2 IDE 配置
大部分 IDE（如 IntelliJ IDEA、Eclipse）都支持 Lombok，但需要安裝插件：
IntelliJ IDEA: 在插件市場中搜索 Lombok 并安裝。
Eclipse: 下載并安裝 Lombok jar 文件，運行 java -jar lombok.jar 進行配置。
3、基礎用法
3.1 自動生成 Getter 和 Setter
Lombok 的 @Getter 和 @Setter 注解會自動為類的字段生成 getXXX 和 setXXX 方法。
import lombok.Getter;
import lombok.Setter;
public class User {
@Getter @Setter
private String name;
@Getter @Setter
private int 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; }
3.2 構造器注解
- @NoArgsConstructor：生成無參構造器。
- @AllArgsConstructor：生成包含所有字段的構造器。
- @RequiredArgsConstructor：生成包含 final 字段的構造器。
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
import lombok.RequiredArgsConstructor;
@NoArgsConstructor
@AllArgsConstructor
@RequiredArgsConstructor
public class User {
private final String id;
private String name;
private int age;
}
3.3 @ToString 和 @EqualsAndHashCode
@ToString：生成 toString 方法，自動包含類中的字段。
@EqualsAndHashCode：生成 equals 和 hashCode 方法。
import lombok.EqualsAndHashCode;
import lombok.ToString;
@ToString
@EqualsAndHashCode
public class User {
private String name;
private int age;
}
3.4 @Data 注解
@Data 是一個組合注解，相當于以下 注解的合集：
- @Getter
- @Setter
- @ToString
- @EqualsAndHashCode
- @RequiredArgsConstructor
import lombok.Data;
@Data
public class User {
private String name;
private int age;
}
4、高級用法
4.1 Builder 模式
Lombok 提供了 @Builder 注解來自動生成 Builder 模式的代碼，適用于需要構建復雜對象的場景。
import lombok.Builder;
import lombok.ToString;
@Builder
@ToString
public class User {
private String name;
private int age;
private String address;
}
使用方式：
User user = User.builder()
.name("John")
.age(30)
.address("New York")
.build();
System.out.println(user);
4.2 日志注解
Lombok 提供了多種日志注解，自動為類注入對應的日志工具：
@Slf4j：注入 SLF4J 日志對象。
@Log4j2：注入 Log4j2 日志對象。
@CommonsLog：注入 Commons Logging 日志對象。
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class LoggingExample {
public static void main(String[] args) {
log.info("This is an info log.");
log.error("This is an error log.");
}
}
4.3 鏈式調(diào)用
通過 @Accessors(fluent = true, chain = true)，可以生成鏈式調(diào)用的 Setter 方法。
import lombok.Getter;
import lombok.Setter;
import lombok.experimental.Accessors;
@Getter
@Setter
@Accessors(chain = true)
public class User {
private String name;
private int age;
}
使用方式：
User user = new User().setName("John").setAge(30);
System.out.println(user.getName());
4.4 自定義 Getter 和 Setter 的訪問級別
可以通過 @Getter 和 @Setter 的 AccessLevel 屬性設置訪問級別（如 PUBLIC、PRIVATE）。
import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
public class User {
@Getter
@Setter(AccessLevel.PRIVATE)
private String name;
}
4.5 @Value：不可變對象
@Value 注解會將類標記為不可變對象，相當于：
- 所有字段為 private final。
- 類為 final。
- 自動生成 Getter。
import lombok.Value;
@Value
public class ImmutableUser {
String name;
int age;
}
4.6 @SneakyThrows：異常處理
@SneakyThrows 注解會自動將受檢異常（Checked Exception）包裝為運行時異常。
import lombok.SneakyThrows;
public class SneakyThrowsExample {
@SneakyThrows
public void readFile() {
throw new Exception("Checked Exception");
}
}
4.7 實驗性功能：@With
@With 注解可以用于生成 不可變對象的復制方法，用于替換某些字段。
import lombok.Value;
import lombok.With;
@Value
public class User {
@With private String name;
private int age;
}
使用方式：
User user1 = new User("John", 30);
User user2 = user1.withName("Doe");
???????System.out.println(user1); // User(name=John, age=30)
System.out.println(user2); // User(name=Doe, age=30)
5、總結
Lombok 是簡化 Java 開發(fā)中樣板代碼的神器，其注解如 @Getter、@Setter、@Builder 等能顯著提升編碼效率。此外，像 @Value 和 @With 這樣的高級功能，為構建不可變對象提供了便利。
在日常開發(fā)中，合理使用 Lombok，不僅能讓代碼更加簡潔、優(yōu)雅，也能提高團隊的開發(fā)效率。不過，在一些需要明確代碼邏輯的關鍵場景下，仍需謹慎使用，以避免可讀性問題。
到此這篇關于Java中Lombok工具庫使用的技術指南的文章就介紹到這了,更多相關Java Lombok庫內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
SpringMVC框架中使用Filter實現(xiàn)請求日志打印方式
這篇文章主要介紹了SpringMVC框架中使用Filter實現(xiàn)請求日志打印方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-10-10
這篇文章主要介紹了@RequestBody時第二個字母大寫，映射不到的解決方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
SpringBoot Jackson日期格式化統(tǒng)一配置的實現(xiàn)
Spring項目中經(jīng)常需要配置日期時間格式格式,本文主要介紹了SpringBoot Jackson日期格式化統(tǒng)一配置的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2023-08-08
springboot中使用Feign整合nacos,gateway進行微服務之間的調(diào)用方法
這篇文章主要介紹了springboot中使用Feign整合nacos,gateway進行微服務之間的調(diào)用方法,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-03-03
這篇文章主要介紹了Java System.setProperty()用法詳解,本篇文章通過簡要的案例,講解了該項技術的了解與使用,以下就是詳細內(nèi)容,需要的朋友可以參考下2021-08-08
Java的集合類型都是對java.util包中Collection接口的繼承,這里我們主要介紹依賴于collection的一些主分支,一起來看一下Java中的collection集合類型總結2021-08-08
解決異常:Invalid?keystore?format,springboot配置ssl證書格式不合法問題
這篇文章主要介紹了解決異常:Invalid?keystore?format,springboot配置ssl證書格式不合法問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-03-03
本文主要介紹了Java各種內(nèi)存溢出的問題剖析,了解其根源、排查方法以及有效的修改策略,具有一定的參考價值,感興趣的可以了解一下2025-03-03
解決使用this.getClass().getResource()獲取文件時遇到的坑
這篇文章主要介紹了解決使用this.getClass().getResource()獲取文件時遇到的坑問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-12-12
這篇文章主要介紹了SpringBoot Bean花式注解方法，很多時候我們需要根據(jù)不同的條件在容器中加載不同的Bean，或者根據(jù)不同的條件來選擇是否在容器中加載某個Bean2023-02-02