设计模式学习笔记 - 设计模式与范式 - 创建型：6.建造者模式：详解构造函数、set方法、建造者三种对象创建方式

概述

本章学习一个比较常用的创建型设计模式，Builder 模式，中文翻译为建造者模式或构建者模式，也有人叫它生成器模式。

建造者模式的原理和代码实现非常简单，掌握起来并不难，难点在于应用场景。比如，你有没有考虑过这样几个问题：

• 直接使用构造函数或者配合 set 方法就能创建对象，为什么还需要建造者模式来创建呢？
• 建造者模式和工厂模式都可以创建对象，它们的区别在哪里呢？

---

为什么还需要建造者模式来创建呢？

在日常开发中，创建一个对象最常用的方式是，使用 new 关键字调用类的构造函数来完成。那什么情况下这种方式就不适用了，需要采用建造者模式来创建对象呢？

假如有这样一道设计模式面试题：我们需要资源池配置类 ResourcePoolConfig。在这个资源池配置类中，有以下几个可配置项。请编写代码实现这个 ResourcePoolConfig 类。

成员变量	解释	是否必填	默认值
name	资源名称	是	没有
maxTotal	最大总资源数量	否	8
maxIdle	最大空闲资源数量	否	8
minIdle	最小空闲资源数量	否	0

实现这样一个类并不是件难事。最常见、最容易想到的实现思路的代码如下所示。因为 maxTotal、maxIdle、minIdle 不是必填变量，所以在创建 ResourcePoolConfig 对象的时候，我们通过往构造函数中，给这几个参数传递 null 值，来表示使用默认值。

public class ResourcePoolConfig {
    private static final int DEFAULT_MAX_TOTAL = 8;
    private static final int DEFAULT_MAX_DILE = 8;
    private static final int DEFAULT_MIN_DILE = 0;
    
    private String name;
    private int maxTotal = DEFAULT_MAX_TOTAL;
    private int maxIdle = DEFAULT_MAX_DILE;
    private int minIdle = DEFAULT_MIN_DILE;

    public ResourcePoolConfig(String name, Integer maxTotal, Integer maxIdle, Integer minIdle) {
        if (StringUtils.isEmpty(name)) {
            throw new IllegalArgumentException("name should not be empty");
        }
        this.name = name;
        if (maxTotal != null) {
            if (maxTotal < 0) {
                throw new IllegalArgumentException("maxTotal should not be positive");
            }
            this.maxTotal = maxTotal;
        }
        if (maxIdle != null) {
            if (maxIdle < 0) {
                throw new IllegalArgumentException("maxIdle should not be positive");
            }
            this.maxIdle = maxIdle;
        }
        if (minIdle != null) {
            if (minIdle < 0) {
                throw new IllegalArgumentException("minIdle should not be positive");
            }
            this.minIdle = minIdle;
        }
    }
    // 省略getter方法...
}

现在 ResourcePoolConfig 只有 4 个可配置项，对应到构造函数，只有 4 个参数，参数的个数不多。但是，如果可配置项逐渐增多，变成 8 个、10 个，甚至更多，那继续沿用现在的设计思路，构造函数的参数列表会变得很长，代码在可读性和易用性上都会变差。使用构造函数的时候，容易搞错各种参数的顺序，传递进错误的参数值，导致非常隐藏的 bug。

// 参数太多，导致可读性差、参数可能传递错误
ResourcePoolConfig config = new ResourcePoolConfig("dbconnectionpool",16,null,8,null, 
	false , true, 10, 20，false， true);

解决这个问题的办法你应该已经想到了，那就是用 set() 函数来给成员变量赋值，以替代冗长的构造函数。代码具体如下所示。其中，配置项 name 是必填的，所以我们把它放到构造函数中设置，强制创建类对象的时候就要填写。其他配置项 maxTotal、maxIdle、minIdle 都不是必填的，所以我们通过 set() 函数来设置，让使用者自主选择填写或不填写。

public class ResourcePoolConfig {
    private static final int DEFAULT_MAX_TOTAL = 8;
    private static final int DEFAULT_MAX_DILE = 8;
    private static final int DEFAULT_MIN_DILE = 0;

    private String name;
    private int maxTotal = DEFAULT_MAX_TOTAL;
    private int maxIdle = DEFAULT_MAX_DILE;
    private int minIdle = DEFAULT_MIN_DILE;

    public ResourcePoolConfig(String name) {
        if (StringUtils.isEmpty(name)) {
            throw new IllegalArgumentException("name should not be empty");
        }
        this.name = name;
    }

    public void setMaxTotal(Integer maxTotal) {
        if (maxTotal != null) {
            if (maxTotal < 0) {
                throw new IllegalArgumentException("maxTotal should not be positive");
            }
            this.maxTotal = maxTotal;
        }
    }

    public void setMaxIdle(Integer maxIdle) {
        if (maxIdle != null) {
            if (maxIdle < 0) {
                throw new IllegalArgumentException("maxIdle should not be positive");
            }
            this.maxIdle = maxIdle;
        }
    }

    public void setMinIdle(Integer minIdle) {
        if (minIdle != null) {
            if (minIdle < 0) {
                throw new IllegalArgumentException("minIdle should not be positive");
            }
            this.minIdle = minIdle;
        }
    }
    // 省略getter方法...
}

接下来，来看新的 ResourcePoolConfig 类该如何使用。我写了一个实例代码，如下所示。没有冗长的函数调用和参数列表，代码在可读性和易用性上提高看很多。

ResourcePoolConfig config = new ResourcePoolConfig("dbconnectionpool");
config.setMaxTotal(16);
config.setMaxIdle(8);

到此，我们仍然没有用到建造者模式，通过构造函数设置必填项，通过 set() 函数设置可选配置项，就能实现需求。如果把问题难度在放大一点，比如，需要解决下面这三种问题，那现在的设计思路就不能满足了。

• 刚刚讲到 name 是必填的，所以，把它放到构造函数中，强制创建对象的时候设置。如果必填的配置项很多，把这些必填配置项放到构造函数中设置，那构造函数就又会出现参数列表很长的问题。如果把必填项也通过 set() 函数设置，那校验这些必填项是否已经填写的逻辑就无处安放了。
• 此外，假设配置项之间有一定的依赖关系，比如，用户设置了 maxTotal、maxIdle、minIdle 其中的一个，就必须显式的设置另外两个；或者配置项之间有一定的约束条件，比如 maxIdle 和 minIdle 要小于等于 maxTotal。如果我们继续使用现在的设计思路，那这些配置项之间的依赖关系或者约束条件的逻辑就无处安放了。
• 如果我们希望 ResourcePoolConfig 类对象是不可变对象，也就是说，对象在创建好之后，就不能再修改内部的属性值。要实现这个功能，就不能在 ResourcePoolConfig 中暴露 set() 方法。

为了解决这些问题，建造者模式就派上用场了。

我们可以把校验逻辑放到 Builder 类中，先创建建造者，并通过 set() 方法设置建造者的变量值，然后再使用 build() 方法在真正创建对象之前，做集中的校验，校验通过之后才会创建对象。此外，我们把 ResourcePoolConfig 的构造函数又改为 private 私有权限。这样我们就只能通过建造者来创建 ResourcePoolConfig 类对象。并且，ResourcePoolConfig 没有提供任何 set() 方法，这样我们创建出来的对象就是不可变对象了。

使用建造者模式实现上面的需求，代码如下所示：

public class ResourcePoolConfig {
    private String name;
    private int maxTotal;
    private int maxIdle;
    private int minIdle;

    public ResourcePoolConfig(Builder builder) {
        this.name = builder.name;
        this.maxTotal = builder.maxTotal;
        this.maxIdle = builder.maxIdle;
        this.minIdle = builder.minIdle;
    }
    // 省略getter方法...

    // 将Builder类设计成了ResourcePoolConfig的内部类
    // 也可以将Builder设计成独立的非内部类ResourcePoolConfigBuilder
    public static class Builder {
        private static final int DEFAULT_MAX_TOTAL = 8;
        private static final int DEFAULT_MAX_DILE = 8;
        private static final int DEFAULT_MIN_DILE = 0;

        private String name;
        private int maxTotal = DEFAULT_MAX_TOTAL;
        private int maxIdle = DEFAULT_MAX_DILE;
        private int minIdle = DEFAULT_MIN_DILE;

        public ResourcePoolConfig build() {
            // 将校验逻辑放到这里来做，包括必填项校验、依赖关系校验、约束条件校验等
            if (StringUtils.isEmpty(name)) {
                throw new IllegalArgumentException("...");
            }
            if (maxIdle > maxTotal) {
                throw new IllegalArgumentException("...");
            }
            if (minIdle > maxTotal || minIdle > maxIdle) {
                throw new IllegalArgumentException("...");
            }
            return new ResourcePoolConfig(this);
        }

        public Builder setName(String name) {
            if (StringUtils.isBlank(name)) {
                throw new IllegalArgumentException("...");
            }
            this.name = name;
            return this;
        }

        public Builder setMaxTotal(int maxTotal) {
            if (maxTotal < 0) {
                throw new IllegalArgumentException("...");
            }
            this.maxTotal = maxTotal;
            return this;
        }

        public Builder setMaxIdle(int maxIdle) {
            if (maxIdle < 0) {
                throw new IllegalArgumentException("...");
            }
            this.maxIdle = maxIdle;
            return this;
        }

        public Builder setMinIdle(int minIdle) {
            if (minIdle < 0) {
                throw new IllegalArgumentException("...");
            }
            this.minIdle = minIdle;
            return this;
        }
    }
}

// 这段代码会抛出IllegalArgumentException，因为minIdle>maxIdle
ResourcePoolConfig config = new Builder()
        .setName("dbconnectionpool")
        .setMaxTotal(16)
        .setMaxTotal(8)
        .setMinIdle(10)
        .build();

实际上，使用建造者模式创建对象，还能避免对象存在无效状态。再来举个例子解释下。比如我们定义了一个长方形类，如果不使用建造者模式，采用先创建后 set 的方式，那就回导致在第一个 set 之后，对象处于无效状态。具体代码如下所示：

Rectangle r = new Rectangle(); // r is invalid
r.setWidth(2); // r is invalid
r.setHeignt(3); // r is valid

为了避免这种无效状态的存在，我们就需要使用构造函数一次性初始化好所有的成员变量。如果构造函数参数过多，就需要考虑使用建造者模式，先设置建造者变量，然后再一次性地创建对象，让对象一直处于有效状态。

实际上，如果我们并不是很关心对象是否有短暂的无效状态，也不是太在意对象是否是可变的。比如，对象只是用来映射数据库读出来的数据，那我们直接暴露 set() 方法来设置类的成员变量值是完全没问题的。而且，使用建造者模式来构建对象，代码实际上是有点重复的， ResourcePoolConfig 类中的成员变量，要在 Builder 类中重新再定义一遍。

建造者模式和工厂模式的区别在哪里？

建造者模式是让建造者类来负责对象的创建工作。工厂模式中的工厂类也是负责对象的创建工作。那它们之间有什么区别呢？

实际上，工厂模式是用来创建不同但是相关类型的对象（继承同一父类或者接口的一组子类），由给定的参数来决定创建哪种类型的对象。建造者模式是用来创建一种类型的复杂对象，通过设置不同的可选参数，“定制化” 地创建不同的对象。

网上有一个很经典的例子，很好地解释了两者的区别。
顾客走进一家餐馆点餐，利用工厂模式根据用户不同的选择，来制作不同的食物，比如披萨、汉堡、沙拉。对于披萨来说，用户又有各种配料可以定制，比如奶酪、西红柿、起司，可以通过建造者模式根据用户选择的不同配料来制作披萨。

实际上，我们没必要非得把工厂模式、建造者模式分得那么清楚，我们需要知道的是，每个设计模式为什么这么设计，能解决什么问题。只有了解了这些最本质的东西，我们才能不生搬硬套，才能灵活应用，甚至可以混用各种模式创造出新的模式，来解决特定场景的问题。

回顾

建造者模式的原理和实现比较简单，重点是掌握应用场景，避免过度设计。

如果一个类中有很多属性，为了避免构造函数的参数列表过长，影响代码的可读性和易用性，可以通过构造函数配合 set() 方法来解决。但是，如果存在下面任何一种情况，就要考虑使用建造者模式了。

• 我们把类的必填属性放到构造函数中，强制创建对象的时候就设置。如果必填的属性很多，把这些必填属性都放到构造函数中设置，那构造函数就又会出现参数列表过长的问题。如果我们把必填属性通过 set() 方法设置，那校验这些必填属性是否已经填写的逻辑就无处安放了。
• 如果类的属性之间有一定的依赖关系或者约束条件，我们继续使用构造函数配合 set() 方法的设计思路，那这些依赖关系或者约束条件的校验逻辑就无处安放了。
• 如果希望创建不可变对象，即对象创建好之后，就不能再修改其内部的属性值，要实现这个功能，我们就不能暴露 set() 方法。构造函数配合 set() 方法来设置属性值的方式就不适用了。

另外，本章还对比了工厂模式和建造者模式的区别。

• 工厂模式是用来创建不同但是相关类型的对象（继承同一父类或接口的一组子类），由给定参数决定创建哪种类型的对象。
• 建造者模式是用来创建一种类型的对象，可以通过设置不同的可选参数，“定制化” 地创建不同的对象。