Mybatis源码--两种启动方式

     又要开始写Mybatis相关的文章了。这段时间看完了SpringMVC和Spring，对Mybatis有了一些新的感受。以前是站在山底看，觉得好巍峨的一座大山。现在站在了更高的地方，终于可以看清它的全貌了。怎么说呢，百味杂陈，因为我是从Mybatis开始读架构源码的，这也是我推荐的一条路线。

      首先明确几个问题，Mybatis是什么？它是一个ORM映射架构。Mybatis做了什么？简化了传统的JDBC操作，又花了数据库连接方式（数据库连接池）等等。为什么要用它？当然是因为它简单容易上手啊！的确，市面上有很多ORM架构，但是Mybatis的确可以算是其中的佼佼者了。

     Mybatis的启动方式有两种，编码方式启动和交给Spring来自动。先来说说第一种，通常我们这样来启动Mybatis：

         Reader reader = Resources.getResourceAsReader("Mybatis配置文件路径");

         SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);

         SqlSession sqlSession = sqlSessionFactory.openSession();

     可以看到，我们是通过调用SqlSessionFactoryBuilder类的build()方法来获取SqlSessionFactory对象的，然后通过SqlSessionFactory得到我们想要的SqlSession。这是一种很经典的方式。当然也有别的方法，比如：

       Reader reader = Resources.getResourceAsReader("Mybatis配置文件路径");

      SqlSession sqlSession = .newInstance(reader).openSession();

      它们本质上都是一致，都是构造SqlSessionFactory，然后从SqlSessionFactory中取得SqlSession。不同的是，后者用了JDK动态代理，有兴趣可以读读源码。第二种方式，是通过Spring的包容性来启动。在org.mybatis.spring包下有一个SqlSessionFactoryBean类，它是Mybatis依赖Spring启动的关键类。

public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> {

}

  上述是SqlSessionFactoryBean类的简化版，可以看到，它实现了多个接口。第一个是FactoryBean接口，这是一个标准的Bean工厂模式，我们知道，通过此接口的getBean()方法会返回实现类的商品Bean。我们看看它返回了什么：

 @Override

public SqlSessionFactory getObject() throws Exception {
    if (this.sqlSessionFactory == null) {
      afterPropertiesSet();
    }

    return this.sqlSessionFactory;
  }

 可以看到，返回的是一个 SqlSessionFactory类型的对象。我们再来看看当SqlSessionFactoryBean中的SqlSessionFactory为空值时调用的afterPropertiesSet()方法做了什么：

@Override
public void afterPropertiesSet() throws Exception {
    this.sqlSessionFactory = buildSqlSessionFactory();
}

protected SqlSessionFactory buildSqlSessionFactory() throws IOException {

    Configuration configuration;

    XMLConfigBuilder xmlConfigBuilder = null;
    if (this.configuration != null) {
      configuration = this.configuration;
      if (configuration.getVariables() == null) {
        configuration.setVariables(this.configurationProperties);
      } else if (this.configurationProperties != null) {
        configuration.getVariables().putAll(this.configurationProperties);
      }
    } else if (this.configLocation != null) {
      xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
      configuration = xmlConfigBuilder.getConfiguration();
    } else {
      if (LOGGER.isDebugEnabled()) {
        LOGGER.debug("Property 'configuration' or 'configLocation' not specified, using default MyBatis Configuration");
      }
      configuration = new Configuration();
      if (this.configurationProperties != null) {
        configuration.setVariables(this.configurationProperties);
      }
    }
 
    //部分细节略
    return this.sqlSessionFactoryBuilder.build(configuration);
}

  可以看到，它调用了提前注入的SqlSessionFactoryBuilder对象的build()方法。对比之前编码方式调用SqlSessionFactoryBuilder对象的build()方法，我们可以发现参数发生了变化。为了解决这个问题，在这里放上SqlSessionFactoryBuilder的源码：

 

public class SqlSessionFactoryBuilder {

  public SqlSessionFactory build(Reader reader) {
    return build(reader, null, null);
  }

  public SqlSessionFactory build(Reader reader, String environment) {
    return build(reader, environment, null);
  }

  public SqlSessionFactory build(Reader reader, Properties properties) {
    return build(reader, null, properties);
  }

  public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
      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.
      }
    }
  }

  public SqlSessionFactory build(InputStream inputStream) {
    return build(inputStream, null, null);
  }

  public SqlSessionFactory build(InputStream inputStream, String environment) {
    return build(inputStream, environment, null);
  }

  public SqlSessionFactory build(InputStream inputStream, Properties properties) {
    return build(inputStream, null, properties);
  }

  public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        inputStream.close();
      } catch (IOException e) {
        // Intentionally ignore. Prefer previous error.
      }
    }
  }
    
  public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
  }

}

   我们可以看到，通过Spring启动Mybatis的方式最后调用的是SqlSessionFactoryBuilder类最后的build(Configuration config)方法，而编码方式调用的是第一个方法，然后间接调用了第四个方法，读物XML得到Configuration对象后调用了最后一个方法。所以，本质上并无不同。事实上，在之前的buildSqlSessionFactory()方法中是可以看到将XML转化为Configuration对象的步骤的。