Lombok 使用教程-@Builder | 提供 Builder 形式轻松实现对象创建

smart哥

于 2024-08-11 20:08:15 发布

阅读量504

点赞数 13

分类专栏： Lombok专题文章标签： Lombok

本文链接：https://blog.csdn.net/smart_an/article/details/141110885

版权

Lombok专题专栏收录该内容

11 篇文章 0 订阅

订阅专栏

作者简介：大家好，我是smart哥，前中兴通讯、美团架构师，现某互联网公司CTO

联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬

学习必须往深处挖，挖的越深，基础越扎实！

阶段1、深入多线程

 阶段2、深入多线程设计模式

 阶段3、深入juc源码解析

阶段4、深入jdk其余源码解析

阶段5、深入jvm源码解析

码哥源码部分

码哥讲源码-原理源码篇【2024年最新大厂关于线程池使用的场景题】

码哥讲源码【炸雷啦！炸雷啦！黄光头他终于跑路啦！】

码哥讲源码-【jvm课程前置知识及c/c++调试环境搭建】

码哥讲源码-原理源码篇【揭秘join方法的唤醒本质上决定于jvm的底层析构函数】

码哥源码-原理源码篇【Doug Lea为什么要将成员变量赋值给局部变量后再操作？】

码哥讲源码【你水不是你的错,但是你胡说八道就是你不对了！】

码哥讲源码【谁再说Spring不支持多线程事务，你给我抽他！】

终结B站没人能讲清楚红黑树的历史，不服等你来踢馆！

打脸系列【020-3小时讲解MESI协议和volatile之间的关系，那些将x86下的验证结果当作最终结果的水货们请闭嘴】

一、简介

在lombok v0.12.0中，@Builder被作为实验性功能引入。

@Builder获得了@Singular的支持，并从lombok v1.16.0开始晋升为lombok主包。

在lombok v1.16.16中增加了@Builder.Default功能。

@Builder(builderMethodName = "")从lombok v1.18.8开始是合法的（并且会抑制生成builder方法）。

从lombok v1.18.8开始，@Builder(access = AccessLevel.PACKAGE)是合法的（并将生成具有指定访问级别的构建器类、构建器方法等）。

@Builder注解可以为你的类产生复杂的构建器API。

@Builder让你自动产生让你的类可实例化所需的代码，如：

    Person.builder()
    .name("Adam Savage")
    .city("San Francisco")
    .job("Mythbusters")
    .job("Unchained Reaction")
    .build();

@Builder可以被放在一个类上，或者一个构造函数上，或者一个方法上。虽然 "在类上 "和 "在构造函数上 "的模式是最常见的使用情况，但@Builder最容易用 "方法 "的使用情况来解释。

使用@Builder注释的方法（从现在开始称为target）会导致生成以下 7 件事：

名为FooBuilder的内部静态类，具有与静态方法（称为构建器）相同的类型参数。
在构建器中： target的每个参数一个私有的非静态非final字段。
在构建器中：一个包私有无参数空构造函数。
在构建器中： target的每个参数的类似“setter”的方法：它与该参数具有相同的类型和相同的名称。它返回构建器本身，以便可以链接setter调用，如上例所示。
在构建器中：一个合理的 toString() 实现。
在包含target的类中：一个builder()方法，它可以创建一个新的builder实例。

如果该元素已经存在（不考虑参数个数并只查看名称），则每个列出的生成元素将被静默跳过。这包括构建器本身：如果该类已经存在，lombok 将简单地开始在这个已经存在的类中注入字段和方法，当然除非要注入的字段/方法已经存在。但是，您不能在构建器类上放置任何其他方法（或构造函数）来生成 lombok 注释；例如，您不能将 @EqualsAndHashCode 放在构建器类上。

@Builder可以为集合参数/字段生成所谓的 'singular'方法。这些方法只取一个元素而不是整个列表，并将该元素添加到列表中。比如说：

    Person.builder()
    .job("Mythbusters")
    .job("Unchained Reaction")
    .build();

将导致 List<String> jobs 字段中有 2 个字符串。要获得此行为，需要使用@Singular对字段/参数进行注释。该功能有自己的文档。

现在 "方法 "模式已经很清楚了，在构造函数上加上@Builder注解的功能也很类似；实际上，构造函数只是静态方法，它有一个特殊的语法来调用它们。它们的 "返回类型 "是它们构造的类，它们的类型参数与该类本身的类型参数相同。

最后，将@Builder应用到一个类中，就好像你在该类中添加了@AllArgsConstructor(access = AccessLevel.PACKAGE)，并将@Builder注解应用到这个所有参数构造函数中。这只在你没有自己编写任何显式构造函数时有效。如果你有一个显式构造函数，请把 @Builder 注解放在构造函数上，而不是放在类上。请注意，如果你把@Value和@Builder都放在一个类上，@Builder想要生成的package-private构造函数就会 “获胜”，并抑制@Value想要生成的构造函数。

如果使用@Builder生成构建器来产生你自己类的实例（除非将@Builder添加到一个不返回你自己类型的方法中，否则总是如此），你可以使用@Builder(toBuilder = true)在你的类中也生成一个名为toBuilder()的实例方法；它创建一个新的构建器，开始时使用这个实例的所有值。你可以在参数（如果是构造函数或方法）或字段（如果是类型上的@Builder）上加上@Builder.ObtainVia注解，以表明该字段/参数的值是通过其他方式从这个实例中获得的。例如，你可以指定一个要调用的方法：@Builder.ObtainVia(method = "calculateFoo")。

构建器类的名字是FoobarBuilder，其中Foobar是目标返回类型的简化、大小写形式–也就是说，在构造函数和类型上@Builder的类型名称，以及在方法上@Builder的返回类型的名称。例如，如果@Builder被应用于一个名为com.yoyodyne.FancyList<T>的类，那么构建器的名字将是FancyListBuilder<T>。如果@Builder被应用于一个返回void的方法，那么构建器将被命名为VoidBuilder。

builder的可配置方面有：

构建器的类名（默认：返回类型 + ‘Builder’）
build()方法的名称（默认值：“build”）
build()方法的名称（默认值：“build”）
如果你想要toBuilder() （默认：关闭）
所有生成元素的访问级别（默认：public）。
（不鼓励）如果您希望构建器的“set”方法具有前缀，即 Person.builder().setName("Jane").build() 而不是 Person.builder().name("Jane").build () 以及它应该是什么。

所有选项都从其默认值更改的示例用法：

    @Builder(builderClassName = "HelloWorldBuilder", buildMethodName = "execute", builderMethodName = "helloWorld", toBuilder = true, access = AccessLevel.PRIVATE, setterPrefix = "set")

想用Jackson这个JSON/XML工具来使用您的构建器？我们已经为您准备好了。请查看@Jacksonized功能。

@Builder.Default

如果某个字段/参数在构建会话中从未被设置过，那么它总是得到0 / null / false。如果你把@Builder放在一个类上（而不是一个方法或构造函数），你可以直接在字段上指定默认值，并用@Builder.Default注释该字段：

    @Builder.Default private final long created = System.currentTimeMillis();

@Singular

通过用@Singular注解对其中一个参数（如果用@Builder注解方法或构造函数）或字段（如果用@Builder注解类）进行注解，lombok将把该构建器节点视为一个集合，并生成两个 "adder "方法，而不是一个 "setter "方法。一个是向集合添加一个元素，另一个是向集合添加另一个集合的所有元素。没有生成setter，只是设置集合（替换已经添加的东西）。还会生成一个’clear‘方法。这些’singular'构建器非常复杂，以保证以下属性：

当调用build()时，产生的集合将是不可变的。
在调用build()后，调用一个’adder’方法或’clear’方法不会修改任何已经生成的对象，而且，如果build()后来被再次调用，就会生成另一个集合，其中包含自创建builder以来添加的所有元素。
所产生的集合将被压缩到最小的可行格式，同时保持高效。

@Singular只能应用于lombok已知的集合类型。目前，支持的类型有：

java.util:
- Iterable、Collection和List（在一般情况下由一个压缩的不可修改的ArrayList支持）。
- Set、SortedSet和NavigableSet（在一般情况下，由一个大小适中的不可修改的HashSet或TreeSet支持）。
- Map、SortedMap和NavigableMap（在一般情况下由一个大小适中的不可修改的HashMap或TreeMap支持）。
Guava’s com.google.common.collect:
- ImmutableCollection和ImmutableList（由ImmutableList的构建器功能支持）。
- ImmutableSet和ImmutableSortedSet（由这些类型的构建器功能支持）。
- ImmutableMap、ImmutableBiMap和ImmutableSortedMap（由这些类型的构建器功能支持）。
- ImmutableTable（由ImmutableTable的构建器功能支持）。

如果你的标识符是用普通英语写的，lombok假定任何带有@Singular的集合的名字是英语复数，并且会尝试自动将这个名字单数化。如果这是可行的，add-one方法将使用这个名字。例如，如果你的集合被称为statuses，那么add-one方法将自动被称为status。你也可以通过将单数形式作为参数传递给注解来明确指定你的标识符的单数形式，像这样：@Singular("axis") List<Line> axes;.

如果lombok不能将你的标识符单数化，或者它是模糊的，lombok将产生一个错误，并迫使你明确指定单数名称。

下面的片段没有显示lombok为@Singular字段/参数生成的内容，因为它相当复杂。你可以在这里查看一个片段。

如果同时使用setterPrefix = "with"，生成的名称是，例如：withName（添加1个名称），withNames（添加许多名称），和clearNames（重置所有名称）。

通常情况下，生成的’复数形式’方法（接收一个集合，并添加这个集合中的每个元素）会像@NonNull那样检查是否传递了null（默认情况下，抛出一个NullPointerException，并给出适当的消息）。然而，你也可以告诉lombok忽略这样的集合（因此，什么都不加，立即返回）：@Singular(ignoreNullCollections = true.

Jackson

你可以通过自己制作构建器类来定制部分构建器，例如在构建器类中添加另一个方法，或者在构建器类中注释一个方法。Lombok会生成所有你没有手动添加的东西，并把它放到这个构建器类中。例如，如果你想配置jackson来使用一个集合的特定子类型，你可以这样写：

    @Value @Builder
    @JsonDeserialize(builder = JacksonExample.JacksonExampleBuilder.class)
    public class JacksonExample {
    	@Singular(nullBehavior = NullCollectionBehavior.IGNORE) private List<Foo> foos;
    	
    	@JsonPOJOBuilder(withPrefix = "")
    	public static class JacksonExampleBuilder implements JacksonExampleBuilderMeta {
    	}
    	
    	private interface JacksonExampleBuilderMeta {
    		@JsonDeserialize(contentAs = FooImpl.class) JacksonExampleBuilder foos(List<? extends Foo> foos)
    	}
    }

二、示例比较

1. Lombok 写法

    import lombok.Builder;
    import lombok.Singular;
    import java.util.Set;
    
    @Builder
    public class BuilderExample {
      @Builder.Default private long created = System.currentTimeMillis();
      private String name;
      private int age;
      @Singular private Set<String> occupations;
    }

2. Java 标准写法

    import java.util.Set;
    
    public class BuilderExample {
      private long created;
      private String name;
      private int age;
      private Set<String> occupations;
      
      BuilderExample(String name, int age, Set<String> occupations) {
        this.name = name;
        this.age = age;
        this.occupations = occupations;
      }
      
      private static long $default$created() {
        return System.currentTimeMillis();
      }
      
      public static BuilderExampleBuilder builder() {
        return new BuilderExampleBuilder();
      }
      
      public static class BuilderExampleBuilder {
        private long created;
        private boolean created$set;
        private String name;
        private int age;
        private java.util.ArrayList<String> occupations;
        
        BuilderExampleBuilder() {
        }
        
        public BuilderExampleBuilder created(long created) {
          this.created = created;
          this.created$set = true;
          return this;
        }
        
        public BuilderExampleBuilder name(String name) {
          this.name = name;
          return this;
        }
        
        public BuilderExampleBuilder age(int age) {
          this.age = age;
          return this;
        }
        
        public BuilderExampleBuilder occupation(String occupation) {
          if (this.occupations == null) {
            this.occupations = new java.util.ArrayList<String>();
          }
          
          this.occupations.add(occupation);
          return this;
        }
        
        public BuilderExampleBuilder occupations(Collection<? extends String> occupations) {
          if (this.occupations == null) {
            this.occupations = new java.util.ArrayList<String>();
          }
    
          this.occupations.addAll(occupations);
          return this;
        }
        
        public BuilderExampleBuilder clearOccupations() {
          if (this.occupations != null) {
            this.occupations.clear();
          }
          
          return this;
        }
    
        public BuilderExample build() {
          // complicated switch statement to produce a compact properly sized immutable set omitted.
          Set<String> occupations = ...;
          return new BuilderExample(created$set ? created : BuilderExample.$default$created(), name, age, occupations);
        }
        
        @java.lang.Override
        public String toString() {
          return "BuilderExample.BuilderExampleBuilder(created = " + this.created + ", name = " + this.name + ", age = " + this.age + ", occupations = " + this.occupations + ")";
        }
      }
    }

三、支持的配置项

lombok.builder.className = [一个java标识符，带有一个可选的星号，表示返回类型名称的位置。] (默认: *Builder)
除非你用builderClassName参数明确地挑选构建器的类名，否则就会选择这个名字；名字中的任何星号都会被替换成相关的返回类型。

lombok.builder.flagUsage = [warning | error] (默认: not set)
Lombok将@Builder的任何使用标记为警告或错误（如果已配置）。

lombok.singular.useGuava = [true | false] (默认: false)
如果为true，lombok将使用guava的ImmutableXxx构建器和类型来实现java.util集合接口，而不是基于Collections.unmodifiableXxx创建实现。如果你使用这个设置，你必须确保guava在classpath和buildpath上确实可用。如果你的字段/参数有guava的ImmutableXxx类型之一，就会自动使用guava。

lombok.singular.auto = [true | false] (默认: true)
如果是true（这是默认的），lombok会自动尝试将你的标识符名称单数化，假设它是一个常见的英文复数。如果是false，你必须总是明确地指定单数名称，如果你不这样做，lombok会产生一个错误（如果你用英语以外的语言写代码，这很有用）。

四、附属说明

@Singular对java.util.NavigableMap/Set的支持只在你用JDK1.8或更高版本编译时有效。

你不能手动提供@Singular节点的部分或全部内容；lombok生成的代码对它来说太复杂了。如果你想手动控制与某些字段或参数相关的构建器代码（部分），不要使用@Singular，并手动添加你需要的一切。

排序的集合（java.util：SortedSet、NavigableSet、SortedMap、NavigableMap 和 guava: ImmutableSortedSet, ImmutableSortedMap）要求集合的类型参数具有自然顺序（实现java.util.Comparable）。没有办法在构建器中传递一个显式的比较器来使用。

如果目标集合来自java.util包，即使集合是一个set或map，ArrayList也被用来存储添加的元素作为@Singular标记字段的调用方法。因为lombok确保生成的集合是被压缩的，无论如何都必须构建一个新的set或map的支持实例，在构建过程中把数据存储为ArrayList比把它存储为map或set更有效率。这种行为在外部是不可见的，这是当前java.util对@Singular @Builder的实现细节。

当toBuilder = true应用于方法时，任何被注释的方法本身的类型参数也必须显示在返回类型中。

@Builder.Default字段上的初始化器被移除并存储在一个静态方法中，以保证如果在构建中指定一个值，这个初始化器根本不会被执行。这确实意味着初始化器不能引用this、super或任何非静态成员。如果lombok为你生成一个构造函数，它也会用初始化器初始化这个字段。

在构建器中生成的表示有@Builder.Default设置的字段叫做propertyName$value；另外还生成了一个叫做propertyName$set的布尔字段来跟踪它是否已经被设置。这是一个实现细节；不要编写与这些字段交互的代码。相反，如果你想在构建器内部的自定义方法中设置该属性，请调用生成的builder-setter方法。

关于空性的各种众所周知的注释会导致插入空检查，并将其复制到生成器的“setter”方法的参数中。有关更多信息，请参阅Getter/Setter文档的附属说明。

你可以抑制生成builder()方法，例如，因为你只想要toBuilder()的功能，通过使用。@Builder(builderMethodName = "")。当你这样做时，任何关于缺少@Builder.Default注解的警告都会消失，因为当只使用toBuilder()来生成构建器实例时，这样的警告并不相关。

你可以使用@Builder来复制构造函数：foo.toBuilder().build()会产生一个浅层克隆。如果你只是想要这个功能，可以考虑抑制构建器方法的生成，使用：@Builder(toBuilder = true, builderMethodName = "")。

由于javac处理静态导入的方式很特别，试图对静态builder()方法进行非星形静态导入是行不通的。要么使用星形静态导入。import static TypeThatHasABuilder.*;或者不要静态导入构建器方法。

如果将访问级别设置为PROTECTED，那么在构建者类内部生成的所有方法实际上都会被生成为公共的；在内部类中，protected关键字的含义是不同的，PROTECTED所表示的精确行为（允许同一包中的任何源的访问，以及来自外部类的任何子类的访问，用@Builder标记是不可能的，而将内部成员标记为public是我们可以得到的最接近的。

如果你通过lombok.config键lombok.addNullAnnotations配置了一个nullity注释的风格，任何为@Singular标记的属性生成的复数形式的构建器方法（这些复数形式的方法采取某种集合并添加所有元素）会在参数上得到一个nullity注释。你通常会得到一个非空的注释，但如果你把对作为集合传递的空的行为配置为IGNORE，则会生成一个可空的注释。

参考文献

【1】@Builder | … and Bob’s your uncle: No-hassle fancy-pants APIs for object creation!

smart哥

关注

13
点赞
踩
14

收藏

觉得还不错? 一键收藏
0
评论
Lombok 使用教程-@Builder | 提供 Builder 形式轻松实现对象创建

在中，@Builder被作为实验性功能引入。@Builder获得了@Singular的支持，并从开始晋升为lombok主包。在中增加了功能。从开始是合法的（并且会抑制生成builder方法）。从开始，是合法的（并将生成具有指定访问级别的构建器类、构建器方法等）。@Builder注解可以为你的类产生复杂的构建器API。@Builder可以被放在一个类上，或者一个构造函数上，或者一个方法上。虽然 "在类上 "和 "在构造函数上 "的模式是最常见的使用情况，但。
复制链接

扫一扫

专栏目录