mybatis 环境配置（environments）——迹忆客-ag捕鱼王app官网

mybatis 可以配置成适应多种环境，这种机制有助于将 sql 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 schema 的多个生产数据库中使用相同的 sql 映射。还有许多类似的使用场景。

不过要记住：尽管可以配置多个环境，但每个 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 元素定义了如何配置环境。

注意一些关键点:

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

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

事务管理器（transactionmanager）

在 mybatis 中有两种类型的事务管理器（也就是 type="[jdbc|managed]"）：

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

提示 如果你正在使用 spring mybatis，则没有必要配置事务管理器，因为 spring 模块会使用自带的管理器来覆盖前面的配置。

这两种事务管理器类型都不需要设置任何属性。它们其实是类型别名，换句话说，你可以用 transactionfactory 接口实现类的全限定名或类型别名代替它们。

public interface transactionfactory {
  default void setproperties(properties props) { // 从 3.5.2 开始，该方法为默认方法
    // 空实现
  }
  transaction newtransaction(connection conn);
  transaction newtransaction(datasource datasource, transactionisolationlevel level, boolean autocommit);
}

在事务管理器实例化后，所有在 xml 中配置的属性将会被传递给 setproperties() 方法。你的实现还需要创建一个 transaction 接口的实现类，这个接口也很简单：

public interface transaction {
  connection getconnection() throws sqlexception;
  void commit() throws sqlexception;
  void rollback() throws sqlexception;
  void close() throws sqlexception;
  integer gettimeout() throws sqlexception;
}

使用这两个接口，你可以完全自定义 mybatis 对事务的处理。

数据源（datasource）

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

• 大多数 mybatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源。

有三种内建的数据源类型（也就是 type="[unpooled|pooled|jndi]"）：

unpooled – 这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。 性能表现则依赖于使用的数据库，对某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。unpooled 类型的数据源仅仅需要配置以下 5 种属性：

• driver – 这是 jdbc 驱动的 java 类全限定名（并不是 jdbc 驱动中可能包含的数据源类）。
• url – 这是数据库的 jdbc url 地址。
• username – 登录数据库的用户名。
• password – 登录数据库的密码。
• defaulttransactionisolationlevel – 默认的连接事务隔离级别。
• defaultnetworktimeout – 等待数据库操作完成的默认网络超时时间（单位：毫秒）。查看 java.sql.connection#setnetworktimeout() 的 api 文档以获取更多信息。

作为可选项，你也可以传递属性给数据库驱动。只需在属性名加上“driver.”前缀即可，例如：

• driver.encoding=utf8

这将通过 drivermanager.getconnection(url, driverproperties) 方法传递值为 utf8 的 encoding 属性给数据库驱动。

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

除了上述提到 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 时适用）。

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

• initial_context – 这个属性用来在 initialcontext 中寻找上下文（即，initialcontext.lookup(initial_context)）。这是个可选属性，如果忽略，那么将会直接从 initialcontext 中寻找 data_source 属性。
• data_source – 这是引用数据源实例位置的上下文路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 initialcontext 中查找。

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

• env.encoding=utf8

这就会在 initialcontext 实例化时往它的构造方法传递值为 utf8 的 encoding 属性。

你可以通过实现接口 org.apache.ibatis.datasource.datasourcefactory 来使用第三方数据源实现：

public interface datasourcefactory {
  void setproperties(properties props);
  datasource getdatasource();
}

org.apache.ibatis.datasource.unpooled.unpooleddatasourcefactory 可被用作父类来构建新的数据源适配器，比如下面这段插入 c3p0 数据源所必需的代码：

import org.apache.ibatis.datasource.unpooled.unpooleddatasourcefactory;
import com.mchange.v2.c3p0.combopooleddatasource;
public class c3p0datasourcefactory extends unpooleddatasourcefactory {
  public c3p0datasourcefactory() {
    this.datasource = new combopooleddatasource();
  }
}

为了令其工作，记得在配置文件中为每个希望 mybatis 调用的 setter 方法增加对应的属性。 下面是一个可以连接至 postgresql 数据库的例子：