Mybatis源码解析一： SqlSessionFactoryBuilder以及Configuration解析配置，生成SqlSessionFacroty

1.简介

在使用Mybatis时，都是通过使用SqlSeesionFactoryBuilder解析mybatis的配置文件，将数据源、事物、别名以及Mapper等信息加载到Configuration，之后生成SqlSessionFactory对象来完成后续的操作，如下代码所示：

SqlSeesionFactoryBuilder sqlSeesionFactoryBuilder = new SqlSeesionFactoryBuilder();
InputStream inputStream = Application.class.getClassLoader().getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = sqlSeesionFactoryBuilder.build(inputStream);

2.SqlSeesionFactoryBuilder

SqlSessionFactory build(InputStream inputStream)
SqlSessionFactory build(InputStream inputStream, String environment)
SqlSessionFactory build(InputStream inputStream, Properties properties)
SqlSessionFactory build(InputStream inputStream, String env, Properties props)
SqlSessionFactory build(Configuration config)

SqlSeesionFactoryBuilder有五个build方法，前四种方法是最常见的，因为它们使用引用XML文档的InputStream实例，或者更具体地说，引用mybatis-config.xml文件。可选参数是environment和properties。environment决定加载哪个环境，包括数据源和事务管理器。例如：

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
        ...
    <dataSource type="POOLED">
        ...
  </environment>
  <environment id="production">
    <transactionManager type="MANAGED">
        ...
    <dataSource type="JNDI">
        ...
  </environment>
</environments>

2.1 build方法解析

SqlSeesionFactoryBuilder将配置文件的解析委托给XMLConfigBuilder

public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
  // 通过XMLConfigBuilder解析mybatis-config.xml
  XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
  return build(parser.parse());

2.2 XMLConfigBuilder解析配置文件

2.2.1 mybatis-config.xml支持的标签配置

• properties
  properties标签通常用来配置java properties文件，一般都是使用在数据源的动态配置，如下：

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments>

• settings

用来配置mybatis运行时的属性，比如mapUnderscoreToCamelCase，defaultExecutorType，useGeneratedKeys等

• typeAliases
  类型别名的配置，它仅与XML配置相关，为了减少完全限定类名的冗余输入而存在。例如：

<typeAliases>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>

• typeHandlers

每当MyBatis在PreparedStatement上设置参数或从ResultSet检索值时，TypeHandler都会以适合Java类型的方式检索该值。

• plugins

mybatis允许在执行映射语句某些关键点进行拦截，允许拦截的方法如下：
- Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)

• environments

MyBatis可以配置多个环境。可以将SQL映射应用于多个数据库，比如开发、测试和生产环境可能有不同的配置。

• mappers 告诉mybatis在哪里可以找到配置的定义好的sql映射文件

2.2.2 配置文件的解析

配置文件的解析无非就是上述标签的解析，XMLConfigBuilder将各标签解析后，将其所对应的属性值封装到了Configuration实例中，重点关注一下environments标签以及mappers标签的解析

private void parseConfiguration(XNode root) {
  // 解析该标签后将属性存入到Configuration的variables中
  propertiesElement(root.evalNode("properties"));
  // 解析settin后的属性存入到Configuration中
  Properties settings = settingsAsProperties(root.evalNode("settings"));
  // 解析后的属性存入到Configuration的typeAliasRegistry
  typeAliasesElement(root.evalNode("typeAliases"));
  // 解析后的属性存入到Configuration的interceptorChain
  pluginElement(root.evalNode("plugins"));
  settingsElement(settings);
  // 解析使用的environments，同时构造数据源以及事物
  environmentsElement(root.evalNode("environments"));
  // 解析后的属性存入到Configuration的typeHandlerRegistry
  typeHandlerElement(root.evalNode("typeHandlers"));
  //解析后的属性存入到Configuration的mapperRegistry
  mapperElement(root.evalNode("mappers"));
  }

2.2.3 environments标签解析

在environments标签的解析中，主要负责事物以及数据源的构建

private void environmentsElement(XNode context) throws Exception {
    if (context != null) {
     ...
      for (XNode child : context.getChildren()) {
        String id = child.getStringAttribute("id");
        if (isSpecifiedEnvironment(id)) {
          // 解析transactionManager标签获取事务工厂
          TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
          // 解析dataSource标签获取数据源工厂（同上，用的工厂模式）
          DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
          DataSource dataSource = dsFactory.getDataSource();
          Environment.Builder environmentBuilder = new Environment.Builder(id)
              .transactionFactory(txFactory)
              .dataSource(dataSource);
          configuration.setEnvironment(environmentBuilder.build());
        }
      }
    }
  }
private TransactionFactory transactionManagerElement(XNode context) throws Exception {
    if (context != null) {
      // 获取标签中配置的type属性
      String type = context.getStringAttribute("type");
      Properties props = context.getChildrenAsProperties();
      // 根据属性值从别名注册器中构造事务工厂
      TransactionFactory factory = (TransactionFactory) resolveClass(type).getDeclaredConstructor().newInstance();
      factory.setProperties(props);
      return factory;
    }
}
private DataSourceFactory dataSourceElement(XNode context) throws Exception {
    if (context != null) {
       // 获取标签中配置的type属性
      String type = context.getStringAttribute("type");
      Properties props = context.getChildrenAsProperties();
      // 根据属性值从别名注册器中构数据源务工厂
      DataSourceFactory factory = (DataSourceFactory) resolveClass(type).getDeclaredConstructor().newInstance();
      factory.setProperties(props);
      return factory;
    }
}

2.2.3 mappers标签解析

mappers标签是为了告诉mybatis在哪里可以找到配置的定义好的sql映射文件，而mybatis在这里也提供了四种方式：

1. 使用classpath的资源文件配置方式

<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

2. 使用文件的全路径名

<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

3. 使用mapper接口路径

<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

4. 使用包路径

<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

mappers标签的解析代码如下：

private void mapperElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        // 使用包路径
        if ("package".equals(child.getName())) {
          String mapperPackage = child.getStringAttribute("name");
          configuration.addMappers(mapperPackage);
        } else {
          String resource = child.getStringAttribute("resource");
          String url = child.getStringAttribute("url");
          String mapperClass = child.getStringAttribute("class");
          // 使用classpath的资源文件配置方式
          if (resource != null && url == null && mapperClass == null) {
            ErrorContext.instance().resource(resource);
            InputStream inputStream = Resources.getResourceAsStream(resource);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url != null && mapperClass == null) {
            // 使用文件的全路径名
            ErrorContext.instance().resource(url);
            InputStream inputStream = Resources.getUrlAsStream(url);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url == null && mapperClass != null) {
            // 使用mapper接口
            Class<?> mapperInterface = Resources.classForName(mapperClass);
            // 将解析的mapperClass存入到Configuration的mapperRegistry
            configuration.addMapper(mapperInterface);
          } else {
            throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
          }
        }
      }
    }
  }

configuration#addMapper代码如下：

public void addMappers(String packageName) {
    mapperRegistry.addMappers(packageName);
  }

3.总结

SqlSessionFactoryBuilder就是负责解析mybatis配置文件，将解析的配置都存放到Configuration实例中，最后对外提供一个SqlSessionFactory实例。