Mybatis官方文件-XML配置

頂層結構，這個結構代表了在config裡面配置的順序，不能出錯的。

屬性（properties）

首先最基礎的引入就是通過properties標籤來引入

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

上面這裡通過resource引入了config.properties，同時還增加了username，password這個屬性。

引入之後，就可以使用${}進行應用，最常用的就是dataSource這個屬性了

<dataSource type="POOLED">
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

順序問題

對於這種引入有三種，第一種config.properties，第二中標籤引入，第三種就是方法引數。執行順序是：

• 首先讀取在 properties 元素體內指定的屬性。
• 然後根據 properties 元素中的 resource 屬性讀取類路徑下屬性檔案，或根據 url 屬性指定的路徑讀取屬性檔案，並覆蓋之前讀取過的同名屬性。
• 最後讀取作為方法引數傳遞的屬性，並覆蓋之前讀取過的同名屬性。

設定預設：

<properties resource="org/mybatis/example/config.properties">
  <!-- ... -->
  <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> <!-- 啟用預設值特性 -->
</properties>
 

如果使用了名字為：，或者sql中有：那麼需要設定特定的屬性來修改分割屬性名和預設字元

<properties resource="org/mybatis/example/config.properties">
  <!-- ... -->
  <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/> <!-- 修改預設值的分隔符 -->
</properties>

設定（settings）

常用設定：

• cacheEnabled 全域性性地開啟或關閉所有對映器配置檔案中已配置的任何快取。預設true
• useColumnLabel使用列標籤代替列名。實際表現依賴於資料庫驅動，具體可參考資料庫驅動的相關文件，或通過對比測試來觀察。預設true
• useGeneratedKeys允許 JDBC 支援自動生成主鍵，需要資料庫驅動支援。如果設定為 true，將強制使用自動生成主鍵。儘管一些資料庫驅動不支援此特性，但仍可正常工作（如 Derby）。預設false
• mapUnderscoreToCamelCase是否開啟駝峰命名自動對映，即從經典資料庫列名 A_COLUMN 對映到經典 Java 屬性名 aColumn。預設false
• logImpl指定 MyBatis 所用日誌的具體實現，未指定時將自動查詢。SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING預設未設定

類型別名（typeAliases）

方法一：

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
  <typeAlias alias="Post" type="domain.blog.Post"/>
  <typeAlias alias="Section" type="domain.blog.Section"/>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>

方法二：主要

<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

對於上面這種包的方法，如果沒有使用@Alias註解去設定名字預設設定首字母小寫Author => author

常見別名

型別處理器（typeHandlers）

MyBatis 在設定預處理語句（PreparedStatement）中的引數或從結果集中取出一個值時， 都會用型別處理器將獲取到的值以合適的方式轉換成 Java 型別。

你可以重寫已有的型別處理器或建立你自己的型別處理器來處理不支援的或非標準的型別。 具體做法為：實現 org.apache.ibatis.type.TypeHandler 介面， 或繼承一個很便利的類 org.apache.ibatis.type.BaseTypeHandler， 並且可以（可選地）將它對映到一個 JDBC 型別。

物件工廠（objectFactory）

環境配置（environments）

MyBatis 可以配置成適應多種環境，這種機制有助於將 SQL 對映應用於多種資料庫之中。

不過要記住：儘管可以配置多個環境，但每個 SqlSessionFactory 例項只能選擇一種環境。所以，如果你想連線兩個資料庫，就需要建立兩個 SqlSessionFactory 例項，每個資料庫對應一個。

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

<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>

其中default代表預設的環境

transactionManager有兩種：JDBC和MANAGED

• JDBC – 這個配置直接使用了 JDBC 的提交和回滾設施，它依賴從資料來源獲得的連線來管理事務作用域。
• MANAGED – 這個配置幾乎沒做什麼。

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

dataSource資料來源：[UNPOOLED|POOLED|JNDI]

• UNPOOLED：這個資料來源的實現會每次請求時開啟和關閉連線。

  配置屬性：

  • driver – 這是 JDBC 驅動的 Java 類全限定名（並不是 JDBC 驅動中可能包含的資料來源類）。
  • url – 這是資料庫的 JDBC URL 地址。
  • username – 登入資料庫的使用者名稱。
  • password – 登入資料庫的密碼。
  • defaultTransactionIsolationLevel – 預設的連線事務隔離級別。
  • defaultNetworkTimeout – 等待資料庫操作完成的預設網路超時時間（單位：毫秒）。檢視 java.sql.Connection#setNetworkTimeout() 的 API 文件以獲取更多資訊。

  作為可選項，你也可以傳遞屬性給資料庫驅動。只需在屬性名加上“driver.”字首即可，例如：

  • driver.encoding=UTF8

• POOLED： 這種資料來源的實現利用“池”的概念將 JDBC 連線物件組織起來，避免了建立新的連線例項時所必需的初始化和認證時間。

  • 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 上下文的資料來源引用。

對映器（mappers）常用！

四種方式：

<!-- 使用相對於類路徑的資源引用 -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

<!-- 使用完全限定資源定位符（URL） -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

<!-- 使用對映器介面實現類的完全限定類名 -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

<!-- 將包內的對映器介面實現全部註冊為對映器 -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>