Lombok 是一个用于简化 Java 代码编写的工具,它通过在编译阶段插入代码来减少常见的模板代码(如 getter、setter、equals、hashCode、toString 方法等)。这有助于提高开发效率,并且可以让代码看起来更加整洁。
基本介绍
Lombok 提供了一系列的注解,可以在类定义时使用,以自动生成特定的方法。Lombok 的优点在于它不会影响运行时的行为,因为所有的生成代码都是在编译阶段完成的。
常用注解
以下是一些常用的 Lombok 注解:
@Getter 和 @Setter:生成 getter 和 setter 方法。
@ToString:生成 toString 方法。
@EqualsAndHashCode:生成 equals 和 hashCode 方法。
@NoArgsConstructor:生成无参构造函数。
@AllArgsConstructor:生成包含所有字段的构造函数。
@Builder:生成 builder 模式构造方法。
@Data:综合了 @ToString, @EqualsAndHashCode, @Getter, @Setter, @RequiredArgsConstructor 的功能,适用于普通的 POJO 类。
@Value:创建一个不可变对象,相当于 @Data 加上 final 修饰符。
@NonNull:为方法参数提供非空检查,如果参数为 null 则抛出 NullPointerException。
@SneakyThrows:自动处理受检异常,而无需显式声明或捕获。
日志注解:如 @Slf4j,用于生成 SLF4J 日志对象。
示例
下面通过几个示例来展示 Lombok 的使用方法:
示例 1:使用 @Data
import lombok.Data;
@Data
public class User {
private String name;
private int age;
private String email;
}
这段代码自动生成了 name, age, email 的 getter 和 setter 方法,以及 toString, equals, 和 hashCode 方法。
示例 2:使用 @NoArgsConstructor 和 @AllArgsConstructor
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
@NoArgsConstructor
@AllArgsConstructor
public class User {
private String name;
private int age;
private String email;
}
这里自动生成了一个无参构造函数和一个包含所有字段的构造函数。
示例 3:使用 @Builder
import lombok.Builder;
import lombok.Value;
@Builder
@Value
public class User {
private String name;
private int age;
private String email;
}
这里使用了 @Builder 注解来生成一个 builder 模式的构造方法,并且使用 @Value 创建了一个不可变对象。
示例 4:使用 @NonNull
import lombok.NonNull;
import lombok.ToString;
@ToString
public class User {
@NonNull
private String name;
private int age;
private String email;
}
如果在构造函数或方法中传递的 name 参数为 null,则会抛出 NullPointerException。
示例 5:使用 @SneakyThrows
import lombok.SneakyThrows;
public class Example {
@SneakyThrows
public void readFile(String path) {
// 自动处理可能抛出的 IOException
// 代码省略...
}
}