详解Lombok快速上手(安装、使用与注解参数)

详解 Lombok 快速上手

Lombok 是一个 Java 库，可以在编码时自动生成样板代码，以减少 Java 项目中冗长的样板代码量。

安装 Lombok

安装 Lombok 很简单。只需要在项目依赖中加入 Lombok，就能让 Lombok 自动为你生成样板代码。

下面是 Maven 和 Gradle 的配置：

Maven

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

Gradle

compileOnly 'org.projectlombok:lombok:1.18.12'

接下来就可以在项目中使用 Lombok 注解了。

Lombok 注解

下面是一些常用 Lombok 注解的说明：

@Getter 和 @Setter

@Getter 和 @Setter 注解会自动生成属性的 getter 和 setter 方法。

public class Person {
    @Getter @Setter private String name;
}

在这个示例中，Lombok 会自动生成名为 getName 和 setName 的方法。

@Data

@Data 注解会自动生成属性的 getter、setter、equals、hashCode 和 toString 方法。

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

在这个示例中，Lombok 会自动生成 getName、setName、getAge、setAge、equals、hashCode 和 toString 方法。

@NonNull

@NonNull 注解用于标记一个属性不允许为空。

public class Person {
    @NonNull private String name;
}

在这个示例中，Lombok 会自动生成名为 getName 和 setName 的方法，并在 setName 方法中检查参数是否为空。

@AllArgsConstructor

@AllArgsConstructor 注解用于生成一个包含所有属性的构造函数。

@AllArgsConstructor public class Person {
    private String name;
    private int age;
}

在这个示例中，Lombok 会自动生成带有两个参数的构造函数。

示例

下面是两个示例，演示了如何使用 Lombok。

示例 1

在这个示例中，我们使用 @Data 注解和 @AllArgsConstructor 注解，生成一个包含所有属性的 Java 类。

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

在这个示例中，我们没有手动添加 getter、setter、equals、hashCode 和 toString 方法，因为 Lombok 会为我们自动添加。

示例 2

在这个示例中，我们使用 @NonNull 注解和 @Setter 注解，生成一个带有非空检查的 Java 类。

public class Person {
    @NonNull @Setter private String name;
}

在这个示例中，我们使用 @NonNull 注解标记 name 属性，以确保它不为空。我们同时使用 @Setter 注解，使 Lombok 自动生成 setName 方法，并在该方法中检查参数是否为空。

总结

本文介绍了如何安装和使用 Lombok，并介绍了常用的 Lombok 注解。我们还通过两个示例演示了如何使用 Lombok 生成样板代码。使用 Lombok 可以让我们更快速开发 Java 项目，减少冗长的样板代码量。