【MyBatis源码分析】environments解析属性配置元素详述

最新推荐文章于 2024-07-04 00:45:00 发布

-ztp

最新推荐文章于 2024-07-04 00:45:00 发布

阅读量988

点赞数 1

分类专栏：源码 Mybatis深度源码分析文章标签： mybatis java 数据访问源码框架

本文链接：https://blog.csdn.net/qq_35807136/article/details/79085236

版权

源码同时被 2 个专栏收录

10 篇文章 0 订阅

订阅专栏

Mybatis深度源码分析

10 篇文章 4 订阅

订阅专栏

environments加载

先看我们项目相关配置XML;

<environments default="development">
         <environment id="development">
             <transactionManager type="JDBC"/>
             <dataSource type="POOLED">
                 <property name="driver" value="${driveClass}"/>
                 <property name="url" value="${url}"/>
                 <property name="username" value="${userName}"/>
                 <property name="password" value="${password}"/>
             </dataSource>
         </environment>
         <!-- 我再指定一个environment -->
	    <environment id="test">
	      <transactionManager type="JDBC"/>
	      <dataSource type="POOLED">
	        <property name="driver" value="com.mysql.jdbc.Driver"/>
	        <!-- 与上面的url不一样 -->
	        <property name="url" value="jdbc:mysql://localhost:3306/mysql?useUnicode=true&characterEncoding=utf8"/>
	        <property name="username" value="root"/>
	        <property name="password" value="root"/>
	      </dataSource>
	    </environment>
     </environments>

接着就是<environments>的加载了，一个比较重要的属性，用于配置JDBC信息，对应的是environmentsElement(root.evalNode("environments"))这句代码：

private void environmentsElement(XNode context) throws Exception {
    if (context != null) {
      if (environment == null) {
        environment = context.getStringAttribute("default");
      }
      for (XNode child : context.getChildren()) {
        String id = child.getStringAttribute("id");
        if (isSpecifiedEnvironment(id)) {
          TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
          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());
        }
      }
    }
  }

第3行~第5行的代码，得到默认的JDBC环境名称。

第6行的代码开始遍历<environments>标签下的每一个<environment>标签，先第7行的代码获取<environment>下的id属性，接着第8行的代码判断当前的<environment>是不是默认的JDBC环境，也就是第3行~第5行代码获取到的default属性对应的值。从这段代码可以看出两个问题：

源码并没有对不满足第8行判断即不是默认<environment>的场景做判断，因此可以得到一个结论：<environments>标签下的default属性是一个必填属性。
即使配置再多的<environment>标签，MyBatis只会加载其中的一个<environment>

第9行的代码根据<transactionManager>标签获取事物管理器，本系列文章配置的是"JDBC"，那么实例化出来的是JdbcTransactionFactory（JDBC-->JdbcTransactionFactory的对应关系在Configuration构造函数配置的alias映射中），其他的还有ManagedTransactionFactory和SpringManagedTransactionFactory，其中前者是MyBatis原生支持的，后者是Spring框架支持的。

第10行的代码和第9行的代码差不多，根据<dataSource>标签获取数据源工厂DataSourceFactory，本系列文章配置的是"POOLED"，那么实例化出来的是PooledDataSourceFactory（POOLED-->PooledDataSourceFactory的对应关系在Configuration构造函数配置的alias映射中），其他的还有UnpooledDataSourceFactory和JndiDataSourceFactory。

第11行的代码根据DataSourceFactory获取DataSource，在MyBatis中根据配置分三种场景：

PooledDataSourceFactory对应的DataSource是PooledDataSource
UnpooledDataSourceFactory对应的DataSource是UnpooledDataSource
JndiDataSourceFactory对应的DataSource要去JNDI服务上去找

第12行~第15行的代码比较简单，使用内部类构建的方式根据TransactionFactory和DataSource创建一个Environment并设置到Configuration。

为什么只能加载一个environments却可以配置这么多呢？

原来是通过id属性在不同的时候去匹配多个环境,一次可以把开发环境，测试环境,灰度环境配置信息都写好，部署的时候直接修改Id匹配相应的default属性选择对应的environments。

还有一个问题，上面我们看到，在配置dataSource的时候使用了 ${driver} 这种表达式，这种形式是怎么解析的？其实，是通过PropertyParser这个类在解析xml的时候就已经解析：

public class PropertyParser {

  private PropertyParser() {
    // Prevent Instantiation
  }

  public static String parse(String string, Properties variables) {
    VariableTokenHandler handler = new VariableTokenHandler(variables);
    GenericTokenParser parser = new GenericTokenParser("${", "}", handler);
    return parser.parse(string);
  }

  private static class VariableTokenHandler implements TokenHandler {
    private Properties variables;

    public VariableTokenHandler(Properties variables) {
      this.variables = variables;
    }

    @Override
    public String handleToken(String content) {
      if (variables != null && variables.containsKey(content)) {
        return variables.getProperty(content);
      }
      return "${" + content + "}";
    }
  }
}

对比配置事物区别：

在Mybatis里面支持两种配置：JDBC和MANAGED。这里根据type的设置值来返回相应的事务管理器

JDBC：这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。

MANAGED：这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。例如:

<transactionManager type="MANAGED">
             <property name="closeConnection" value="false"/>
             </transactionManager>

备注：如果你正在使用 Spring + MyBatis，则没有必要配置事务管理器，因为 Spring 模块会使用自带的管理器来覆盖前面的配置。

说完了事务管理器，紧接着，我们来看看数据源配置。

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。Mybatis支持三种内建的数据源类型，分别是UNPOOLED、POOLED和JNDI，即我们在配置<dataSource>元素的type属性时，我们可以直接支持设置这三个值。

下面分别对这三种类型做一个简单的说明：

（1）UNPOOLED

这个数据源的实现只是每次被请求时打开和关闭连接。虽然一点慢，它对在及时可用连接方面没有性能要求的简单应用程序是一个很好的选择。不同的数据库在这方面表现也是不一样的，所以对某些数据库来说使用连接池并不重要，这个配置也是理想的。

UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：

driver ：这是 JDBC 驱动的 Java 类的完全限定名（并不是JDBC驱动中可能包含的数据源类）。

url ：这是数据库的 JDBC URL 地址。

username ：登录数据库的用户名。

password ：登录数据库的密码。

defaultTransactionIsolationLevel ：默认的连接事务隔离级别。

作为可选项，你也可以传递属性给数据库驱动。要这样做，属性的前缀为“driver.”，例如：

driver.encoding=UTF8

这将通过DriverManager.getConnection(url,driverProperties)方法传递值为 UTF8 的 encoding 属性给数据库驱动。

（2）POOLED

这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。这是一种使得并发 Web 应用快速响应请求的流行处理方式。

除了上述提到 UNPOOLED 下的属性外，会有更多属性用来配置 POOLED 的数据源：

poolMaximumActiveConnections ：在任意时间可以存在的活动（也就是正在使用）连接数量，默认值：10

poolMaximumIdleConnections ：任意时间可能存在的空闲连接数。

poolMaximumCheckoutTime ：在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）

poolTimeToWait ：这是一个底层设置，如果获取连接花费的相当长的时间，它会给连接池打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直安静的失败），默认值：20000 毫秒（即 20 秒）。

poolPingQuery ：发送到数据库的侦测查询，用来检验连接是否处在正常工作秩序中并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动失败时带有一个恰当的错误消息。

poolPingEnabled ：是否启用侦测查询。若开启，也必须使用一个可执行的 SQL 语句设置 poolPingQuery 属性（最好是一个非常快的 SQL），默认值：false。poolPingConnectionsNotUsedFor ：配置 poolPingQuery 的使用频度。这可以被设置成匹配具体的数据库连接超时时间，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。

（3）JNDI

这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。这种数据源配置只需要两个属性：

initial_context ：这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么 data_source 属性将会直接从 InitialContext 中寻找。

data_source ：这是引用数据源实例位置的上下文的路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。

和其他数据源配置类似，可以通过添加前缀“env.”直接把属性传递给初始上下文。比如：

env.encoding=UTF8

这就会在初始上下文（InitialContext）实例化时往它的构造方法传递值为 UTF8 的 encoding 属性。

至此，关于<environments>元素的相关配置使用便介绍完毕了。

databaseIdProvider数据库厂商标识：

在相同的数据库厂商的环境下，数据库厂商标识没有多大的意义，在实际应用中使用的比较少，因为使用不同数据库厂商的系统还是比较少的。Mybatis可能会运行在不同厂商数据库中，它为此提供一个数据库标识，并提供自定义，它的作用在于指定SQL到对应的数据库厂商提供的数据库中运行。