- MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中
示例
<!--配置环境 -->
<environments default="development">
<environment id="development">
<!-- 配置事务管理 采用JDBC事务管理 -->
<transactionManager type="JDBC" />
<!--
配置数据库连接信息 -->
<dataSource
type="POOLED">
<property name="driver" value="${driver}"
/>
<property name="url" value="${url}"
/>
<property name="username" value="${user}"
/>
<property name="password" value="${password}"
/>
</dataSource>
</environment>
</environments>
标签 |
说明 |
dataSource |
数据源 |
transactionManager |
事物管理器 |
注
为了指定创建哪种环境,只要将它作为可选的参数传递给 SqlSessionFactoryBuilder 即可。
可以接受环境配置的两个方法签名是:
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader,
environment);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader,
environment, properties);
- dataSource 数据源
- dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。
- 大多数 MyBatis 应用程序会按示例中的例子来配置数据源。
虽然数据源配置是可选的,但如果要启用延迟加载特性,就必须配置数据源。
有三种内建的数据源类型(也就是 type="[UNPOOLED|POOLED|JNDI]"):
UNPOOLED
- 这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢,但对那些数据库连接可用性要求不高的简单应用程序来说,是一个很好的选择。 性能表现则依赖于使用的数据库,对某些数据库来说,使用连接池并不重要,这个配置就很适合这种情形。
- UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性:
属性 |
说明 |
driver |
这是 JDBC 驱动的 Java 类全限定名(并不是 JDBC 驱动中可能包含的数据源类)。 |
url |
这是数据库的 JDBC URL 地址。 |
username |
登录数据库的用户名。 |
password |
登录数据库的密码。 |
defaultTransactionIsolationLevel |
默认的连接事务隔离级别。 |
defaultNetworkTimeout |
等待数据库操作完成的默认网络超时时间(单位:毫秒) |
可选项 |
说明 |
driver.encoding=UTF8 |
这将通过 DriverManager.getConnection(url, driverProperties) 方法传递值为 UTF8 的 encoding 属性给数据库驱动。 |
POOLED
- 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来,避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行,能使并发 Web 应用快速响应请求。
属性 |
说明 |
driver |
这是 JDBC 驱动的 Java 类全限定名(并不是 JDBC 驱动中可能包含的数据源类)。 |
url |
这是数据库的 JDBC URL 地址。 |
username |
登录数据库的用户名。 |
password |
登录数据库的密码。 |
defaultTransactionIsolationLevel |
默认的连接事务隔离级别。 |
defaultNetworkTimeout |
等待数据库操作完成的默认网络超时时间(单位:毫秒) |
可选项 |
说明 |
driver.encoding=UTF8 |
这将通过 DriverManager.getConnection(url, driverProperties) 方法传递值为 UTF8 的 encoding 属性给数据库驱动。 |
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 时适用) |
JNDI
- 这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用,容器可以集中或在外部配置数据源,然后放置一个 JNDI 上下文的数据源引用。
- 这种数据源配置只需要两个属性:
属性 |
说明 |
initial_context |
这个属性用来在 InitialContext 中寻找上下文(即,initialContext.lookup(initial_context))。这是个可选属性,如果忽略,那么将会直接从 InitialContext 中寻找 data_source 属性。 |
data_source |
这是引用数据源实例位置的上下文路径。 提供了 initial_context 配置时会在其返回的上下文中进行查找,没有提供时则直接在 InitialContext 中查找。
|
env.encoding=UTF8 |
和其他数据源配置类似,可以通过添加前缀“env.”直接把属性传递给 InitialContext。这就会在 InitialContext 实例化时往它的构造方法传递值为 UTF8 的 encoding 属性。 |
- transactionManager 事物管理器
在 MyBatis 中有两种类型的事务管理器(也就是 type="[JDBC|MANAGED]"):
- JDBC
这个配置直接使用了 JDBC 的提交和回滚设施,它依赖从数据源获得的连接来管理事务作用域。
- MANAGED
这个配置几乎没做什么。它从不提交或回滚一个连接,而是让容器来管理事务的整个生命周期(比如 JEE 应用服务器的上下文)。 默认情况下它会关闭连接。然而一些容器并不希望连接被关闭,因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为
示例
<transactionManager type="MANAGED">
<property name="closeConnection" value="false"/>
</transactionManager>
来自 <https://mybatis.org/mybatis-3/zh/configuration.html#environments>