Knowledge

QiShunwang

知识分享

Lombok中的@Builder注解

2021/6/3 18:07:03    来源:

1.前言

  今天在看项目代码的时候, 遇到了实体类上加@Builder注解, 之前在开发的时候, 一直没有用过这个注解, 便兴致勃勃地去查了一下资料, 它也是Lombok中的注解, 我们都知道Lombok的注解是在java代码进行编译时对代码进行构建. Lombok插件的出现, 使得开发人员无需写多余的重复代码, 对于java对象的创建更是提供了Builder方法, 使得开发人员在设计实体类的时候, 对外保持private setter, 而对属性的赋值采用Builder方式, 不对外公开属性的写操作, 这种方式更加优雅, 并且符合面向对象编程的封装原则.

2.pom.xml的引入

1 <dependency>
2     <groupId>org.projectlombok</groupId>
3     <artifactId>lombok</artifactId>
4     <version>1.18.12</version>
5 </dependency>

3.@Builder注解的应用

 1 /**
 2  * @author lyh
 3  * @version v-1.0.0
 4  * @since 2021/6/3
 5  */
 6 public class TestBuilder {
 7     public static void main(String[] args) {
 8         
 9         // 使用Builder注解来创建一个User实例
10         User zs = User.builder()
11                 .age(15)
12                 .name("zs").build();
13         System.out.println(zs);
14         
15         /**
16          * 修改原对象的属性值
17          * 注意: 修改实体, 要在实体的@Builder注解里面设置toBuilder = true
18          * toBuilder的默认值是false,这个可以自行去查看@Builder注解类的实现
19          * 里面有这样一行代码:
20          * boolean toBuilder() default false;
21          */
22         zs = zs.toBuilder()
23                 .age(18).build();
24         System.out.println(zs);
25        
26     }
27 }
28 
29 输出:
30 User(name=zs, age=15)
31 User(name=zs, age=18)
32 
33 Process finished with exit code 0
 1 @Builder
 2 @Getter
 3 @ToString
 4 public class User {
 5 
 6     private String name;
 7 
 8     private Integer age;
 9 
10 }

4.@Builder内部工作

  先来看一下使用@Builder注解之后, User类编译后的代码:

 1 public class User {
 2     private String name;
 3     private Integer age;
 4 
 5     User(String name, Integer age) {
 6         this.name = name;
 7         this.age = age;
 8     }
 9 
10     public static User.UserBuilder builder() {
11         return new User.UserBuilder();
12     }
13 
14     public String getName() {
15         return this.name;
16     }
17 
18     public Integer getAge() {
19         return this.age;
20     }
21 
22     public String toString() {
23         return "User(name=" + this.getName() + ", age=" + this.getAge() + ")";
24     }
25 
26     public static class UserBuilder {
27         private String name;
28         private Integer age;
29 
30         UserBuilder() {
31         }
32 
33         public User.UserBuilder name(String name) {
34             this.name = name;
35             return this;
36         }
37 
38         public User.UserBuilder age(Integer age) {
39             this.age = age;
40             return this;
41         }
42 
43         public User build() {
44             return new User(this.name, this.age);
45         }
46 
47         public String toString() {
48             return "User.UserBuilder(name=" + this.name + ", age=" + this.age + ")";
49         }
50     }
51 }

  通过上面编译后的User类代码可以看到@Builder的内部工作结果:

  1. 创建了一个名为UserBuilder的静态内部类, 并且具有和实体类相同的属性(称为构建器).

  2. 在构建器中: 对于目标类中的所有的属性, 都会在构建器中创建对应的属性.

  3. 在构建器中: 创建一个无参的default构造方法.

  4. 在构建器中: 对于实体类中的每个参数, 都会对应创建类似于setter方法, 但是方法名是与该参数名是相同的, 并且返回值是构建器本身(便于链式调用).

  5. 在构建器中: 一个build方法, 调用此方法, 就会根据设置的值进行创建对象实例.

  6. 在构建器中: 同时也会生成一个toString() 方法.

  7. 在构建器中: 会创建一个builder()方法, 它的目的是用来创建构建器.

文章引用:http://www.qishunwang.net/knowledge_show_146792.aspx