MyBatis 3 XML配置-環(huán)境配置

環(huán)境配置（environments）

MyBatis 可以配置成適應(yīng)多種環(huán)境，這種機(jī)制有助于將 SQL 映射應(yīng)用于多種數(shù)據(jù)庫之中， 現(xiàn)實情況下有多種理由需要這么做。例如，開發(fā)、測試和生產(chǎn)環(huán)境需要有不同的配置；或者想在具有相同Schema的多個生產(chǎn)數(shù)據(jù)庫中使用相同的 SQL 映射。還有許多類似的使用場景。

不過要記?。罕M管可以配置多個環(huán)境，但每個SqlSessionFactory實例只能選擇一種環(huán)境。

所以，如果你想連接兩個數(shù)據(jù)庫，就需要創(chuàng)建兩個SqlSessionFactory 實例，每個數(shù)據(jù)庫對應(yīng)一個。而如果是三個數(shù)據(jù)庫，就需要三個實例，依此類推，記起來很簡單：

• 每個數(shù)據(jù)庫對應(yīng)一個 ?SqlSessionFactory實例

為了指定創(chuàng)建哪種環(huán)境，只要將它作為可選的參數(shù)傳遞給SqlSessionFactoryBuilder即可。可以接受環(huán)境配置的兩個方法簽名是：

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

如果忽略了環(huán)境參數(shù)，那么將會加載默認(rèn)環(huán)境，如下所示：

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

?environments ?元素定義了如何配置環(huán)境。

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <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>

注意一些關(guān)鍵點:

• 默認(rèn)使用的環(huán)境 ID（比如：default="development"）。
• 每個 ?environment元素定義的環(huán)境 ID（比如：id="development"）。
• 事務(wù)管理器的配置（比如：type="JDBC"）。
• 數(shù)據(jù)源的配置（比如：type="POOLED"）。

默認(rèn)環(huán)境和環(huán)境 ID 顧名思義。 環(huán)境可以隨意命名，但務(wù)必保證默認(rèn)的環(huán)境 ID 要匹配其中一個環(huán)境 ID。

事務(wù)管理器（transactionManager）

在 MyBatis 中有兩種類型的事務(wù)管理器（也就是 type="[JDBC|MANAGED]"）：

• ?JDBC– 這個配置直接使用了 JDBC 的提交和回滾設(shè)施，它依賴從數(shù)據(jù)源獲得的連接來管理事務(wù)作用域。
• ?MANAGED– 這個配置幾乎沒做什么。它從不提交或回滾一個連接，而是讓容器來管理事務(wù)的整個生命周期（比如 JEE 應(yīng)用服務(wù)器的上下文）。 默認(rèn)情況下它會關(guān)閉連接。然而一些容器并不希望連接被關(guān)閉，因此需要將 ?closeConnection屬性設(shè)置為 ?false來阻止默認(rèn)的關(guān)閉行為。例如:

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

如果你正在使用 Spring + MyBatis，則沒有必要配置事務(wù)管理器，因為 Spring 模塊會使用自帶的管理器來覆蓋前面的配置。

這兩種事務(wù)管理器類型都不需要設(shè)置任何屬性。它們其實是類型別名，換句話說，你可以用TransactionFactory接口實現(xiàn)類的全限定名或類型別名代替它們。

public interface TransactionFactory {
  default void setProperties(Properties props) { // 從 3.5.2 開始，該方法為默認(rèn)方法
    // 空實現(xiàn)
  }
  Transaction newTransaction(Connection conn);
  Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit);
}

在事務(wù)管理器實例化后，所有在 XML 中配置的屬性將會被傳遞給 ?setProperties()? 方法。你的實現(xiàn)還需要創(chuàng)建一個 ?Transaction接口的實現(xiàn)類，這個接口也很簡單：

public interface Transaction {
  Connection getConnection() throws SQLException;
  void commit() throws SQLException;
  void rollback() throws SQLException;
  void close() throws SQLException;
  Integer getTimeout() throws SQLException;
}

使用這兩個接口，你可以完全自定義 MyBatis 對事務(wù)的處理。

數(shù)據(jù)源（dataSource）

?dataSource元素使用標(biāo)準(zhǔn)的JDBC數(shù)據(jù)源接口來配置 ?JDBC連接對象的資源。

• 大多數(shù) MyBatis 應(yīng)用程序會按示例中的例子來配置數(shù)據(jù)源。雖然數(shù)據(jù)源配置是可選的，但如果要啟用延遲加載特性，就必須配置數(shù)據(jù)源。

有三種內(nèi)建的數(shù)據(jù)源類型（也就是 ?type="[UNPOOLED|POOLED|JNDI]"?）：

?UNPOOLED?– 這個數(shù)據(jù)源的實現(xiàn)會每次請求時打開和關(guān)閉連接。雖然有點慢，但對那些數(shù)據(jù)庫連接可用性要求不高的簡單應(yīng)用程序來說，是一個很好的選擇。 性能表現(xiàn)則依賴于使用的數(shù)據(jù)庫，對某些數(shù)據(jù)庫來說，使用連接池并不重要，這個配置就很適合這種情形。?UNPOOLED ?類型的數(shù)據(jù)源僅僅需要配置以下 6 種屬性：

• ?driver ?– 這是 JDBC 驅(qū)動的 Java 類全限定名（并不是 JDBC 驅(qū)動中可能包含的數(shù)據(jù)源類）。
• ?url ?– 這是數(shù)據(jù)庫的 JDBC URL 地址。
• ?username ?– 登錄數(shù)據(jù)庫的用戶名。
• ?password ?– 登錄數(shù)據(jù)庫的密碼。
• ?defaultTransactionIsolationLevel ?– 默認(rèn)的連接事務(wù)隔離級別。
• ?defaultNetworkTimeout ?– 等待數(shù)據(jù)庫操作完成的默認(rèn)網(wǎng)絡(luò)超時時間（單位：毫秒）。查看 java.sql.Connection#setNetworkTimeout() 的 API 文檔以獲取更多信息。

作為可選項，你也可以傳遞屬性給數(shù)據(jù)庫驅(qū)動。只需在屬性名加上“?driver.?”前綴即可，例如：

• ?driver.encoding=UTF8?

這將通過 ?DriverManager.getConnection(url, driverProperties)? 方法傳遞值為 UTF8 的 ?encoding ?屬性給數(shù)據(jù)庫驅(qū)動。

?POOLED?– 這種數(shù)據(jù)源的實現(xiàn)利用“池”的概念將 ?JDBC連接對象組織起來，避免了創(chuàng)建新的連接實例時所必需的初始化和認(rèn)證時間。 這種處理方式很流行，能使并發(fā) Web 應(yīng)用快速響應(yīng)請求。

除了上述提到 ?UNPOOLED下的屬性外，還有更多屬性用來配置 ?POOLED ?的數(shù)據(jù)源：

• ?poolMaximumActiveConnections ?– 在任意時間可存在的活動（正在使用）連接數(shù)量，默認(rèn)值：10
• ?poolMaximumIdleConnections ?– 任意時間可能存在的空閑連接數(shù)。
• ?poolMaximumCheckoutTime ?– 在被強(qiáng)制返回之前，池中連接被檢出（checked out）時間，默認(rèn)值：20000 毫秒（即 20 秒）
• ?poolTimeToWait ?– 這是一個底層設(shè)置，如果獲取連接花費了相當(dāng)長的時間，連接池會打印狀態(tài)日志并重新嘗試獲取一個連接（避免在誤配置的情況下一直失敗且不打印日志），默認(rèn)值：20000 毫秒（即 20 秒）。
• ?poolMaximumLocalBadConnectionTolerance ?– 這是一個關(guān)于壞連接容忍度的底層設(shè)置， 作用于每一個嘗試從緩存池獲取連接的線程。 如果這個線程獲取到的是一個壞的連接，那么這個數(shù)據(jù)源允許這個線程嘗試重新獲取一個新的連接，但是這個重新嘗試的次數(shù)不應(yīng)該超過 poolMaximumIdleConnections 與 poolMaximumLocalBadConnectionTolerance 之和。 默認(rèn)值：3（新增于 3.4.5）
• ?poolPingQuery ?– 發(fā)送到數(shù)據(jù)庫的偵測查詢，用來檢驗連接是否正常工作并準(zhǔn)備接受請求。默認(rèn)是“NO PING QUERY SET”，這會導(dǎo)致多數(shù)數(shù)據(jù)庫驅(qū)動出錯時返回恰當(dāng)?shù)腻e誤消息。
• ?poolPingEnabled ?– 是否啟用偵測查詢。若開啟，需要設(shè)置 poolPingQuery 屬性為一個可執(zhí)行的 SQL 語句（最好是一個速度非?？斓?nbsp;SQL 語句），默認(rèn)值：false。
• ?poolPingConnectionsNotUsedFor ?– 配置 poolPingQuery 的頻率?？梢员辉O(shè)置為和數(shù)據(jù)庫連接超時時間一樣，來避免不必要的偵測，默認(rèn)值：0（即所有連接每一時刻都被偵測 — 當(dāng)然僅當(dāng) poolPingEnabled 為 true 時適用）。

?JNDI ?– 這個數(shù)據(jù)源實現(xiàn)是為了能在如 EJB 或應(yīng)用服務(wù)器這類容器中使用，容器可以集中或在外部配置數(shù)據(jù)源，然后放置一個 JNDI 上下文的數(shù)據(jù)源引用。這種數(shù)據(jù)源配置只需要兩個屬性：

• ?initial_context ?– 這個屬性用來在 InitialContext 中尋找上下文（即，initialContext.lookup(initial_context)）。這是個可選屬性，如果忽略，那么將會直接從 InitialContext 中尋找 data_source 屬性。
• ?data_source ?– 這是引用數(shù)據(jù)源實例位置的上下文路徑。提供了 initial_context 配置時會在其返回的上下文中進(jìn)行查找，沒有提供時則直接在 InitialContext 中查找。

和其他數(shù)據(jù)源配置類似，可以通過添加前綴“?env.?”直接把屬性傳遞給 ?InitialContext?。比如：

• ?env.encoding=UTF8?

這就會在 ?InitialContext ?實例化時往它的構(gòu)造方法傳遞值為 UTF8 的 ?encoding ?屬性。

你可以通過實現(xiàn)接口 ?org.apache.ibatis.datasource.DataSourceFactory? 來使用第三方數(shù)據(jù)源實現(xiàn)：

public interface DataSourceFactory {
  void setProperties(Properties props);
  DataSource getDataSource();
}

?org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory? 可被用作父類來構(gòu)建新的數(shù)據(jù)源適配器，比如下面這段插入 C3P0 數(shù)據(jù)源所必需的代碼：

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 調(diào)用的 ?setter ?方法增加對應(yīng)的屬性。 下面是一個可以連接至 PostgreSQL 數(shù)據(jù)庫的例子：

<dataSource type="org.myproject.C3P0DataSourceFactory">
  <property name="driver" value="org.postgresql.Driver"/>
  <property name="url" value="jdbc:postgresql:mydb"/>
  <property name="username" value="postgres"/>
  <property name="password" value="root"/>
</dataSource>