如何使用 lombok 的 @Builder 注解改变对象的创建方式

简介

通过在类上添加 lombok 的 @Builder 注解，使该类可以基于建造者模式进行对象的创建

如何使用

下面让我们进入正题（如何使用 @Builder 注解），首先需要保证您的项目中的 pom.xml 文件已引入了 lombok，如下：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.20</version>
</dependency>

然后，在需要的类上加上 @Builder 注解，如下：

import lombok.Builder;
import lombok.Data;

import javax.validation.constraints.NotEmpty;

@Data
@Builder
public class UserDto {
    private Integer id;

    @NotEmpty
    private String loginName;

    @NotEmpty
    private String userName;

    @NotEmpty
    private String password;

    @NotEmpty
    private String email;

    @NotEmpty
    private String mobile;
}

Ok，这样就完成了，让我们来看看效果吧，如下：

public class UserController implements UserFacade {
    public UserDto add(UserDto userDTO) {
    	
    	...
    	
        UserDto userDto = UserDto.builder()
                .loginName("xxx")
                .userName("XXXX")
                .password("XXX123321")
                .email("XXX@annoroad.com")
                .mobile("13688661238")
                .build();
    	
    	...
    	
    }

坑

如果细心些，会发现 @Builder 修饰的类无法再使用 new 来创建对象

原因是 被 @Builder 修饰的类没有无参的构造函数

如果说只是强制我们必须使用 builder 替代 new，这个问题没什么太大影响。

但是，最大的问题在于是不是所有第三方jar包都支持 builder ？

在实战中发现使用了 @Builder 注解的 Entity，是无法结合 mybatis 完成各种数据库操作的。当我们使用 Json 将字符串转换成对象的时候也会出现问题，如下：

com.alibaba.fastjson.JSONException: default constructor not found

擦，那是不是就意味着我们没办法很好的享用 @Builder 了呢？嘿嘿，其实也很简单就是将 @NoArgsConstructor、@AllArgsConstructor 注解加在类上，如下：

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import javax.validation.constraints.NotEmpty;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class UserDto {
    private Integer id;

    @NotEmpty
    private String loginName;

    @NotEmpty
    private String userName;

    @NotEmpty
    private String password;

    @NotEmpty
    private String email;

    @NotEmpty
    private String mobile;
}

从注解的名称上来看应该不难理解它们的作用吧？

• @NoArgsConstructor ：无参构造函数
• @AllArgsConstructor ：全部参数的构造函数

心得

和朋友对“是否有必要使用 @Builder 注解”进行了一次简单的讨论，如果只是针对简单的 JavaBean 的创建，我是没有看到基于 @Builder 注解的建造者模式比传统的 new 方式有什么明显的优势。个人觉得更多的是思想上的不同，建造者模式更加符合现实世界里的逻辑，例如：如果你想生产一辆汽车，那就需要有一条负责生产汽车的流水线（Builder），基于流水线一步一步对各部件进行生产（.loginName(“xxx”)、.userName(“XXXX”) …），最终组装成一辆汽车（.build()）。而且，被 @Builder 注解修饰的类，再创建的时候使用的是链式调用的方式，整体更加清晰明了。所以，就我个人（基于目前阶段的认知）来说，还是比较倾向使用 @Builder 注解（实质是倾向使用建造者模式创建对象）。