使用lombok的@Builder注解导致属性默认值丢失

https://blog.youkuaiyun.com/weixin_74412978/article/details/144455221

@Builder使用遇到的坑

问题现象

问题现象大概如下面示例所示：

有一个Account对象，内部包含一个设置默认值为0的type属性，但由于使用了Builder方式构建，最终导致默认值丢失。        

1. @Builder
2. @Data
3. @AllArgsConstructor
4. @NoArgsConstructor
5. public class Account {
7.     private Long id;
9.     private String name;
11.     private String type = "0";
13. }
15. // 测试方法
16. class Main {
17.     public static void main(String[] args) {
18.         Account account = Account.builder().name("Li").id(1L).build();
19.         System.out.println(account);
20.     }
21. }

测试结果输出：

Account(id=1, name=Li, type=null)

问题分析

通过反编译@Builder注解生成的内容可以看出，问题就在于build方法。

1. public static class AccountBuilder {
2.     private Long id;
3.     private String name;
4.     private String type;
6.     AccountBuilder() {
7.     }
9.     public Account.AccountBuilder id(Long id) {
10.         this.id = id;
11.         return this;
12.     }
14.     public Account.AccountBuilder name(String name) {
15.         this.name = name;
16.         return this;
17.     }
19.     public Account.AccountBuilder type(String type) {
20.         this.type = type;
21.         return this;
22.     }
23.     
24.     public Account build() {
25.         return new Account(this.id, this.name, this.type);
26.     }
28.     public String toString() {
29.         return "Account.AccountBuilder(id=" + this.id + ", name=" + this.name + ", type=" + this.type + ")";
30.     }
31. }

解决方式

在有默认值的属性上加上@Builder.Default注解即可。

1. @Builder
2. @Data
3. @AllArgsConstructor
4. @NoArgsConstructor
5. public class Account {
7.     private Long id;
9.     private String name;
11.     @Builder.Default
12.     private String type = "0";
14. }

再次反编译后发现（已过滤掉了部分无关代码内容），其实现方式就是通过$default$type方法来完成默认值的赋值操作。

1. public class Account {
2.     private Long id;
3.     private String name;
4.     private String type;
5.     
6.     // 如果没有主动设置过type属性，则会通过调用此方法完成默认值设置
7.     private static String $default$type() {
8.         return "0";
9.     }
11.     public static Account.AccountBuilder builder() {
12.         return new Account.AccountBuilder();
13.     }
15.     public Account(Long id, String name, String type) {
16.         this.id = id;
17.         this.name = name;
18.         this.type = type;
19.     }
21.     public Account() {
22.         this.type = $default$type();
23.     }
25.     public static class AccountBuilder {
26.         private Long id;
27.         private String name;
28.         private boolean type$set;
29.         private String type$value;
31.         AccountBuilder() {
32.         }
34.         public Account.AccountBuilder id(Long id) {
35.             this.id = id;
36.             return this;
37.         }
39.         public Account.AccountBuilder name(String name) {
40.             this.name = name;
41.             return this;
42.         }
44.         public Account.AccountBuilder type(String type) {
45.             this.type$value = type;
46.             this.type$set = true;
47.             return this;
48.         }
50.         public Account build() {
51.             String type$value = this.type$value;
52.             if (!this.type$set) {
53.                 type$value = Account.$default$type();
54.             }
56.             return new Account(this.id, this.name, type$value);
57.         }
59.         public String toString() {
60.             return "Account.AccountBuilder(id=" + this.id + ", name=" + this.name + ", type$value=" + this.type$value + ")";
61.         }
62.     }
63. }

延伸思考

实际上@Builder使用还会遇到其他问题

比如如果没有@NoArgsConstructor注解，就会缺少无参的构造方法，这严重违反了代码编写规范。

• 如果只有@Data注解，会生成无参构造方法。
• 如果只有@Builder注解，会生成全属性的构造方法，但没有无参构造方法。
• 如果@Data和@Builder一起使用，哪怕你手动添加了无参构造方法或者添加了@NoArgsConstructor注解，最终在程序运行时依然会报错（编译时无问题）。
• 实际上通常情况下你必须4个注解一起加上使用@Builder、@Data、@AllArgsConstructor、@NoArgsConstructor。

关于上面这些问题，你可以说是使用者本身对于@Builder注解的理解不深，但笔者认为在实际的业务开发中，难免会因为各种各样的原因而导致问题产生，对于一个方法的使用，不单单是要要求使用者能够完全了解，更重要的是方法本身在使用时会不会出现让使用者容易忽视的条件。

替代方案

我相信大多数使用@Builder主要是因为链式编程所带来的便捷性，实际上笔者更推荐使用@Accessors，它同样可以实现链式编程，同时还可以避免多创建一个Builder对象，更重要的是可以避免@Builder的坑。

只需要通过@Accessors(chain = true)和@Data两个注解即可轻松实现。

1. //@Builder
2. //@Data
3. //@AllArgsConstructor
4. //@NoArgsConstructor
5. @Accessors(chain = true)
6. @Data
7. public class Account {
9.     private Long id;
11.     private String name;
13.     // @Builder.Default
14.     private String type = "0";
16. }
18. class Main {
19.     public static void main(String[] args) {
20. //        Account account = Account.builder().name("Li").id(1L).build();
21. //        System.out.println(account);
22.         
23.         Account ac = new Account().setId(1L).setName("Li");
24.         System.out.println(ac);
25.         
26.     }
27. }