Lombok的Builder与构造者模式

1. 简介

在Lombok初遇，我们简单的介绍了一下Lombok的使用。

其中有一个@Builder注解，这个注解和构造者模式有什么关系呢？

2. 构造者模式

建造者模式(Builder Pattern)：将一个复杂对象的构建与它的表示分离，使得同样的构建过程可以创建不同的表示，建造者模式是一种对象创建型模式。

1. 抽象建造者(Builder): 是一个抽象接口，为了创建一个产品对象的各个部件 ，主要是创建组件createXX,和获取最终复杂对象getProduct
2. 实际的建造者(ConcreteBuilder)：实现Builder接口，实现各个部件的建造方法，返回创建好的复杂对象
3. 实际产品(Product)：要生成的复杂对象类，包含多个部件
4. 指挥者(Director):负责控制Builder生产部件的顺序

类图，大概是下面这个样子：

3. Lombok Builder

构造模式更像是学院派的东西，实际上更常使用的是Lombok Builder的这种模式：

1. 通过一个public static class Builder的内部类，持有要构建对象的所有属性
2. 设置属性的方法都返回Builder当前实例this，这样可以流式设置属性，用起来更加方便
3. 提供一个static的Builder方法，方便用户获取Builder对象
4. 用户通过builder对象自定义设置属性
5. 提供build方法，创建最终对象

不仅Lombok这么玩，很多第三方库都这么玩，如：Spring、Mybatis、Curator

下面我们看一下Lombok的Builder到底生成了什么代码，首先看实体类：

import lombok.Builder;

@Builder
public class User {

    private Integer id;
    private String name;
    private Integer age;
    private String sex;

}

使用delombok查看一下生成的User类：

java -jar lombok.jar delombok -p E:\workspace\capital\data-learn\src\main\java\vip\mycollege\lombok\User.java

生成的User类：

public class User {
    private Integer id;
    private String name;
    private Integer age;
    private String sex;

    @java.lang.SuppressWarnings("all")
    User(final Integer id, final String name, final Integer age, final String sex) {
        this.id = id;
        this.name = name;
        this.age = age;
        this.sex = sex;
    }


    @java.lang.SuppressWarnings("all")
    public static class UserBuilder {
        @java.lang.SuppressWarnings("all")
        private Integer id;
        @java.lang.SuppressWarnings("all")
        private String name;
        @java.lang.SuppressWarnings("all")
        private Integer age;
        @java.lang.SuppressWarnings("all")
        private String sex;

        @java.lang.SuppressWarnings("all")
        UserBuilder() {
        }

        @java.lang.SuppressWarnings("all")
        public User.UserBuilder id(final Integer id) {
            this.id = id;
            return this;
        }

        @java.lang.SuppressWarnings("all")
        public User.UserBuilder name(final String name) {
            this.name = name;
            return this;
        }

        @java.lang.SuppressWarnings("all")
        public User.UserBuilder age(final Integer age) {
            this.age = age;
            return this;
        }

        @java.lang.SuppressWarnings("all")
        public User.UserBuilder sex(final String sex) {
            this.sex = sex;
            return this;
        }

        @java.lang.SuppressWarnings("all")
        public User build() {
            return new User(this.id, this.name, this.age, this.sex);
        }

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        public java.lang.String toString() {
            return "User.UserBuilder(id=" + this.id + ", name=" + this.name + ", age=" + this.age + ", sex=" + this.sex + ")";
        }
    }

    @java.lang.SuppressWarnings("all")
    public static User.UserBuilder builder() {
        return new User.UserBuilder();
    }
}

这样使用起来就非常方便了：

User user = User.builder().id(1).age(20).sex("male").name("tim").build();

不用通过一个setter方法，一个setter方法去调用。

4. Lombok @Builder.Default

如果有默认值该怎么办？

例如，sex默认是unkonwn：

private String sex = "unkonwn";

记住要添加@Builder.Default注解，否则无效：

@Builder.Default
private String sex = "unkonwn";