@Builder
注解是 Lombok 库中的一个注解,用于自动生成复杂对象的构建器模式 (Builder Pattern)。Builder Pattern 是一种常用的设计模式,它可以使对象的创建过程更加简洁和灵活,特别是在对象有多个参数时。
以下是 @Builder
注解的一些主要用途和功能:
-
简化对象创建:可以使用流式接口来创建对象,而不需要编写繁琐的构造函数或 setter 方法。
-
可读性强:使用 Builder 模式可以提高代码的可读性,使得对象的创建过程看起来更加清晰。
-
可选参数:可以方便地处理可选参数,不需要为所有可能的参数组合创建多个构造函数。
-
不可变对象:Builder 模式通常与不可变对象(immutable objects)结合使用,从而提高代码的安全性和稳定性。
-
减少构造器过载:避免由于参数过多而产生的构造器过载问题。
使用示例
以下是一个使用 @Builder
注解的示例:
import lombok.Builder;
import lombok.ToString;
@Builder
@ToString
public class User {
private String username;
private String email;
private int age;
public static void main(String[] args) {
User user = User.builder()
.username("john_doe")
.email("john@example.com")
.age(30)
.build();
System.out.println(user);
}
}
在这个示例中:
@Builder
注解会自动生成一个内部静态类UserBuilder
,其中包含了username
、email
和age
的 setter 方法。- 使用
User.builder()
来获得UserBuilder
的实例,并可以链式调用 setter 方法来设置属性,最后调用build()
方法来创建User
实例。 @ToString
注解会自动生成toString()
方法,以便于打印对象内容。
生成的代码概述
Lombok 会生成类似以下的代码:
public class User {
private String username;
private String email;
private int age;
User(String username, String email, int age) {
this.username = username;
this.email = email;
this.age = age;
}
public static UserBuilder builder() {
return new UserBuilder();
}
public static class UserBuilder {
private String username;
private String email;
private int age;
UserBuilder() {
}
public UserBuilder username(String username) {
this.username = username;
return this;
}
public UserBuilder email(String email) {
this.email = email;
return this;
}
public UserBuilder age(int age) {
this.age = age;
return this;
}
public User build() {
return new User(username, email, age);
}
public String toString() {
return "User.UserBuilder(username=" + this.username + ", email=" + this.email + ",