本文共 3072 字，大约阅读时间需要 10 分钟。

Lombok - Java 开发工具简介与应用

Lombok 是一款为 Java 开发者设计的工具，旨在通过自动生成代码来简化开发流程。通过在代码中使用特定的注解，Lombok 可以自动为你生成 Getter、Setter、构造函数等常见代码，从而减少冗余代码的编写，提高开发效率。

Lombok 的基本知识

Lombok 的核心功能是通过注解自动生成代码。其主要注解包括：

• @Getter 和 @Setter：用于自动生成字段的 Getter 和 Setter 方法。
• @AllArgsConstructor：用于自动生成带有所有参数的构造函数。
• @NoArgsConstructor：用于自动生成无参数构造函数。
• @Data：包含了 @Getter、@Setter、@ToString、@EqualsAndHashCode 和 @AllArgsConstructor 的功能，适用于需要快速生成标准代码的场景。
• @Log：用于日志记录，常见于 @Slf4j 注解。
• @ToString：用于自动生成对象的 toString 方法。
• @EqualsAndHashCode：用于自动生成 equals 和 hashCode 方法。
• @NonNull：用于确保字段不为空，常用于参数验证。

Lombok 的优缺点分析

优点：

缺点：

Lombok 的代码应用

在 Maven 项目中使用 Lombok，需要在 pom.xml 中添加依赖：

       
    
     org.projectlombok
        
    
     lombok
        
    
     ${lombok.version}
        
    
     provided
    
   

示例代码：

import lombok.Getter;import lombok.Setter;@Getter@Setterprivate String name;

等价于：

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

常见注解示例

import lombok.AllArgsConstructor;import lombok.NoArgsConstructor;@AllArgsConstructor@NoArgsConstructorpublic class MyClass {    private String name;    private int age;}

等价于：

public class MyClass {    private String name;    private int age;    public MyClass(String name, int age) {        this.name = name;        this.age = age;    }    public MyClass() {    }}

2. @Data 注解：

import lombok.Data;@Datapublic class MyClass {    private String name;    private int age;}

等价于：

public class MyClass {    private String name;    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;    }    @Override    public boolean equals(Object obj) {        if (this == obj) return true;        if (obj == null || getClass() != obj.getClass()) return false;        MyClass other = (MyClass) obj;        return Objects.equals(name, other.name) && Objects.equals(age, other.age);    }    @Override    public int hashCode() {        return Objects.hash(name, age);    }    @Override    public String toString() {        return "MyClass{" + "name=" + name + ", age=" + age + '}';    }}

3. @Log 和 @Slf4j：

import lombok.Log;import lombok.Slf4j;@Logpublic class LogExample {    @Slf4j    public void logMessage(String message) {        log.info(message);    }}

其他常用注解

• @Cleanup：用于自动化处理资源，类似于 try-with-resource。

@Cleanup InputStream in = new FileInputStream("file.txt");@Cleanup OutputStream out = new FileOutputStream("file.txt");

• @SneakyThrows：用于在方法上抛出异常，不需要显式声明。

@SneakyThrows(Exception.class)public void method() {    // 代码可能抛出异常}

• @Synchronized：用于同步方法，控制锁的对象。

private final Object lock = new Object();@synchronized("lock")public void foo() {    // 代码块}

Lombok 提供了丰富的注解选项，适用于不同场景的开发需求。通过合理使用这些注解，可以显著简化 Java 开发过程，提高开发效率。

转载地址：http://mjufk.baihongyu.com/