Mybatis 基础篇-- 深入了解 XML 配置（environments）

Posted 2020-12-11 IBIT程序猿

原文链接：Mybatis 基础篇（二）-- 深入了解 XML 配置（environments）

environments（环境配置）

Mybatis 支持配置多环境，但是请记住每个 SqlSessionFactory 实例只能选择一种环境。如果需要使用到多个环境，则需要多个 SqlSessionFactory 实例。

SqlSessionFactory 在 SqlSessionFactoryBuilder 创建的时候指定所对应的环境。

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

如果忽略了环境参数，那么将会加载默认环境，如下所示：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, properties);

environments 元素定义了如何配置环境。

<environments default="test" >
    <environment id="test">
        <transactionManager type="JDBC">
            <property name="" value="" />
        </transactionManager>
        <dataSource type="UNPOOLED">
            <property name="driver" value="org.hsqldb.jdbcDriver" />
            <property name="url" value="jdbc:hsqldb:mem:mybatis-test" />
            <property name="username" value="sa" />
            <property name="password" value="" />
            <property name="defaultTransactionIsolationLevel" value=""/>
        </dataSource>
    </environment>
</environments>

注意一些关键点:

• 默认使用的环境 ID（比如：default="test"）。
• 每个 environment 元素定义的环境 ID（比如：id="test"）。
• 事务管理器的配置（比如：type="JDBC"）。
• 数据源的配置（比如：type="POOLED"）。

默认环境和环境 ID 顾名思义。 环境可以随意命名，但务必保证默认的环境 ID 要匹配其中一个环境 ID。

事务管理器（transactionManager）

内置事务管理器类型（type="JDBC | MANAGED"）

• JDBC – 这个配置直接使用了 JDBC 的提交和回滚设施，它依赖从数据源获得的连接来管理事务作用域。
• MANAGED – 这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接。然而一些容器并不希望连接被关闭，因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为。

这两种事务管理器类型都不需要设置任何属性。

分析类 Configuration 的源码

public Configuration() {
	typeAliasRegistry.registerAlias("JDBC", JdbcTransactionFactory.class);
	typeAliasRegistry.registerAlias("MANAGED", ManagedTransactionFactory.class);
	// 省略其他代码
}  

可以看出：

• JDBC 是类 JdbcTransactionFactory 的别名。
• MANAGED 是类 ManagedTransactionFactory 的别名。

所以下述配置是等价的

<transactionManager type="JDBC">
	等价于
<transactionManager type="org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory">

自定义事务管理类型

通过实现接口 org.apache.ibatis.transaction.TransactionFactory 和 org.apache.ibatis.transaction. Transaction实现mybatis的自定义事务管理。type 指定为TransactionFactory 实现类的全名或别名。

数据源（dataSource）

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

内置数据源类型（type="UNPOOLED | POOLED | JNDI"）

• UNPOOLED：这个数据源的实现会每次请求时打开和关闭连接。
• POOLED： 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。
• JNDI：这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的数据源引用。

分析类 Configuration 的源码

public Configuration() {
	// 省略其他代码
	typeAliasRegistry.registerAlias("JNDI", JndiDataSourceFactory.class);
	typeAliasRegistry.registerAlias("POOLED", PooledDataSourceFactory.class);
	typeAliasRegistry.registerAlias("UNPOOLED", UnpooledDataSourceFactory.class);
}  

可以看出：

• UNPOOLED 是类 UnpooledDataSourceFactory 的别名。
• POOLED 是类 PooledDataSourceFactory 的别名。
• JNDI 是类 JndiDataSourceFactory 的别名。

所以下述配置是等价的

<dataSource type="UNPOOLED">
	等价于
<dataSource type="org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory">

UNPOOLED 配置属性（property标签）

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

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

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

• password：登录数据库的密码。

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

• defaultNetworkTimeout：等待数据库操作完成的默认网络超时时间（单位：毫秒）。

• driver.*：通过添加前缀"driver." 给数据库驱动传递属性
  eg:

  driver.encoding=UTF8
  

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

更多配置：可查看类 org.apache.ibatis.datasource.unpooled.UnpooledDataSource。

POOLED 配置属性（property标签）

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

• poolMaximumActiveConnections：在任意时间可存在的活动（正在使用）连接数量，默认值：10。
• poolMaximumIdleConnections：任意时间可能存在的空闲连接数。
• poolMaximumCheckoutTime：在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）。
• poolTimeToWait：这是一个底层设置，如果获取连接花费了相当长的时间，连接池会打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直失败且不打印日志），默认值：20000 毫秒（即 20 秒）。
• poolMaximumLocalBadConnectionTolerance：这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程。 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过 poolMaximumIdleConnections 与 poolMaximumLocalBadConnectionTolerance 之和。 默认值：3（新增于 3.4.5）。
• poolPingQuery： 发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动出错时返回恰当的错误消息。
• poolPingEnabled：是否启用侦测查询。若开启，需要设置 poolPingQuery 属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false。
• poolPingConnectionsNotUsedFor： 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。

更多配置：可查看类 org.apache.ibatis.datasource.pooled.PooledDataSource。

JNDI 配置属性（property 标签）

• initial_context： 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么将会直接从 InitialContext 中寻找 data_source 属性。
• data_source：这是引用数据源实例位置的上下文路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。
• env.*： 可以通过添加前缀“env.”直接把属性传递给 InitialContext。

自定义数据源类型

通过实现接口 org.apache.ibatis.datasource.DataSourceFactory实现mybatis的自定义数据源。type 指定为DataSourceFactory 实现类的全名或别名。

参考资料

Mybatis 官网 XML 配置

公众号

喜欢我的文章，请关注公众号