Lombok 使用教程+案例

摘要：Lombok 是一个 Java 库，通过使用注解的方式，可以在编译期间自动生成 getter、setter、equals、hashCode、toString 方法等。本文将介绍 Lombok 的安装、使用方法以及一些常见注解的用法，并通过一个简单的案例展示 Lombok 的实际应用。
一、Lombok 安装

1. 下载 Lombok
   访问 Lombok 官网（https://projectlombok.org/），下载最新版本的 Lombok JAR 包。
2. 安装 Lombok
   将下载的 Lombok JAR 包安装到本地 Maven 仓库，执行以下命令：

java -jar lombok.jar

按照提示完成安装。
二、Lombok 使用方法

1. 在项目中引入 Lombok 依赖
   在 Maven 项目的 pom.xml 文件中添加以下依赖：

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

2. 在 IDE 中安装 Lombok 插件
   以 IntelliJ IDEA 为例，打开 File -> Settings -> Plugins，搜索并安装 Lombok 插件。
   三、Lombok 常见注解用法
3. @Getter 和 @Setter
   自动生成属性的 getter 和 setter 方法。

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

2. @NoArgsConstructor
   自动生成无参构造方法。

import lombok.NoArgsConstructor;
@NoArgsConstructor
public class User {
    private String name;
    private int age;
}

3. @AllArgsConstructor
   自动生成全参构造方法。

import lombok.AllArgsConstructor;
@AllArgsConstructor
public class User {
    private String name;
    private int age;
}

4. @RequiredArgsConstructor
   自动生成包含 final 属性和 @NonNull 属性的构造方法。

import lombok.RequiredArgsConstructor;
@RequiredArgsConstructor
public class User {
    private final String name;
    private int age;
}

5. @ToString
   自动生成 toString 方法。

import lombok.ToString;
@ToString
public class User {
    private String name;
    private int age;
}

6. @EqualsAndHashCode
   自动生成 equals 和 hashCode 方法。

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

四、Lombok 案例
以下是一个简单的 Lombok 使用案例，展示了一个用户类 User 的定义和用法。

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private String name;
    private int age;
}

使用 Lombok 后，我们可以直接使用 User 类的 getter、setter、equals、hashCode 和 toString 方法，无需手动编写。

public class Main {
    public static void main(String[] args) {
        User user1 = new User("Alice", 25);
        User user2 = new User("Bob", 30);
        System.out.println(user1.getName());  // 输出：Alice
        System.out.println(user1.getAge());   // 输出：25
        user1.setAge(26);
        System.out.println(user1.getAge());   // 输出：26
        System.out.println(user1.equals(user2));  // 输出：false
        System.out.println(user1.toString());     // 输出：User(name=Alice, age=26)
    }
}

五、总结
Lombok 是一个实用的 Java 库，通过注解的方式简化了代码的编写。本文介绍了 Lombok 的安装、使用方法以及一些常见注解的用法，并通过一个简单的案例展示了 Lombok 的实际应用。掌握 Lombok 的使用，可以提高开发效率，使代码更加简洁、易于维护。