设计模式之Builder模式

概述

Builder模式定义：将一个复杂对象的构建与它的表示分离，使得同样的构建过程可以创建不同的表示。属于创建类模式，一般来说，如果一个对象的构建比较复杂，超出构造函数所能包含的范围，就可以使用工厂模式和Builder模式，相对于工厂模式会产出一个完整的产品，Builder应用于更加复杂的对象的构建，甚至只会构建产品的一个部分。

该模式用于简化复杂对象的构造，Builder允许通过使用将值传递给父类的内部构建器对象来清楚地分解对象构造。

构建器后面隐藏对象构造的复杂性，内部静态类接受链接方法的调用。

Builder类必须使用static修饰，如果内部类不用static修饰，那么该类的实例必须依赖于外部类的一个实例，而这里本质上是希望通过内部类实例来构建外部类实例，也就是说内部类实例存在时，外部类实例是还不存在的，因而必须使用static修饰。

优势：fluent风格，代码美观，易懂。

唯一可能存在的问题就是会产生多余的Builder对象，消耗内存。然而大多数情况下Builder内部类是静态的，问题不大。

由于Builder是非线程安全的，所以如果要在Builder内部类中检查一个参数的合法性，必需要在对象创建完成之后再检查。

将一个复制对象的创建屏蔽到接口内部，用户使用时候只需要传递固定的参数，内部就会执行复杂逻辑后返回会用户需要的对象，用户不需要知道创建的细节。

实战

定义一个接口通用response实体类：

@Data
public class ResponsePo {
	private Boolean success;
    private Integer code;
    // 省略其他字段如失败响应信息errMsg, 成功时的响应数据data
    public static ResponsePo.Builder builder() {
        return new ResponsePo.Builder();
    }

    public static class Builder {
        private Boolean success;
        private Integer code;

        Builder() {
        }

        public ResponsePo.Builder success(Boolean success) {
            this.success = success;
            return this;
        }

        public ResponsePo.Builder code(Integer code) {
            this.code = code;
            return this;
        }

        public ResponsePo build() {
            return new ResponsePo(this.success, this.code);
        }
    }
}

通过增加一个静态内部类Builder，和一个静态方法，实现构建者模式。

编写Controller层接口时这样使用

@GetMapping("getUserList")
public String getUserList(@RequestBody JSONObject params) {
    ResponsePo.Builder builder = ResponsePo.builder();
    ResponsePo getUserListResp = builder.code(1).success(true).build();
    return JSONObject.toJSONString(getUserListResp);
}

实际编码时，我们根本就没有时间写如此大量的代码，可直接使用lombok工具提供的@Builder注解，参考文末。

实例

构造器的Builder模式

当遇到多个Constructor构造器参数时可考虑用构建器模式。Java构造器的三种常见方式：

1. 重叠构造器模式
   在这种模式下，你提供第一个只有必要参数的构造器，第二个构造器有一个可选参数，第三个有两个可选参数，依此类推，最后一个构造器包含所有可选参数。这种当有许多参数时，代码会很难编写，并且难以阅读。
2. JavaBean模式
   最常用。这种模式下，调用一个无参构造器来创建对象，然后调用setter方式来设置每个必要的参数，以及可选参数。这种模式在构造过程中JavaBean可能处于不一致的状态。
   这种模式也阻止把类做成不可变的可能。
3. Builder模式
   Bulider模式既能保证像重叠构造器那样的安全性，也能保证像JavaBean模式那样好的可读性。不直接生成想要的对象，而是让客户端利用所有必要的参数调用构造器，得到一个builder对象，然后客户端在builer对象上调用类似于set方法，来设置每个相关的可选参数。最后客户端调用无参build方法来生成不可变的对象。这个builder是它构建的类的静态成员类。
   builder像个构造器一样，可对其参数强加约束条件，build方法可以检验这些约束条件。
   与构造器想比，builder可以有多个可变参数，构造器就像方法一样，只有一个参数。
   Builder模式十分灵活，可以利用单个builder构建多个对象。builder的参数可以在创建对象期间进行调整，也可以随着不同的对象而改变。
   Builder模式的确也有它的不足，为了创建对象，必须创建它的构造器，还比重叠构造器模式更加冗长，因此它只在有很多参数时才使用。

Spring

• BeanDefinitionBuilder：一个允许以编程方式定义Spring Bean的类。包含几个方法，它们为AbstractBeanDefinition抽象类的相关实现设置值，如作用域，工厂方法，属性等
• SpringApplicationBuilder
• Jackson2ObjectMapperBuilder：
• org.springframework.boot.autoconfigure.r2dbc.ConnectionFactoryBuilder：

Mybatis

MyBatis中的Builder模式的类：SqlSessionFactoryBuilder、XMLConfigBuilder、XMLMapperBuilder、XMLStatementBuilder、CacheBuilder；
在Mybatis环境的初始化过程中，SqlSessionFactoryBuilder会调用XMLConfigBuilder读取所有的MybatisMapConfig.xml和所有的*Mapper.xml文件，构建Mybatis运行的核心对象Configuration对象，然后将该Configuration对象作为参数构建一个SqlSessionFactory对象。
其中XMLConfigBuilder在构建Configuration对象时，也会调用XMLMapperBuilder用于读取*Mapper文件，而XMLMapperBuilder会使用XMLStatementBuilder来读取和build所有的SQL语句。
在这个过程中，有一个相似的特点，这些Builder会读取文件或配置，然后做大量的XpathParser解析、配置或语法的解析、反射生成对象、存入结果缓存等步骤，这么多的工作都不是一个构造函数所能包括的，因此大量采用Builder模式来解决。

其他

1. 性能基础测试神器JMH的OptionsBuilder；
2. Calendar.Builder；

Calendar expiredDay = new Calendar.Builder()
        .setDate(expiredCalendar.get(Calendar.YEAR), expiredCalendar.get(Calendar.MONTH), expiredCalendar.get(Calendar.DATE))
        .setTimeOfDay(0, 0, 0).build();

拓展

lombok

@Builder注解

@Builder
@Data
public class Person {
	private String name;
	private String id;
	private String phone;
}
@Slf4j
public class Demo {
	public static void main(String[] args) {
		Person.PersonBuilder builder = Person.builder();
		builder.phone("13121325476")
		    .id("1")
		    .name("johnny").build();
		log.info(builder);
	}
}

参考Java 开发工具–Lombok介绍