【147期】面试官问：说一说 Lombok 中的 @Builder 作用和用法！

本文链接：https://blog.csdn.net/2401_84437095/article/details/138021740

先自我介绍一下，小编浙江大学毕业，去过华为、字节跳动等大厂，目前阿里P7

深知大多数程序员，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年最新Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以添加V获取：vip1024b （备注Java）

正文

private List hobbies;

User(Integer id, String username, String password, List hobbies) {

this.id = id; this.username = username;

this.password = password; this.hobbies = hobbies;

}

public static User.UserBuilder builder() {return new User.UserBuilder();}

public static class UserBuilder {

private Integer id;

private String username;

private String password;

private ArrayList hobbies;

UserBuilder() {}

public User.UserBuilder id(Integer id) { this.id = id; return this; }

public User.UserBuilder username(String username) { this.username = username; return this; }

public User.UserBuilder password(String password) { this.password = password; return this; }

public User.UserBuilder hobby(String hobby) {

if (this.hobbies == null) {

this.hobbies = new ArrayList();

}

this.hobbies.add(hobby);

return this;

}

public User.UserBuilder hobbies(Collection<? extends String> hobbies) {

if (this.hobbies == null) {

this.hobbies = new ArrayList();

}

this.hobbies.addAll(hobbies);

return this;

}

public User.UserBuilder clearHobbies() {

if (this.hobbies != null) {

this.hobbies.clear();

}

return this;

}

public User build() {

List hobbies;

switch(this.hobbies == null ? 0 : this.hobbies.size()) {

case 0:

hobbies = Collections.emptyList();

break;

case 1:

hobbies = Collections.singletonList(this.hobbies.get(0));

break;

default:

hobbies = Collections.unmodifiableList(new ArrayList(this.hobbies));

}

return new User(this.id, this.username, this.password, hobbies);

}

public String toString() {

return “User.UserBuilder(id=” + this.id + “, username=” + this.username + “, password=” + this.password + “, hobbies=” + this.hobbies + “)”;

}

其实，lombok 的创作者还是很用心的，在进行build()来创建实例对象时，并没有直接使用Collections.unmodifiableList(Collection)此方法来创建实例，而是分为三种情况。

第一种，当集合中没有元素时，创建一个空 list
第二种情况，当集合中存在一个元素时，创建一个不可变的单元素 list
第三种情况，根据当前集合的元素数量创建对应合适大小的 list

当然我们看编译生成的代码，创建了三个关于集合操作的方法：

hobby(String hobby)：向集合中添加一个元素
hobbies(Collection<? extends String> hobbies)：添加一个集合所有的元素
clearHobbies()：清空当前集合数据

@Singular 注解配置 value 属性

我们先来看看 @Singular 注解的详情：

@Target({FIELD, PARAMETER})

@Retention(SOURCE)

public @interface Singular {

// 修改添加集合元素的方法名

String value() default “”;

}

测试如何使用注解属性value

@Builder

public class User {

private final Integer id;

private final String zipCode = “123456”;

private String username;

private String password;

@Singular(value = “testHobbies”)

private List hobbies;

}

// 测试类

public class BuilderTest {

public static void main(String[] args) {

User user = User.builder()

.testHobbies(“reading”)

.testHobbies(“eat”)

.id(1)

.password(“admin”)

.username(“admin”)

.build();

System.out.println(user);

}

说明，当我们使用了注解属性value之后，我们在使用添加集合元素时的方法名发生相应的改变。但是，同时生成的添加整个集合的方法名发生改变了吗？我们再来看看编译后的代码：

/ 编译后：

public class User {

// 省略部分代码，只看关键部分

public static class UserBuilder {

public User.UserBuilder testHobbies(String testHobbies) {

if (this.hobbies == null) {

this.hobbies = new ArrayList();

}

this.hobbies.add(testHobbies);

return this;

}

public User.UserBuilder hobbies(Collection<? extends String> hobbies) {

if (this.hobbies == null) {

this.hobbies = new ArrayList();

}

this.hobbies.addAll(hobbies);

return this;

}

public User.UserBuilder clearHobbies() {

if (this.hobbies != null) {

this.hobbies.clear();

}

return this;

}

可以看到，只有添加一个元素的方法名发生了改变。推荐：Java进阶学习资料。

@Builder.Default 的使用

比如有这样一个实体类：

@Builder

@ToString

public class User {

@Builder.Default

private final String id = UUID.randomUUID().toString();

private String username;

private String password;

@Builder.Default

private long insertTime = System.currentTimeMillis();

}

在类中我在id和insertTime上都添加注解@Builder.Default，当我在使用这个实体对象时，我就不需要在为这两个字段进行初始化值，如下面这样：

public class BuilderTest {

public static void main(String[] args) {

User user = User.builder()

.password(“admin”)

.username(“admin”)

.build();

System.out.println(user);

}

// 输出内容：

User(id=416219e1-bc64-43fd-b2c3-9f8dc109c2e8, username=admin, password=admin, insertTime=1546869309868)

lombok在实例化对象时就为我们初始化了这两个字段值。

当然，你如果再对这两个字段进行设值的话，那么默认定义的值将会被覆盖掉，如下面这样：

public class BuilderTest {

public static void main(String[] args) {

User user = User.builder()

.id(“admin”)

.password(“admin”)

.username(“admin”)

.build();

System.out.println(user);

}

// 输出内容

User(id=admin, username=admin, password=admin, insertTime=1546869642151)

@Builder 详细配置

下面我们再来详细看看@Builder这个注解类地详细实现：

@Target({TYPE, METHOD, CONSTRUCTOR})

@Retention(SOURCE)

public @interface Builder {

// 如果@Builder注解在类上，可以使用 @Builder.Default指定初始化表达式

@Target(FIELD)

@Retention(SOURCE)

public @interface Default {}

// 指定实体类中创建 Builder 的方法的名称，默认为: builder (个人觉得没必要修改)

String builderMethodName() default “builder”;

// 指定 Builder 中用来构件实体类的方法的名称，默认为：build (个人觉得没必要修改)

String buildMethodName() default “build”;

// 指定创建的建造者类的名称，默认为：实体类名+Builder

String builderClassName() default “”;

// 使用toBuilder可以实现以一个实例为基础继续创建一个对象。（也就是重用原来对象的值）

boolean toBuilder() default false;

@Target({FIELD, PARAMETER})

@Retention(SOURCE)

public @interface ObtainVia {

// 告诉lombok使用表达式获取值

String field() default “”;

// 告诉lombok使用表达式获取值

String method() default “”;

boolean isStatic() default false;

}

以上注解属性，我只测试一个比较常用的toBuilder，因为我们在对实体对象进行操作时，往往会存在对某些实体对象的某个字段进行二次赋值，这个时候就会用到这一属性。但是，这会创建一个新的对象，而不是原来的对象，原来的对象属性是不可变的，除非你自己想要给这个实体类再添加上@Data或者@setter方法。下面就来测试一下：

@Builder(toBuilder = true)

@ToString

public class User {

private String username;

private String password;

}

// 测试类

public class BuilderTest {

public static void main(String[] args) {

User user1 = User.builder()

.password(“admin”)

.username(“admin”)