mybatis-建造者模式

mybatis-建造者模式

       定义：指将一个复杂对象的构造与它的表示分离，使同样的构建过程可以创建不同的表示，这样的设计模式被称为建造者模式。它是将一个复杂的对象分解为多个简单的对象，然后一步一步构建而成。它将变与不变相分离，即产品的组成部分是不变的，但每一部分是可以灵活选择的。
优点

1. 封装性好，构建和表示分离。
2. 扩展性好，各个具体的建造者相互独立，有利于系统的解耦。
3. 客户端不必知道产品内部组成的细节，建造者可以对创建过程逐步细化，而不对其它模块产生任何影响，便于控制细节风险。

缺点

1. 产品的组成部分必须相同，这限制了其使用范围。
2. 如果产品的内部变化复杂，如果产品内部发生变化，则建造者也要同步修改，后期维护成本较大。

异同
1.建造者模式和工厂模式的区别

1. 建造者模式更加注重方法的调用顺序，工厂模式注重创建对象。
2. 创建对象的力度不同，建造者模式创建复杂的对象，由各种复杂的部件组成，工厂模式创建出来的对象都一样
3. 关注重点不一样，工厂模式只需要把对象创建出来就可以了，而建造者模式不仅要创建出对象，还要知道对象由哪些部件组成。
4. 建造者模式根据建造过程中的顺序不一样，最终对象部件组成也不一样。

模式的结构
建造者（Builder）模式的主要角色如下。

• 产品角色（Product）：它是包含多个组成部件的复杂对象，由具体建造者来创建其各个零部件。
• 抽象建造者（Builder）：它是一个包含创建产品各个子部件的抽象方法的接口，通常还包含一个返回复杂产品的方法 getResult()。
• 具体建造者(Concrete Builder）：实现 Builder 接口，完成复杂产品的各个部件的具体创建方法。
• 指挥者（Director）：它调用建造者对象中的部件构造与装配方法完成复杂对象的创建，在指挥者中不涉及具体产品的信息。
  

应用场景
       建造者模式唯一区别于工厂模式的是针对复杂对象的创建。也就是说，如果创建简单对象，通常都是使用工厂模式进行创建，而如果创建复杂对象，就可以考虑使用建造者模式。当需要创建的产品具备复杂创建过程时，可以抽取出共性创建过程，然后交由具体实现类自定义创建流程，使得同样的创建行为可以生产出不同的产品，分离了创建与表示，使创建产品的灵活性大大增加.
       建造者模式主要适用于以下应用场景：

1. 相同的方法，不同的执行顺序，产生不同的结果。
2. 多个部件或零件，都可以装配到一个对象中，但是产生的结果又不相同。
3. 产品类非常复杂，或者产品类中不同的调用顺序产生不同的作用。
4. 初始化一个对象特别复杂，参数多，而且很多参数都具有默认值。

【例1】用建造者（Builder）模式描述客厅装修。
       分析：客厅装修是一个复杂的过程，它包含墙体的装修、电视机的选择、沙发的购买与布局等。客户把装修要求告诉项目经理，项目经理指挥装修工人一步步装修，最后完成整个客厅的装修与布局，所以本实例用建造者模式实现比较适合。
       这里客厅是产品，包括墙、电视和沙发等组成部分。具体装修工人是具体建造者，他们负责装修与墙、电视和沙发的布局。项目经理是指挥者，他负责指挥装修工人进行装修。
       另外，客厅类中提供了 show() 方法，可以将装修效果图显示出来（点此下载装修效果图的图片）。客户端程序通过对象生成器类 ReadXML 读取 XML 配置文件中的装修方案数据（点此下载 XML 文件），调用项目经理进行装修。其类图如图 2 所示。

在mybatis中的使用
       XMLMapperBuilder:解析 mapper.xml的配置
       XMLConfigBuilder：解析 myabtis-config的配置文件
       XMLStatementBuilder：映射sql文件中的节点
       SqlSourceBuilder：解析sql语句
       MapperBuilderAssistant：辅助XMLMapperBuilder解析mapper.xml文件，完善属性信息，并注册到configuration对象（单一职责原则）
       BaseBuilder：
XMLMapperBuilder

public void parse() {
  //是否第一次加载 第一次加载就解析这个xml文件
  if (!configuration.isResourceLoaded(resource)) {
    //第一次加载时完整加载
    configurationElement(parser.evalNode("/mapper"));
    //记录已加载当前的配置文件
    configuration.addLoadedResource(resource);
    //把mapper和namespace绑定 注册mapper接口
    bindMapperForNamespace();
  }
  //处理ResultMap节点
  parsePendingResultMaps();
  //处理CacheRef节点
  parsePendingCacheRefs();
  //处理Sql语句节点
  parsePendingStatements();
}

XMLConfigBuilder

//解析这个 xmlConfig 配置文件，
private void parseConfiguration(XNode root) {
  try {
    // issue #117 read properties first
    //首先读取 congfig 文件中的引用属性
    propertiesElement(root.evalNode("properties"));
    //加载配置变量
    Properties settings = settingsAsProperties(root.evalNode("settings"));
    //可以加载自定义的虚拟文件系统应用程序
    loadCustomVfs(settings);
    //加载日志实现类
    loadCustomLogImpl(settings);
    //它有两种定义方式，一种是直接定义一个类的别名，一种就是指定一个包，
    // 那么这个package 下面所有的类的名字就会成为这个类全路径的别名。
    //类的别名和类的关系，我们放在一个TypeAliasRegistry 对象里面。
    typeAliasesElement(root.evalNode("typeAliases"));
    //配置插件
    pluginElement(root.evalNode("plugins"));
    //解析<objectFactory>节点
    objectFactoryElement(root.evalNode("objectFactory"));
    objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
    reflectorFactoryElement(root.evalNode("reflectorFactory"));
    //加载一些其他的配置
    settingsElement(settings);
    //加载数据源环境和数据源
    // read it after objectFactory and objectWrapperFactory issue #631
    environmentsElement(root.evalNode("environments"));
    //不同厂商的数据映射
    databaseIdProviderElement(root.evalNode("databaseIdProvider"));
    //映射类型处理器，sql 和实体类的映射
    typeHandlerElement(root.evalNode("typeHandlers"));
    //解析<mappers>节点 处理mapper配置文件
    mapperElement(root.evalNode("mappers"));
  } catch (Exception e) {
    throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
  }
}

XMLStatementBuilder

public void parseStatementNode() {
  String id = context.getStringAttribute("id");//获取标签的唯一id
  String databaseId = context.getStringAttribute("databaseId");//获取数据库厂商

  if (!databaseIdMatchesCurrent(id, databaseId, this.requiredDatabaseId)) {
    return;
  }

  String nodeName = context.getNode().getNodeName();//获取 xml标签中的名字 INSTER UPDATE SELECT DELETE
  //转换为枚举类型
  SqlCommandType sqlCommandType = SqlCommandType.valueOf(nodeName.toUpperCase(Locale.ENGLISH));
  boolean isSelect = sqlCommandType == SqlCommandType.SELECT;//是不是 select
  boolean flushCache = context.getBooleanAttribute("flushCache", !isSelect);
  boolean useCache = context.getBooleanAttribute("useCache", isSelect);
  boolean resultOrdered = context.getBooleanAttribute("resultOrdered", false);

  // Include Fragments before parsing
  XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);
  includeParser.applyIncludes(context.getNode());

  //获取参数类类型
  String parameterType = context.getStringAttribute("parameterType");
  Class<?> parameterTypeClass = resolveClass(parameterType);

  //处理语言驱动
  String lang = context.getStringAttribute("lang");
  LanguageDriver langDriver = getLanguageDriver(lang);

  // Parse selectKey after includes and remove them.
  //包含之后解析selectKey并将其删除
  processSelectKeyNodes(id, parameterTypeClass, langDriver);

  // Parse the SQL (pre: <selectKey> and <include> were parsed and removed)
  // 解析SQL（之前：已解析并删除了<selectKey>和<include>）
  KeyGenerator keyGenerator;
  String keyStatementId = id + SelectKeyGenerator.SELECT_KEY_SUFFIX;
  keyStatementId = builderAssistant.applyCurrentNamespace(keyStatementId, true);
  if (configuration.hasKeyGenerator(keyStatementId)) {
    keyGenerator = configuration.getKeyGenerator(keyStatementId);
  } else {
    keyGenerator = context.getBooleanAttribute("useGeneratedKeys",
        configuration.isUseGeneratedKeys() && SqlCommandType.INSERT.equals(sqlCommandType))
        ? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
  }

  //获取这个 标签中的所有属性
  SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);
  // 如果没有指定 sql 的处理类型 就默认PREPARED 进行预编译
  StatementType statementType = StatementType.valueOf(context.getStringAttribute("statementType", StatementType.PREPARED.toString()));
  Integer fetchSize = context.getIntAttribute("fetchSize");
  Integer timeout = context.getIntAttribute("timeout");//获取等待时常
  String parameterMap = context.getStringAttribute("parameterMap");//参数类型
  String resultType = context.getStringAttribute("resultType");//返回数据类型
  Class<?> resultTypeClass = resolveClass(resultType);//转换成返回实体类
  String resultMap = context.getStringAttribute("resultMap");
  String resultSetType = context.getStringAttribute("resultSetType");
  ResultSetType resultSetTypeEnum = resolveResultSetType(resultSetType);
  if (resultSetTypeEnum == null) {
    resultSetTypeEnum = configuration.getDefaultResultSetType();//SCROLL_INSENSITIVE
  }
  String keyProperty = context.getStringAttribute("keyProperty");
  String keyColumn = context.getStringAttribute("keyColumn");
  String resultSets = context.getStringAttribute("resultSets");

  //创建一个mapper操作对象
  builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType,
      fetchSize, timeout, parameterMap, parameterTypeClass, resultMap, resultTypeClass,
      resultSetTypeEnum, flushCache, useCache, resultOrdered,
      keyGenerator, keyProperty, keyColumn, databaseId, langDriver, resultSets);
}

SqlSessionFactoryBuilder

public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
  try {
    //初始化加载 配置文件
    XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
    // 解析XML，最终返回一个 DefaultSqlSessionFactory
    return build(parser.parse());
  } catch (Exception e) {
    throw ExceptionFactory.wrapException("Error building SqlSession.", e);
  } finally {
    ErrorContext.instance().reset();
    try {
      reader.close();
    } catch (IOException e) {
      // Intentionally ignore. Prefer previous error.
    }
  }
}

扫码关注，持续更新内容

参考：建造者模式（Bulider模式）详解 (biancheng.net)