lombok 基础注解之 @Builder

最全的 lombok 注解详情（随着版本不定时更新）

一、注解介绍

@Builder 注解为类生成相对略微复杂的构建器 API

它作用于类，将其变成建造者模式
可以以链的形式调用
初始化实例对象生成的对象是不可以变的，可以在创建对象的时候进行赋值
如果需要在原来的基础上修改可以加 set 方法，final 字段可以不需要初始化
它会生成一个全参的构造函数

二、属性介绍

@Builder.Default：非 final 的字段可以有默认值
builderMethodName：指定创建内部静态类的方法名，默认值为 builder
buildMethodName：指定创建实体类的方法名，默认值为 build
builderClassName：指定内部静态的类名，默认值为 “”，默认创建的类名为 thisclassBuilder
toBuilder：设置为 true 可以对这个对象进行拷贝生成新的对象，可以再修改，默认为 false
access：设置 builderMethodName 的访问权限修饰符，默认为 public
共有 PUBLIC、MODULE、PROTECTED、PACKAGE、PRIVATE，其中 MODULE 是 Java 9 的新特性
setterPrefix：设置 setter 方法的前缀，默认为 “”

三、实战演练

@Builder(builderMethodName = "builder", buildMethodName = "build", builderClassName = "",toBuilder = true, access = AccessLevel.PUBLIC, setterPrefix = ""
)
public class Yifei {@Builder.Defaultprivate String name = "刘亦菲";private String sex;private final Integer age = 18; // final 字段加不加 Default 都可以初始化成功public static void main(String[] args) {Yifei yifei = Yifei.builder().build();  // 如果没有加 Default，那么输出的 name 结果是 null。/*** 类似于拷贝，修改了 name 值，age 值还是原来的* 如果 toBuilder = false，则没有 toBuilder 方法*/yifei = yifei.toBuilder().name("刘亦菲").build();}
}

我们在平时开发中经常会用到泛型，而 @Builder 也支持指定泛型构建

@Builder
public class Yifei<T> {public void yiyang(Yifei<T> yi) {yi = Yifei.<T>builder().builder();}
}

@Builder 会生成一个全参构造方法，因此就没有了无参构造方法，但当我们遇到需要无参构造方法时就会发生问题，这个时候手写或者加上 @NoArgsConstructor 都会报错，两种解决方案

一、加上 @AllArgsConstructor

@Builder
@AllArgsConstructor
public class Yifei {public Yifei() {/*** 手写或者 @NoArgsConstructor 都会使 @Builder 生成的全参构造函数失效* 这个时候就被报错，加上 @AllArgsConstructor 或者手写一个全参构造函数即可*/}
}

二、使用 @Tolerate 注解

四、属性拓展

lombok 基础注解之 @Builder.ObtainVia

五、@Builder 内部做了什么

创建一个名为 ThisClassBuilder 的内部静态类，并具有和实体类相同的属性（称为构建器）
在构建器中：对于目标类中的所有的属性和未初始化的 final 字段，都会在构建器中创建对应属性
在构建器中：创建一个无参的 default 构造函数
在构建器中：实体类中的每个参数，都会对应创建类似于 setter 的方法，方法名与该参数名相同。并且返回值是构建器本身（便于链式调用）
在构建器中：会创建一个 build 方法，调用 build 方法，就会根据设置的值进行创建实体对象
在构建器中：会生成一个 toString 方法
在实体类中：会创建一个 builder 方法，它的目的是用来创建构建器

@Builder
public class User {private String username;private String password;
}

编译后

public class User {private String username;private String password;User(String username, String password) {this.username = username;this.password = password;}public static User.UserBuilder builder() {return new User.UserBuilder();}public static class UserBuilder {private String username;private String password;UserBuilder() {}public User.UserBuilder username(String username) {this.username = username;return this;}public User.UserBuilder password(String password) {this.password = password;return this;}public User build() {return new User(this.username, this.password);}public String toString() {return "User.UserBuilder(username=" + this.username + ", password=" + this.password + ")";}}
}

lombok 基础注解之 @Builder相关推荐

lombok 基础注解之 @AllArgsConstructor
最全的 lombok 注解详情(随着版本不定时更新) 一.注解介绍作用于类,生成一个参数为所有实例变量的构造方法二.属性介绍 staticName:使生成的构造方法是私有的,默认值 "& ...
lombok 基础注解之 @EqualsAndHashCode
最全的 lombok 注解详情(随着版本不定时更新) 一.注解介绍作用于类,覆盖默认的 equals 和 hashCode 二.属性介绍 exclude:通过该属性可以排除某些字段 of:通过该属性 ...
lombok 基础注解之 @NonNull
最全的 lombok 注解详情(随着版本不定时更新) 一.注解介绍作用于成员变量和参数中,标识变量不能为空,否则抛出空指针异常二.实战演练 @Setter @Getter public class ...
20190905 Lombok常用注解
Lombok常用注解 val 用于声明类型,将从初始化表达式推断出类型,仅适用于局部变量和foreach循环,而不适用于字段.声明的局部变量为final变量. Java自带类型推断随着JDK版本提升越 ...
springboot依赖lombok插件、lombok常用注解
--springboot依赖lombok插件.lombok常用注解 1 lombok插件 1.1 lombok插件简介官方介绍如下: 意思是:lombok是一个能自动插入到编辑器和构建工具的java ...
夯实 Java 基础 - 注解
夯实 Java 基础 - 注解不知道大家有没有一种感觉,当你想要了解某个知识点的时候,就会发现好多技术类 APP 或者公众号在推一些关于这个知识点的文章.也许这就是大数据的作用,这也说明总有人比你抢 ...
java builder父类,解决Lombok父类与子类Builder不兼容
Lombok 是我们经常使用的插件,@Builder也是我们经常使用的注解,那你有没有遇见过如下错误呢? 父类与子类 Builder不兼容场景 Error:(16, 1) java: com.jdcl ...
Spring基础专题——第十章（基础注解编程——下）
目标,去年一年比较懒吧,所以今年我希望我的知识可以分享给正在奋斗中的互联网开发人员,以及未来想往架构师上走的道友们我们一起进步,从一个互联网职场小白到一个沪漂湿人,一路让我知道分享是一件多么重要的事情 ...
Spring基础专题——第九章（基础注解编程——上）
目标,去年一年比较懒吧,所以今年我希望我的知识可以分享给正在奋斗中的互联网开发人员,以及未来想往架构师上走的道友们我们一起进步,从一个互联网职场小白到一个沪漂湿人,一路让我知道分享是一件多么重要的事情 ...

lombok 基础注解之 @Builder

最全的 lombok 注解详情（随着版本不定时更新）

一、注解介绍

二、属性介绍

三、实战演练

我们在平时开发中经常会用到泛型，而 @Builder 也支持指定泛型构建

@Builder 会生成一个全参构造方法，因此就没有了无参构造方法，但当我们遇到需要无参构造方法时就会发生问题，这个时候手写或者加上 @NoArgsConstructor 都会报错，两种解决方案

一、加上 @AllArgsConstructor

二、使用 @Tolerate 注解

四、属性拓展

五、@Builder 内部做了什么

编译后

lombok 基础注解之 @Builder相关推荐

最新文章

热门文章