当前位置: 开发笔记 > 编程语言 > 正文

探究lombok03@Builder使用

作者：蒋易之 | 来源：互联网 | 2023-10-12 14:37

Java8org.springframework.boot2.7.3lombok1.18.24EclipseVersion:2022-09(4.25.0)--ben发布于博客园上

Java 8

org.springframework.boot 2.7.3

lombok 1.18.24

Eclipse Version: 2022-09 (4.25.0)

--ben发布于博客园

上一篇：探究lombok-02-类继承

https://www.cnblogs.com/luo630/p/16941903.html

注，本文测试结果的 LombokMain.java 的代码与上一篇相同。ben发布于博客园

0、序章

使用 @Builder 后，可以使用链式编程方式构建对象（一般方法是使用 new）。ben发布于博客园

示例代码：UserBuilderVO类

import java.util.Date; import java.util.List; import lombok.Builder; @Builder public class UserBuilderVO { private Integer id; private String name; private List tags; private Date createTime; }

1、仅@Builder

只使用 @Builder 的类分析结果：

增加了一个内部类UserBuilderVOBuilder；

只有一个成员方法：builder。

UserBuilderVOBuilder 类分析结果（1）：

test(UserBuilderVO.UserBuilderVOBuilder.class);

测试：class=class com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder ---- prtClasses: length=0 ---- prtConstructors: length=1 构造方法名称：com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder, 参数数量：0, modifiers=0 ---- prtFields: length=4 字段：id, type=class java.lang.Integer, modifiers=2 字段：name, type=class java.lang.String, modifiers=2 字段：tags, type=interface java.util.List, modifiers=2 字段：createTime, type=class java.util.Date, modifiers=2 ---- prtMethods: length=6 方法名称：name, 参数数量：1, modifiers=1 方法名称：toString, 参数数量：0, modifiers=1 方法名称：id, 参数数量：1, modifiers=1 方法名称：createTime, 参数数量：1, modifiers=1 方法名称：build, 参数数量：0, modifiers=1 方法名称：tags, 参数数量：1, modifiers=1

存在6个方法，其中一个为 build，用来生成最终的 UserBuilderVO 对象。

链式编程创建对象：

private static void testCreateUserBuilderVO() { cs.accept("\n\n测试：testCreateUserBuilderVO..."); UserBuilderVO bvo = UserBuilderVO.builder() .id(1) .name("ben") .tags(new ArrayList<>()) .createTime(new Date()) .build(); cs.accept("UserBuilderVO bvo=" + bvo); }

测试结果：

测试：testCreateUserBuilderVO... UserBuilderVO bvo=com.lib.webdemo.vo.UserBuilderVO@87aac27

直接输出对象，看不到对象里面各个属性的值；

也没有各个属性的getter方法，无法获取内部属性的值。

存在缺点：

无法用链式编程设置对象中列表的值；（第3节）

对于 createTime，是否可以设置默认值？（第4节）

2、@Builder+@ToString+@Getter

给上面的 UserBuilderVO 类添加 @ToString、@Getter 注解。

类分析结果：多了 getter方法和 ToString方法

prtMethods: length=6 方法名称：toString, 参数数量：0, modifiers=1 方法名称：getName, 参数数量：0, modifiers=1 方法名称：getId, 参数数量：0, modifiers=1 方法名称：builder, 参数数量：0, modifiers=9 方法名称：getCreateTime, 参数数量：0, modifiers=1 方法名称：getTags, 参数数量：0, modifiers=1

创建对象后输出结果：可以看到对象内部各个属性的值了

测试：testCreateUserBuilderVO... UserBuilderVO bvo=UserBuilderVO(id=1, name=ben, tags=[], createTime=Mon Dec 05 19:23:44 CST 2022)

3、填充列表的值（@Singular）

在第1节中，对 UserBuilderVOBuilder 类进行了分析，存在一个 tags方法。

此时，在链式编程中，需要提前建立一个列表作为参数传入。

要想在链式编程中设置tags属性的值，需要使用 @Singular 注解。

注，Singular adj. <语>单数的; <正>突出的; 奇特的; 非凡的; n. 单数形式（的词）。ben发布于博客园

（在第2节的基础上）给 UserBuilderVO 的 tags 属性添加 @Singular 注解。

UserBuilderVO 的类分析结果不变。

但 UserBuilderVOBuilder 的类分析结果（2）存在下面的变化：

测试：class=class com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder ---- prtClasses: length=0 ---- prtConstructors: length=1 构造方法名称：com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder, 参数数量：0, modifiers=0 ---- prtFields: length=4 字段：id, type=class java.lang.Integer, modifiers=2 字段：name, type=class java.lang.String, modifiers=2 字段：tags, type=class java.util.ArrayList, modifiers=2 字段：createTime, type=class java.util.Date, modifiers=2 ---- prtMethods: length=8 方法名称：name, 参数数量：1, modifiers=1 方法名称：toString, 参数数量：0, modifiers=1 方法名称：id, 参数数量：1, modifiers=1 方法名称：createTime, 参数数量：1, modifiers=1 方法名称：build, 参数数量：0, modifiers=1 方法名称：tags, 参数数量：1, modifiers=1 方法名称：tag, 参数数量：1, modifiers=1 方法名称：clearTags, 参数数量：0, modifiers=1

多了 tag、clearTags 两个方法。

新的创建对象：链式编程填充列表属性的值

private static void testCreateUserBuilderVO() { cs.accept("\n\n测试：testCreateUserBuilderVO..."); UserBuilderVO bvo = UserBuilderVO.builder() .id(1) .name("ben") // 旧 tags 方法 // .tags(new ArrayList<>()) // 新 tag方法 .tag("1").tag("2").tag("AAAA") .createTime(new Date()) .build(); cs.accept("UserBuilderVO bvo=" + bvo); }

测试结果：

测试：testCreateUserBuilderVO... UserBuilderVO bvo=UserBuilderVO(id=1, name=ben, tags=[1, 2, AAAA], createTime=Mon Dec 05 19:43:06 CST 2022)

tags现在有值了。

填充Map

添加字段scores：

类分析结果：

测试：class=class com.lib.webdemo.vo.UserBuilderVO ---- prtClasses: length=1 内部类: com.lib.webdemo.vo.UserBuilderVO.UserBuilderVOBuilder, com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder, UserBuilderVOBuilder, com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder, modifiers=9 ---- prtConstructors: length=1 构造方法名称：com.lib.webdemo.vo.UserBuilderVO, 参数数量：5, modifiers=0 ---- prtFields: length=5 字段：id, type=class java.lang.Integer, modifiers=2 字段：name, type=class java.lang.String, modifiers=2 字段：tags, type=interface java.util.List, modifiers=2 字段：scores, type=interface java.util.Map, modifiers=2 字段：createTime, type=class java.util.Date, modifiers=2 ---- prtMethods: length=13 方法名称：toString, 参数数量：0, modifiers=1 方法名称：getName, 参数数量：0, modifiers=1 方法名称：getId, 参数数量：0, modifiers=1 方法名称：builder, 参数数量：0, modifiers=9 方法名称：access$1, 参数数量：0, modifiers=4104 方法名称：access$2, 参数数量：0, modifiers=4104 方法名称：getTags, 参数数量：0, modifiers=1 方法名称：getCreateTime, 参数数量：0, modifiers=1 方法名称：getScores, 参数数量：0, modifiers=1 方法名称：$default$name, 参数数量：0, modifiers=10 方法名称：access$0, 参数数量：0, modifiers=4104 方法名称：$default$id, 参数数量：0, modifiers=10 方法名称：$default$createTime, 参数数量：0, modifiers=10 测试：class=class com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder ---- prtClasses: length=0 ---- prtConstructors: length=1 构造方法名称：com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder, 参数数量：0, modifiers=0 ---- prtFields: length=9 字段：id$value, type=class java.lang.Integer, modifiers=2 字段：id$set, type=boolean, modifiers=2 字段：name$value, type=class java.lang.String, modifiers=2 字段：name$set, type=boolean, modifiers=2 字段：tags, type=class java.util.ArrayList, modifiers=2 字段：scores$key, type=class java.util.ArrayList, modifiers=2 字段：scores$value, type=class java.util.ArrayList, modifiers=2 字段：createTime$value, type=class java.util.Date, modifiers=2 字段：createTime$set, type=boolean, modifiers=2 ---- prtMethods: length=11 方法名称：name, 参数数量：1, modifiers=1 方法名称：toString, 参数数量：0, modifiers=1 方法名称：id, 参数数量：1, modifiers=1 方法名称：tag, 参数数量：1, modifiers=1 方法名称：score, 参数数量：2, modifiers=1 方法名称：createTime, 参数数量：1, modifiers=1 方法名称：build, 参数数量：0, modifiers=1 方法名称：clearTags, 参数数量：0, modifiers=1 方法名称：clearScores, 参数数量：0, modifiers=1 方法名称：tags, 参数数量：1, modifiers=1 方法名称：scores, 参数数量：1, modifiers=1

测试代码及结果：

测试：testCreateUserBuilderVO... UserBuilderVO bvo=UserBuilderVO(id=1, name=ben, tags=[1, 2, AAAA], scores={数学=100, 语文=99, 科学=98, 文明=97}, createTime=Mon Dec 05 19:55:43 CST 2022)

4、设置默认值（@Builder.Default）

UserBuilderVO 对象的属性默认是null，可以使用 @Builder.Default 设置各个属性的默认值。ben发布于博客园

更新后的 UserBuilderVO：

@Builder @Getter @ToString public class UserBuilderVO { @Builder.Default private Integer id = 2; @Builder.Default private String name = "罗峰"; @Singular private List tags; @Builder.Default private Date createTime = new Date(); }

类分析：

测试：class=class com.lib.webdemo.vo.UserBuilderVO ---- prtClasses: length=1 内部类: com.lib.webdemo.vo.UserBuilderVO.UserBuilderVOBuilder, com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder, UserBuilderVOBuilder, com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder, modifiers=9 ---- prtConstructors: length=1 构造方法名称：com.lib.webdemo.vo.UserBuilderVO, 参数数量：4, modifiers=0 ---- prtFields: length=4 字段：id, type=class java.lang.Integer, modifiers=2 字段：name, type=class java.lang.String, modifiers=2 字段：tags, type=interface java.util.List, modifiers=2 字段：createTime, type=class java.util.Date, modifiers=2 ---- prtMethods: length=12 方法名称：toString, 参数数量：0, modifiers=1 方法名称：getName, 参数数量：0, modifiers=1 方法名称：getId, 参数数量：0, modifiers=1 方法名称：builder, 参数数量：0, modifiers=9 方法名称：$default$id, 参数数量：0, modifiers=10 方法名称：$default$name, 参数数量：0, modifiers=10 方法名称：access$1, 参数数量：0, modifiers=4104 方法名称：getTags, 参数数量：0, modifiers=1 方法名称：access$2, 参数数量：0, modifiers=4104 方法名称：access$0, 参数数量：0, modifiers=4104 方法名称：getCreateTime, 参数数量：0, modifiers=1 方法名称：$default$createTime, 参数数量：0, modifiers=10 测试：class=class com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder ---- prtClasses: length=0 ---- prtConstructors: length=1 构造方法名称：com.lib.webdemo.vo.UserBuilderVO$UserBuilderVOBuilder, 参数数量：0, modifiers=0 ---- prtFields: length=7 字段：id$value, type=class java.lang.Integer, modifiers=2 字段：id$set, type=boolean, modifiers=2 字段：name$value, type=class java.lang.String, modifiers=2 字段：name$set, type=boolean, modifiers=2 字段：tags, type=class java.util.ArrayList, modifiers=2 字段：createTime$value, type=class java.util.Date, modifiers=2 字段：createTime$set, type=boolean, modifiers=2 ---- prtMethods: length=8 方法名称：name, 参数数量：1, modifiers=1 方法名称：toString, 参数数量：0, modifiers=1 方法名称：id, 参数数量：1, modifiers=1 方法名称：build, 参数数量：0, modifiers=1 方法名称：tag, 参数数量：1, modifiers=1 方法名称：clearTags, 参数数量：0, modifiers=1 方法名称：createTime, 参数数量：1, modifiers=1 方法名称：tags, 参数数量：1, modifiers=1

UserBuilderVO 的变化：方法里面多了 $default$ + 属性名、access$0~2。

UserBuilderVOBuilder 的变化：属性多了属性名 + $value、属性名 + $set 格式的属性，少了属性名的属性、ben发布于博客园

创建对象：

cs.accept("\n\n测试：testCreateUserBuilderVO..."); UserBuilderVO bvo = UserBuilderVO.builder() .build(); cs.accept("UserBuilderVO bvo=" + bvo);

测试结果：

测试：testCreateUserBuilderVO... UserBuilderVO bvo=UserBuilderVO(id=2, name=罗峰, tags=[], createTime=Mon Dec 05 19:56:21 CST 2022)

更多测试：

@Singular 和 @Builder.Default 不可以同时存在。ben发布于博客园

疑问：

@Data 是否有什么更进一步的用法呢？ben发布于博客园

@Builder 的更多使用方式，可以看参考资料#1 —— 来自官方

参考资料

1、官方文档-@Builder

https://projectlombok.org/features/Builder

讲的很详细。基本用法、高级用法。ben发布于博客园

2、Lombok 中@Builder 的使用

https://www.cnblogs.com/minmin123/p/14368725.html

posted @ 2021-02-03 18:27 keepsummer

3、

ben发布于博客园

推荐阅读

utf-8
docker镜像重启_docker怎么启动镜像

docker镜像重启_docker怎么启动镜像dock ... [详细]

蜡笔小新 2024-12-20 16:34:52
uml
深入解析Spring启动过程

本文详细介绍了Spring框架的启动流程，帮助开发者理解其内部机制。通过具体示例和代码片段，解释了Bean定义、工厂类、读取器以及条件评估等关键概念，使读者能够更全面地掌握Spring的初始化过程。 ... [详细]

蜡笔小新 2024-12-21 17:33:44
uml
深入理解ExtJS：从入门到精通

本文详细介绍了ExtJS的功能及其在大型企业前端开发中的应用。通过实例和详细的文件结构解析，帮助初学者快速掌握ExtJS的核心概念，并提供实用技巧和最佳实践。 ... [详细]

蜡笔小新 2024-12-21 15:41:04
utf-8
ssm 框架整合及工程分层

ssm框架整合及工程分层1.先创建一个新的project1.1配置pom.xml ... [详细]

蜡笔小新 2024-12-21 12:56:58
utf-8
烤鸭|本文_Spring之Bean的生命周期详解

烤鸭|本文_Spring之Bean的生命周期详解 ... [详细]

蜡笔小新 2024-12-19 16:57:11
client
Python3环境下Appium1.4.6配置及模拟器连接指南

本文详细介绍了如何在Python3环境中配置Appium1.4.6，并指导如何连接模拟器进行自动化测试。通过本文，您将了解从环境搭建到模拟器连接的完整流程。 ... [详细]

蜡笔小新 2024-12-19 02:33:06
client
Linux下卸载OpenJDK并安装配置JDK 1.8及防火墙设置

本文介绍如何在Linux系统中卸载预装的OpenJDK，安装指定版本的JDK 1.8，并配置防火墙以确保系统安全性和软件兼容性。 ... [详细]

蜡笔小新 2024-12-18 14:47:47
client
EasyMock实战指南

本文介绍了如何使用EasyMock进行单元测试，特别是当测试对象的合作者依赖于外部资源或尚未实现时。通过具体的示例，展示了EasyMock在模拟对象行为方面的强大功能。 ... [详细]

蜡笔小新 2024-12-18 13:03:19
client
利用YAML配置Resilience4J的Circuit Breaker

本文探讨了Resilience4j作为现代Java应用程序中不可或缺的容错工具，特别介绍了如何通过YAML文件配置Circuit Breaker以提高服务的弹性和稳定性。 ... [详细]

蜡笔小新 2024-12-17 19:40:42
include
在Android Studio项目中高效集成JNI方法

本文详细介绍了如何在现有的Android Studio项目中集成JNI（Java Native Interface），包括下载必要的NDK和构建工具，配置CMakeLists.txt文件，以及编写和调用JNI函数的具体步骤。 ... [详细]

蜡笔小新 2024-12-17 16:46:36
version
掌握Spring MVC中自定义类型转换与格式化的技巧

近期，在开发一款小程序的过程中遇到了几个Spring MVC接口需要传递时间参数的问题。本文将详细介绍如何利用Java 8 Time API在Spring MVC中实现时间参数的自定义类型转换和格式化。 ... [详细]

蜡笔小新 2024-12-17 15:37:19
text
Spring Boot 解决 AJAX 跨域请求及自定义 Headers 方法

本文探讨了浏览器的同源策略限制及其对 AJAX 请求的影响，并详细介绍了如何在 Spring Boot 应用中优雅地处理跨域请求，特别是当请求包含自定义 Headers 时的解决方案。 ... [详细]

蜡笔小新 2024-12-17 13:57:01
substring
Java实现文本到图片转换，支持自动换行、字体自定义及图像优化

本文详细介绍了如何使用Java实现将文本转换为图片的功能，包括自动换行、自定义字体加载、抗锯齿优化以及图片压缩等技术细节。 ... [详细]

蜡笔小新 2024-12-17 13:47:08
substring
Java远程教学系统毕业设计：源代码、MySQL数据库及文档

本文介绍了Java语言开发的远程教学系统，包括源代码、MySQL数据库配置以及相关文档，适用于计算机专业的毕业设计。系统支持远程调试，采用B/S架构，适合现代教育需求。 ... [详细]

蜡笔小新 2024-12-17 05:12:29
filter
精通Spring Cloud：从入门到实践的全面指南

Spring Cloud因其强大的功能和灵活性，被誉为开发分布式系统的‘一站式’解决方案。它不仅简化了分布式系统中的常见模式实现，还被广泛应用于企业级生产环境中。本书内容详实，覆盖了从微服务基础到Spring Cloud的高级应用，适合各层次的开发者。 ... [详细]

蜡笔小新 2024-12-16 16:21:23

蒋易之

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章