Configuration--environments(三-5)

上一篇文章中我们讲了settings,这一篇文章中,我们来讲一个比较重要的标签environments.顾名思义,environments就是配置mybatis的运行环境,包括事务(transactionManager)和数据源(dataSource).并且大家可以看到environments标签是复数形式,意味着environments下可以配置多个environment子标签,配置不同的环境,不过虽然可以配置多个环境,但是每个SqlSessionFactory 实例只能选择其一.所以,如果你想连接两个环境,就需要创建两个SqlSessionFactory ,依此列推.

---

我们先来看一下用法:

<!-- default属性用来配置默认使用的环境id -->
<environments default="development">
  <!-- 每个环境都有一个id值,用来在environments的default中使用 -->
  <environment id="development">
    <!-- 事务管理器,内置的有JDBC和MANAGED两种,也可以自定义 -->
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <!-- 数据源,内置的有UNPOOLED,POOLED和JNDI三种,也可以自定义 -->
    <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>

关于transactionManager和dataSource的具体细节,我们将单独来讲,先让我们来看一下,environmentsElement(root.evalNode(“environments”))的解析过程:

  private void environmentsElement(XNode context) throws Exception {
    if (context != null) {
      // 这里的environment属性在XMLConfigBuilder的构造方法中传入,再往上推也就是调用SqlSessionFactoryBuilder的build方法中可以传入一个environment值,从这里可以看出,如果在构造SqlSessionFactoryBuilder的build方法中传入了environment值,那么xml配置中的default将失效.
      if (environment == null) {
        // 若build方法中没有传入environment值,则获取environments标签的default属性的值
        environment = context.getStringAttribute("default");
      }
      // 遍历environments下所有的environment子标签
      for (XNode child : context.getChildren()) {
        // 获取子标签的id属性值
        String id = child.getStringAttribute("id");
        // 若environment标签id值和要使用的environment值一样,则进入if继续解析
        if (isSpecifiedEnvironment(id)) {
          // 通过xml文件配置返回一个事务工厂TransactionFactory(具体代码下面会讲解)
          TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
          // 通过xml文件配置返回一个数据源工厂(具体代码下面会讲解)
          DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
          // 通过工厂获取一个数据源DataSource
          DataSource dataSource = dsFactory.getDataSource();
          // 通过建造者模式生成一个Environment,可以看出,这个Environment中有环境的id值,事务工厂(TransactionFactory)和数据源(DataSource)
          Environment.Builder environmentBuilder = new Environment.Builder(id)
              .transactionFactory(txFactory)
              .dataSource(dataSource);
          // 将Environment设置进Configuration中
          configuration.setEnvironment(environmentBuilder.build());
        }
      }
    }
  }

  // 判断是否为默认环境
  private boolean isSpecifiedEnvironment(String id) {
    if (environment == null) {
      throw new BuilderException("No environment specified.");
    } else if (id == null) {
      throw new BuilderException("Environment requires an id attribute.");
    } else if (environment.equals(id)) {
      return true;
    }
    return false;
  }

那么接下来,我们来看一下,mybaits是怎么样去解析transactionManager和dataSource的:

  private TransactionFactory transactionManagerElement(XNode context) throws Exception {
    if (context != null) {
      // 获取type属性的值
      String type = context.getStringAttribute("type");
      // 获取transactionManager子标下的key,value对应值
      Properties props = context.getChildrenAsProperties();
      // 这个方法是不是似曾相识,我们在讲objectFactory时,也用了这个方法,不记得的同学可以回去看一下,这个方法就是先通过别名去查找Class对象,如果没找到,通过Resources去加载Class.
      // 我们之前说过,TransactionFactory有两个内置的值,JDBC和MANAGED,大家可以回到Configuration(三)这一讲,看看Configuration的构造方法中就有注册JDBC和MANAGED这两个别名.
      TransactionFactory factory = (TransactionFactory) resolveClass(type).newInstance();
      factory.setProperties(props);
      return factory;
    }
    throw new BuilderException("Environment declaration requires a TransactionFactory.");
  }

  // 该方法与上述方法类似,并且在Configuration的构造方法中,也注册了UNPOOLED,POOLED和JNDI的别名和对应Class的对应关系.
  private DataSourceFactory dataSourceElement(XNode context) throws Exception {
    if (context != null) {
      String type = context.getStringAttribute("type");
      Properties props = context.getChildrenAsProperties();
      DataSourceFactory factory = (DataSourceFactory) resolveClass(type).newInstance();
      factory.setProperties(props);
      return factory;
    }
    throw new BuilderException("Environment declaration requires a DataSourceFactory.");
  }

综上,我们看出,environments标签最终主要的作用就是从多个environment中选择一个,并且将该environment中配置的事务管理器(transactionManager)和数据源(dataSource)封装到一个Environment类中,再将这个类设置进Configuration中.

关于事务管理器(transactionManager)和数据源(dataSource),我们接下来会一一介绍.