JAVA设计模式分成创建型、行为型与结构型三种类型,构造者Builder设计模式,与单例模式、工厂模式、原型模式与对象池模式一样,属于创建型设计模式。
一、基本定义与构成
指将一个复杂对象的构造与它的表示分离,使同样的构建过程可以创建不同的表示,模式包含Client、Director、Builder、Product与ConcreteBuilder等四个构成要素。具体UML类图如下:
从类图分析模型元素作用:
Director(指挥者)。调用构造者Builder的部件构造逻辑创建复杂产品Product。有几种变体实现:1)通过构造函数传入builder;2)可选,提供getBuilder函数,根据参数args返回Builder实例(ConcreteBuilder1,...,ConcreteBuilderN);3)可选,提供含参数builder与参数args的build函数,实现复杂产品Product的装配(ConcreteProduct1,...,ConcreteProductN)。
Builder(构造者)。构造接口,提供装配复杂产品Product的装配方法逻辑,必须包含一个返回Product实例的无参数方法build或getProduct,根据应用场景有不同的ConcreteBuilder实现。
Product(产品)。产品接口或实现类,可能包含多个组成部件或复杂的参数逻辑,可能有若干个不同的产品对象。例如Product为汽车,可能有小汽车、电动车、重型卡车等多种车型ConcreteProduct,各自都有自己的发动机、油箱、轮胎等组成部件与组装逻辑。
ConcreteBuilder。构造者接口实现,如Product汽车场景,可能有CarBuilder(小汽车)、TruckBuilder(卡车)、ElecCarBuilder(电动车)等具体实现。CarBuilder负责装配小汽车,TruckBuilder负责装配重型卡车。
二、汽车装配案例类图
结合汽车装配生产线例子举例示意,参考《设计模式之禅》的例子。汽车工厂(应用场景client)有轿车生产线负责buildCar,有卡车生产线负责buildTruck。
汽车装配指挥者AutoDirector,根据参数与生产线(builder)生产汽车(轿车|卡车)及不同车型(自动挡、手动挡|豪华版、普通版)。具体实现也可以有CarDirector、TruckDirector等指挥者。
汽车构造者AutoBuilder,负责装配汽车。提供addEngine(装配引擎)、addFuelTank(装配油箱)、addTire(装配轮胎)等装配操作,无参数build函数负责完成整车装配。
CarBuilder实现AutoBuilder接口,负责生产轿车Car。TruckBuilder实现AutoBuilder接口,负责生产卡车Truck。
汽车是一个复杂的产品,有引擎、油箱、轮胎等构成部件,装配逻辑有一定顺序,不同型号的汽车又的部件有差异,是一个典型的构造者Builder设计模式应用场景。
三、Mabatis源码分析
通过Mybatis框架的org.apache.iibatis.builder.MapperBuilderAssistant的类源码分析,发现了两种经典的构造者Builder设计模式,一个是用标准Builder模式架构,一个采用内部内实现。
MapperBuilderAssistant类负责实例化Mapper实例,负责根据mapper的配置参数,初始化Mapper对应的参数映射ParameterMap、结果映射ResultMap、缓存支持Cache、SQL语句MappedStatement等相关对象,是应用场景中的Director(指挥者)。
3.1 产品MappedStatement的静态内部类构造者
参考MappedStatement类源码,根据用户不同需求配置,存在许多配置属性成员变量,如id、resultType、resultMap等等,具体如下图:
MappedStatement的成员变量多,用以保存配置参数,采用构造函数会导致构造函数多,且随着框架升级支持未知的功能特性而成员变量增加或变化,MappedStatement采用public静态内部类Builder实现构造者模式解决问题。代码截图如下:
在MapperBuilderAssistant类(指挥者Director)中,函数调用addMappedStatement源码如下图:
技巧提示:1)在构造函数中传入必备配置;2)Builder的buildPartA等装配函数返回Builder的this引用。
3.2 缓存产品Cache的外部类构造者
Mybatis框架支持SQL查询在本地缓存,两次相同的查询直接返回上一次查询结果集合。构造者模型由Cache(Product-产品)、MapperBuilderAssistant(Director-指挥者)与CacheBuilder(Builder-构造者)构成,构造者都没有采用接口而只有具体实现类,创建不同的Cache实现采用反射机制完成,缓存产品有SoftCache、LruCache、BlockingCache等不同实现。类图如下:
指挥者对象MapperBuilderAssistant调用函数useNewCache创建缓存产品Cache实例,函数useNewCache源代码片段如下图:
4 学习总结
构造者Builder设计模式,广泛见于JDK与开源框架源代码,在Mybatis源代码中还可以发现还有ParameterMap、ResultMapping等同样采用了该模式,但是,该模式的的采用,对比标准模式构成元素,或多或少都有少许变化。总结分析如下:
1)产品对象复杂,有不同产品线、不同型号,产品较多组成部件或配置参数,装配或配置过程可能存在较多变化;
2)构造者Builder接口定义装配逻辑,指挥者Director负责根据装配逻辑调用接口函数;
3)指挥者Director可以有多种实现,构造者Builder对象实例可以采用构造函数传入,也可以在build函数中传入,Director也可以支持getBuilder函数,根据参数创建构造者对象;
4)ConcreteBuilder与ConcreteProduct较多情况采用public静态内部类包装,一般是产品Product类包含公共静态内部Builder类方式。