Lombok之@Builder使用

最新推荐文章于 2025-10-13 12:02:51 发布
原创 最新推荐文章于 2025-10-13 12:02:51 发布 · 9.2k 阅读 · 10 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#cauchy6317 #@Builder #lombok系列

本文深入探讨Lombok库中的@Builder注解，解析其在复杂对象创建过程中的作用及优势，尤其适用于成员变量多且有默认值的类。通过对比@Builder与@Accessors，阐述两者在代码复用性和封装性上的区别，为读者提供实用的代码优化策略。

一. 为什么要用@Builder?

当一个类的成员变量比较多，同时，大部分的成员变量有默认值，仅有少量的成员变量需要初始化时，我们该如何设计这个类？我们需要让该类满足以下两个要求：

  1. 方便用户创建复杂的对象（不需要知道实现过程），仅需要初始化必要的成员变量；
  2. 代码复用性 & 封装性（将对象构建过程和细节进行封装 & 复用）

这种需求和建造者模式的设计场景不期而合。同时，Lombok提供了@Builder注解用于快速地实现一个类的建造者模式。
讲解@Builder之前，首先，要求读者对建造者模式有一定的了解。通过简书上的《一篇文章就彻底弄懂建造者模式(Builder Pattern)》对可以建造者模式有个初步的了解，并且建造者模式的优点在于：可以将构造器的setter方法名取成类似注释的方式，这样我们可以很清晰的知道刚才究竟设置的什么值，可读性较高。
从@Builder的源码和官网的介绍来看，我觉得@Builder的实用性不如它的另一个注解@Accessors。因为@Builder能做到的，@Accessors也能做到，并且理解起来简单（希望有前辈能做更具体详细的解释，这两个注释，从我的理解来看，我更倾向于@Accessors）。@Builder在创建对象时具有链式赋值的特点，但是在创建对象后，就不能链式赋值了，只能采用setter方法，虽然toBuilder注解属性可以复用对象的成员变量值，但是却返回一个新的对象，这不是我们所希望看到的。然而，@Accessors却可以在任何时候对对象的成员变量实现链式赋值。如果是对实用性看重的读者，可以直接跳转至《Lombok实验室之@Accessors使用》。
不过，建造者模式在源码中十分常见，特别是在各类数据源的创建过程中，掌握它更有利于阅读源码。

二. @Builder如何使用？

可以直接阅读该文《Lombok 实战 —— @Builder》，该博主也有Lombok的系列文章，推荐读者阅读。

三. @Builder源码

略

四. 特别说明

本文已经收录在Lombok注解系列文章总览中，并继承上文中所提的特别说明。
源码地址：gitee

lombok中@builder注解的用法
舒一笑的博客
08-25 1429
在上面的示例中，@Builder.Default 注解用于设置 gender 属性的默认值为 “unknown”。然后，我们可以使用生成的构建器类 Person.builder() 创建 Person 对象，并通过链式调用的方式设置属性的值。使用 @Builder 注解后，Lombok 会自动生成一个构建器类，用于创建带有多个属性的对象。使用 @Builder 注解可以简化创建带有多个属性的对象的过程，避免了手动编写构建器的繁琐代码。在要使用 @Builder 注解的类上添加 @Builder 注解。
Lombok之@Builder注解与构造方法使用问题
Eflyings的博客
09-16 2582
1.问题 实体类使用@lombok.Builder注解和自己手动编写的全参构造方法，构建实体类实例时部分字段值发生了错乱。 2.示例代码 /** * @ClassName Demo * @Description TODO * @Author Mr Zhang * @Date 2020/9/16 13:48 * @Version 1.0 **/ @lombok.Builder @lombok.Data public class Demo { private Long id;
Lombok 使用教程-@Builder | 提供 Builder 形式轻松实现对象创建
smart_an的专栏
08-11 1335
在中，@Builder被作为实验性功能引入。@Builder获得了@Singular的支持，并从开始晋升为lombok主包。在中增加了功能。从开始是合法的（并且会抑制生成builder方法）。从开始，是合法的（并将生成具有指定访问级别的构建器类、构建器方法等）。@Builder注解可以为你的类产生复杂的构建器API。@Builder可以被放在一个类上，或者一个构造函数上，或者一个方法上。虽然 "在类上 "和 "在构造函数上 "的模式是最常见的使用情况，但。
@Builder使用
只为成功找方法 不为失败找借口
01-11 1796
test
Java 简化对象创建过程之lombok 注解 @Builder
最新发布
尚墨1111的博客
10-13 161
lombok注解之@Builder
@Builder用法
Datao_csdn的博客
05-07 383
@Builder用法留下天坑日后填 留下天坑日后填
lombok 基础注解之 @Builder
热门推荐
用善良的眼光看世界
10-24 9万+
最全的 lombok 注解详情（随着版本不定时更新） @Builder 注解为类生成相对略微复杂的构建器 API。可以以下面形式调用代码，初始化实例对象生成的对象是不可以变的，如果需要在原来的基础上修改可以加 set 方法 final 字段可以不需要初始化，可以在创建对象的时候进行赋值。它会生成一个全参的构造函数 一、属性介绍 @Builder.Default：非 final 的字段可以有默认值 builderMethodName：指定创建内部静态类的方法名，默认值为 builder build
Lombok 实战教程 - @Builder | 提供 Builder 形式轻松实现对象创建
qq_33240556的博客
05-25 3284
我们可以通过 Lombok 的@Builder注解来自定义生成的 Builder 类和方法。示例Builder;ToString;@ToString参数自定义了生成的静态方法的名称为newBuilder。参数自定义了生成的 Builder 类中的构建方法的名称为create。.create();
Lombok @Builder --javaweb
xycxycooo的博客
07-27 642
如果类已经有一个或多个构造函数，@Builder// 自定义构造函数 public CustomUser(String name , int age) {} }Builder;Getter;@Builder@Getter// 自定义构造函数.age(30).build();// 输出: default@example.com通过这些示例，可以看到@Builder注解如何与字段默认值、不可变对象、部分构建和自定义构造函数结合使用，从而简化对象的创建过程。
消除代码冗长神器 - Lombok | @Builder注解 - Builder 设计模式快速实现
甘蓝的专栏
01-12 1030
Lombok 的@Builder注解实现Builder设计模式。
Java实用注解篇： Lombok 的 @Builder
x²
05-06 4059
Builder@Builder是 Lombok 提供的极具实用性的注解，帮助我们以更加优雅、安全的方式创建对象。无论是构建复杂对象、实现不可变类，还是提升代码可读性，@Builder都是你值得掌握的利器。建议与@Data@Value@Singular等 Lombok 注解组合使用，进一步简化 Java 代码结构。
【Lombok】@Builder | 提供 Builder 形式轻松实现对象创建
猫巳的博客
12-09 4991
文章目录一、简介@Builder.Default@SingularJackson二、示例比较1. Lombok 写法2. Java 标准写法三、支持的配置项四、附属说明参考文献 一、简介 在lombok v0.12.0中，@Builder被作为实验性功能引入。 @Builder获得了@Singular的支持，并从lombok v1.16.0开始晋升为lombok主包。 在lombok v1.16.16中增加了@Builder.Default功能。 @Builder(builderMethodName = "
详解 Lombok 中的 @Builder 用法！
ITMuch的专栏
01-02 6636
点击下方“IT牧场”，选择“设为星标”来源 |cnblogs.com/ajing2018/p/14281700.html01、详解Lombok中的@Builder用法02、基础使用03、...
Lombok的踩坑系列之@Builder
晴天
12-05 835
日常我们业务开发中有很多小的需求，只需要增加一个属性就可以解决，此时就要注意历史逻辑中是否用 Lombok 的 Builder方式创建对象，
@Builder
Pre_waist_L的博客
03-08 1048
一般写一个多参的类，会有多个不同的构造器供客户的调用，这就导致灵活性太低，而且如果之后要维护，头疼。 使用@Builder，相当于将这个类所需要的构造器自动构建，你只需要传参即可。 public class a<T> { private T foo; private final String bar; private a(T fo...
@Builder注解的使用
m0_57310426的博客
04-30 1797
在传统对象中，我们直接对参数赋值可以初始化参数，但是使用@Builder后，初始化参数是无效的，所以需要在需要初始化参数上边使用@Builder.Default注明这是一个默认构造参数。创建对象：Person p=new Person().builder().name(“xiao”).interest(“吃”).interest(“喝”).build();创建对象:Person p=new Person().name(“xiao”).tag(“吃1”).tag(“喝1”).build();
Java 设计模式——建造者模式（创建型设计模式）
泯灭于众生，高歌于孤夜！
12-14 968
一、简介 1、定义：将一个复杂对象的构建与它的表示分离，使得同样的构建过程可以创建不同的表示 2、主要作用：在用户不知道对象的建造过程和细节的情况下就可以直接创建复杂的对象。 3、如何使用：用户只需要给出指定复杂对象的类型和内容，建造者模式负责按顺序创建复杂对象（把内部的建造过程和细节隐藏起来） 4、解决的问题： （1）、方便用户创建复杂的对象（不需要知道实现过程） （2）、代码复用性 & 封装性（将对象构建过程和细节进行封装 & 复用） 5、注意事项：与工厂模式的区别是：建造者模式更加关
提升代码优雅度！用Lombok @Builder轻松实现对象创建、默认值与动态修改
龚小帅的博客
10-10 1051
在Java中，我们常常使用构建者模式（Builder Pattern）来简化对象的创建，特别是当对象有很多属性时，传统的构造方法会变得冗长且不便于维护。为了简化构建者模式的代码，Lombok提供了一个强大的注解——@Builder。它可以帮助我们自动生成构建者模式所需的代码。在这篇博客中，我们将探讨如何使用Lombok的@Builder注解来创建对象，如何为属性设置默认值，以及如何在构建对象后修改某些属性。
lombok中@builder注解怎么使用
08-27
<think>好的，我现在需要回答用户关于Lombok中@Builder注解的使用方法的问题。首先，我需要回忆一下@Builder的作用和基本用法。@Builder是Lombok提供的一个注解，用于简化Java中构建对象的代码，特别是当对象有很多可选参数时，可以通过流式调用的方式设置属性，避免编写大量构造方法或setter方法。 首先，我应该介绍@Builder的基本使用步骤。通常，使用@Builder需要在类上添加@Builder注解，这样Lombok会生成一个内部的Builder类，包含链式方法来设置属性，最后通过build()方法创建对象。需要注意的是，@Builder默认会为类生成一个全参构造方法，并且可能需要配合其他注解如@AllArgsConstructor、@NoArgsConstructor，特别是在需要无参构造的情况下。 接下来，需要说明@Builder的常用场景，比如当类有多个可选参数时，传统的构造方法可能会导致构造方法爆炸，而@Builder可以更清晰地设置参数。同时，可能需要提到@Builder的一些参数，比如builderMethodName（自定义构建方法名）、buildMethodName（自定义build方法名）、builderClassName（自定义Builder类名）等，这些可以让用户更灵活地使用。 然后，需要注意@Builder的一些限制和常见问题。例如，@Builder生成的Builder类不会包含默认值，除非使用@Builder.Default注解来指定默认值。另外，如果类中有final字段，可能需要配合@RequiredArgsConstructor或其他注解来确保正确初始化。 还需要给出示例代码，展示如何在类上使用@Builder，以及如何通过Builder模式创建对象。比如定义一个User类，使用@Builder注解，然后通过User.builder().name("张三").age(20).build()来创建对象。 另外，可能需要提到@Builder与@Data、@AllArgsConstructor等注解的配合使用，因为有时候用户可能需要其他Lombok注解来补充功能。例如，@Builder通常需要类有一个全参构造方法，而@AllArgsConstructor可以生成这个构造方法，但如果类中有final字段，可能需要@RequiredArgsConstructor。 还要注意，当使用@Builder时，如果类中已经手动定义了构造方法，可能会影响Lombok生成的Builder类，需要确保构造方法与@Builder兼容。此外，内部类使用@Builder时的注意事项，比如静态内部类和非静态内部类的区别。 最后，总结@Builder的优势，比如代码简洁、可读性高，减少样板代码，同时提醒用户注意可能的陷阱，比如默认值处理、构造方法的影响等。 现在需要将这些思路整理成结构化的回答，并确保覆盖基本用法、参数配置、示例代码、注意事项等内容。同时，按照用户要求，在回答末尾生成3-5个相关问题。 </think>Lombok的`@Builder`注解用于**快速生成流式构建对象的工具类（Builder）**，避免手动编写繁琐的构造方法或`setter`代码，尤其适合属性较多、需灵活组合参数的类。以下是其核心用法及注意事项： ### 一、基础使用步骤 #### 1. 注解类定义 在目标类上添加`@Builder`注解，Lombok会自动生成一个静态内部`Builder`类，包含链式方法设置属性，最终通过`build()`方法创建对象。 **示例代码**： ```java import lombok.Builder; @Builder public class User { private String name; private Integer age; private String email; } ``` #### 2. 使用Builder构建对象 通过类名调用`builder()`方法获取`Builder`实例，链式调用属性设置方法（方法名与类属性名一致），最后调用`build()`生成对象： ```java User user = User.builder() .name("张三") // 设置name属性 .age(20) // 设置age属性（可选） .email("zhangsan@example.com") // 设置email属性（可选） .build(); // 最终构建User对象 ``` ### 二、关键特性与配置参数 `@Builder`支持通过注解参数自定义生成逻辑，常用参数如下： | 参数名 | 作用 | 示例 | |-----------------------|----------------------------------------------------------------------|----------------------------------------------------------------------| | `builderMethodName` | 自定义获取Builder实例的方法名（默认`builder()`） | `@Builder(builderMethodName = "create")` → 通过`User.create()`获取Builder | | `buildMethodName` | 自定义构建对象的方法名（默认`build()`） | `@Builder(buildMethodName = "done")` → 通过`builder.done()`生成对象 | | `builderClassName` | 自定义Builder类的类名（默认`UserBuilder`） | `@Builder(builderClassName = "UserCreator")` → Builder类名为`UserCreator` | | `toBuilder` | 生成一个基于当前对象的Builder（需配合`@AllArgsConstructor`） | `@Builder(toBuilder = true)` → 对象可调用`user.toBuilder()`复制并修改属性 | ### 三、处理默认值与必选参数 #### 1. 默认值设置 `@Builder`默认不会处理属性的默认值（直接赋值的默认值会被覆盖），需通过`@Builder.Default`注解显式声明： ```java @Builder public class User { private String name; @Builder.Default // 声明默认值（未设置时使用） private Integer age = 18; // 若未调用.age()，则age=18 private String email; } ``` #### 2. 必选参数强制校验 若需某些参数为必选（构建时必须设置），可配合`@NonNull`注解（Lombok或Jakarta），未设置时会抛出`NullPointerException`： ```java import jakarta.validation.constraints.NotNull; @Builder public class User { @NotNull // 必选参数 private String name; private Integer age; // 可选参数 } // 未设置name时，build()会抛出NPE User user = User.builder().age(20).build(); // 报错：name cannot be null ``` ### 四、与其他Lombok注解的配合 #### 1. 无参构造方法缺失问题 `@Builder`默认生成的Builder依赖类的**全参构造方法**（Lombok会自动生成），但如果需要无参构造（如ORM框架反序列化），需显式添加`@NoArgsConstructor`： ```java import lombok.Builder; import lombok.NoArgsConstructor; @Builder @NoArgsConstructor // 生成无参构造（与@Builder兼容） public class User { private String name; private Integer age; } ``` #### 2. 与`@Data`/`@Getter`/`@Setter`组合 `@Builder`可与`@Data`（包含`@Getter`/`@Setter`）等注解共存，不影响功能： ```java import lombok.Builder; import lombok.Data; @Data @Builder public class User { private String name; private Integer age; } ``` ### 五、注意事项 1. **属性顺序无关性**：Builder的链式调用不依赖属性顺序，可灵活设置任意属性（可选参数可省略）。 2. **不可变对象**：`@Builder`生成的对象默认是可变的（通过`setter`修改），若需不可变对象，需配合`@Value`注解（生成不可变类）。 3. **嵌套对象构建**：支持嵌套类的Builder（需内部类为静态）： ```java @Builder public class Order { @Builder // 内部类需为static（Lombok自动处理） public static class Product { private String productId; } } // 使用：Order.Product.builder().productId("123").build() ```
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值