最全MyBatis核心配置檔案總結，可以作為工具先收藏了

前言

今天這我們主要介紹一下MyBatis的全域性配置檔案的使用

configuration

mybatis-config.xml檔案的頭部格式我們就不說了，直接從屬性開始介紹，configuration為最頂層節點，其餘所有的屬性都必須巢狀在configuration內,MyBatis配置檔案的頂層節點如下：

<properties></properties><!-- 屬性 -->
<settings></settings>    <!-- 設定-->
<typeAliases></typeAliases><!-- 配置別名 -->
<typeHandlers></typeHandlers><!-- 型別處理器 -->
<objectFactory></objectFactory><!-- 物件工廠 -->
<plugins></plugins><!-- 外掛 -->
<environments default=""><!-- 環境配置-->
   <environment id=""><!-- 環境變數 -->
      <transactionManager></transactionManager><!-- 事務管理器 -->
      <dataSource></dataSource><!-- 資料來源 -->
   </environment>
</environments>
<databaseIdProvider></databaseIdProvider><!-- 資料庫廠商標識 -->
<mappers></mappers><!-- 對映器 -->

可以看到configuration內的全部頂層節點只有9個，下面我們就一個個來分析一下

properties

下面是一個相對完整的屬性配置

<!-- 配置resource-->
<properties resource="xxx/xxx.properties"><!-- 屬性 -->
        <property name="jdbc.driver" value="db.properties"/>
    </properties>
<!-- 配置url-->
<properties url="http://xxxx"><!-- 屬性 -->
        <property name="jdbc.driver" value="db.properties"/>
    </properties>

上面我特意分開寫，就是怕引起大家的誤解，因為resource和url只允許存在一個，不能同時配置兩個屬性，可以看到原始碼中的解析過程：同時配置了resource和url會丟擲異常。

配置了properties屬性之後，在xml其他配置檔案中可以直接通過${xxx}來讀取。

properties配置有三種方式，resource或者url指定，直接配置在子節點properties中，另一種就是上一篇提到的，直接程式碼中去其他地方讀取properties檔案，然後傳入build方法。

那麼這三種方式既然都能配置，假如屬性配置重複了，優先順序是怎麼樣的呢？

properties優先順序

properties配置的屬性如果重複，優先順序如下：

• 1、第一優先：在程式碼中直接通過properties傳入build方法。

• 2、第二優先：通過resource或者url讀取到的properties檔案中屬性。

• 3、第三優先：直接在properties內的子標籤property內定義的屬性。

在實際開發中，建議是隻使用一種，使用多種方式混合的話會給後期維護造成困難，而且不同型別的配置屬性混合時可讀性也不好。

settings

settings是MyBatis中最複雜，也是最重要的內容之一。當然這裡說的複雜並不是說配置方式複雜，而是settings能配置的東西非常多，一些很核心的功能都是通過settings標籤配置的。下面是一個完整的屬性配置示例：

<settings><!-- 設定-->
        <setting name="cacheEnabled" value="false"/>
        <setting name="lazyLoadingEnabled" value="false"/>
        <setting name="aggressiveLazyLoading" value="false"/>
        <setting name="multipleResultSetsEnabled" value="false"/>
        <setting name="useColumnLabel" value="false"/>
        <setting name="useGeneratedKeys" value="false"/>
        <setting name="autoMappingBehavior" value="NONE"/>
        <setting name="defaultExecutorType" value="SIMPLE"/>
        <setting name="defaultStatementTimeout" value="100"/>
        <setting name="safeRowBoundsEnabled" value="false"/>
        <setting name="mapUnderscoreToCamelCase" value="false"/>
        <setting name="localCacheScope" value="SESSION"/>
        <setting name="jdbcTypeForNull" value="VARCHAR"/>
        <setting name="lazyLoadTriggerMethods" value="equals"/>
        <setting name="defaultScriptingLanguage" value="org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver"/>
        <setting name="callSettersOnNulls" value="false"/>
        <setting name="logPrefix" value="LONELY_WOLF_"/>
        <setting name="logImpl" value="SLF4J"/>
        <setting name="proxyFactory" value="JAVASSIST"/>
    </settings>

所有的可設定值列舉如下（這些屬性有個映像就可以了，不需要去記，常用的多用幾次自然就記住了，不常用的需要的時候再查一下資料就可以了，所以建議大家可以收藏之後方便查詢）：

typeAliases

型別別名是為 Java 型別設定一個短的名字。它只和 XML 配置有關，存在的意義僅在於用來減少類完全限定名的冗餘。

直接指定類名

例如：

<typeAlias alias="UserMapper" type="com.lonelyWolf.mybatis.mapper.UserMapper"/>

這樣配置的話在MyBatis的xml檔案中可以直接使用UserMapper代替其類的全限定名。

只指定包名

也可以指定一個包名，MyBatis會在包名下面搜尋需要的 Java Bean，比如:

<package name="com.lonelyWolf.mybatis.mapper"/>

這麼配置的話每一個在指定包名中的Java類，如果沒有使用註解指定名稱，則會預設使用Bean的首字母小寫的非限定類名來作為它的別名，如果有註解，則優先使用註解指定的別名。如：

@Alias("lonely_wolf")
public class LonelyWolf{
}

這裡因為註解指定了別名，所以會以註解為準，如果沒有註解，則預設使用lonelyWolf作為別名。

系統預設提供的別名

實際開發中，有很多返回型別是資料基本型別或者String,Map,List等非常常見的型別，這些型別MyBatis已經為我們提供好了別名，我們就不需要另外再定義了。以下就時MyBatis中預設提供的別名：PS：這些別名的字母都是不區分大小寫的，因為MyBatis在註冊別名的時候會全部轉為小寫字母儲存

typeHandlers

typeHandlers主要是用來實現Java物件和資料庫欄位型別額轉換關係。無論是 MyBatis 在預處理語句（PreparedStatement）中設定一個引數時，還是從結果集中取出一個值時， 都會用型別處理器將獲取的值以合適的方式轉換成 Java 型別。配置方式如下：

 <typeHandlers>
   <!-- 自定義typeHandlers全限定類名 -->
        <typeHandler handler="xxx.xxx.xxx"></typeHandler>
        <!-- 獲取指定包名下的typeHandlers -->
        <package name="xxx.xxx"/>
    </typeHandlers>

MyBatis預設提供的Java Bean和資料庫欄位型別對映關係如下：

自定義typeHandlers

上面是MyBatis提供的預設對映型別，可以處理大部分需求，如果我們需要有不同的需求，則可以自己定義型別，具體如何定義，在後面的文章會單獨分析，在這裡不展開，感興趣的可以關注我，留意後續文章。

objectFactory

MyBatis 每次建立結果物件的新例項時，它都會使用一個物件工廠（ObjectFactory）例項來完成。預設的物件工廠需要做的僅僅是例項化目標類，要麼通過預設構造方法，要麼在引數對映存在的時候通過引數構造方法來例項化。如果想覆蓋物件工廠的預設行為，則 可以通過建立自己的物件工廠來實現

plugins

MyBatis 允許你在已對映語句執行過程中的某一點進行攔截呼叫。這裡我們不詳細討論，後期會有單獨文章介紹MyBatis外掛

environments

MyBatis 可以配置成適應多種環境，這種機制有助於將 SQL 對映應用於多種資料庫之中，例如：開發、測試和生產環境需要有不同的配置；或者共享相同 Schema 的多個生產資料庫， 想使用相同的 SQL 對映。許多類似的用例。注意：儘管可以配置多個環境，每個SqlSessionFactory例項只能選擇其一。所以，如果想連線兩個資料庫，就需要建立兩個SqlSessionFactory例項，每個資料庫對應一個。配置示例如下：

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

environment配置關鍵點:

• 預設的環境 ID（比如:default=”development”）

• 每個 environment 元素定義的環境 ID（比如:id=”development”）。

• 事務管理器的配置（比如:type=”JDBC”）。

• 資料來源的配置（比如:type=”POOLED”）。

事務管理器

在 MyBatis 中有兩種型別的事務管理器（也就是 type=”JDBC"或者"MANAGED”）:

• JDBC：這個配置就是直接使用了 JDBC 的提交和回滾設定，它依賴於從資料來源得到的連線來管理事務範圍。

• MANAGED：這個配置幾乎沒做什麼。它從來不提交或回滾一個連線，而是讓容器來管理事務的整個生命週期（比如J2EE應用容器上下文）。預設情況下它會關閉連線，然而一些容器並不希望這樣，因此需要將 closeConnection 屬性設定為 false 來阻止它預設的關閉行為。如:注意：如果單獨使用MyBatis而沒有整合能管理事務的容器，那麼配置成MANAGED就會等同於沒有事務，所以一般單獨使用MyBatis時，應配置為JDBC。

資料來源

dataSource元素使用標準的 JDBC 資料來源介面來配置JDBC連線物件的資源。有三種內建的資料來源型別（也就是 type=”[UNPOOLED|POOLED|JNDI]”）。

UNPOOLED

非連線池資料來源。UNPOOLED 型別的資料來源僅僅需要配置以下 5 種屬性：

• driver – 這是 JDBC 驅動的 Java 類的完全限定名（並不是JDBC驅動中可能包含的資料來源類）

• url – 這是資料庫的 JDBC URL 地址

• username – 登入資料庫的使用者名稱

• password – 登入資料庫的密碼

• defaultTransactionIsolationLevel – 預設的連線事務隔離級別

POOLED

連線池資料來源。除了上述提到UNPOOLED下的屬性外，會有更多屬性用來配置 POOLED 的資料來源：

• poolMaximumActiveConnections – 在任意時間可以存在的活動（也就是正在使用）連線數量，預設值：10

• poolMaximumIdleConnections – 任意時間可能存在的空閒連線數

• poolMaximumCheckoutTime – 在被強制返回之前，池中連線被檢出（checked out）時間，預設值：20000 毫秒（即 20 秒）

• poolTimeToWait – 這是一個底層設定，如果獲取連線花費的相當長的時間，它會給連線池列印狀態日誌並重新嘗試獲取一個連線（避免在誤配置的情況下一直安靜的失敗），預設值：20000 毫秒（即 20 秒）

• poolPingQuery – 傳送到資料庫的偵測查詢，用來檢驗連線是否處在正常工作秩序中並準備接受請求。預設是“NO PING QUERY SET”，這會導致多數資料庫驅動失敗時帶有一個恰當的錯誤訊息。

• poolPingEnabled – 是否啟用偵測查詢。若開啟，也必須使用一個可執行的 SQL 語句設定 poolPingQuery 屬性（最好是一個非常快的 SQL），預設值：false

• poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的使用頻度。這可以被設定成匹配具體的資料庫連線超時時間，來避免不必要的偵測，預設值：0（即所有連線每一時刻都被偵測 — 當然僅當 poolPingEnabled 為 true 時適用）

JNDI

這個資料來源的實現是為了能在如 EJB 或應用伺服器這類容器中使用，容器可以集中或在外部配置資料來源，然後放置一個 JNDI 上下文的引用。這種資料來源配置只需要兩個屬性：

• initial_context – 這個屬性用來在 InitialContext 中尋找上下文（即，initialContext.lookup(initial_context)）。這是個可選屬性，如果忽略，那麼 data_source 屬性將會直接從 InitialContext 中尋找。

• data_source – 這是引用資料來源例項位置的上下文的路徑。提供了 initial_context 配置時會在其返回的上下文中進行查詢，沒有提供時則直接在 InitialContext 中查詢。

自定義資料來源

有些業務場景可能需要自己自定義資料來源，MyBatis也是支援的。自定義資料來源必須要實現DataSourceFactory介面。然後採用如下配置：

 <dataSource type="自定義資料來源全限定類名"></dataSource>

databaseIdProvider

MyBatis 可以根據不同的資料庫廠商執行不同的語句，這種多廠商的支援是基於對映語句中的 databaseId 屬性。MyBatis 會載入不帶 databaseId 屬性和帶有匹配當前資料庫 databaseId 屬性的所有語句。如果同時找到帶有databaseId 和不帶 databaseId 的相 同語句，則後者會被捨棄。為支援多廠商特性只要像下面這樣在 mybatis-config.xml 檔案中加入 databaseIdProvider 即可：

<databaseIdProvider type="DB_VENDOR" />

mappers

這個就是用來配置sql對映語句的xml檔案了。mappers檔案共有4種配置方式：

1、直接配置xml對映檔案全限定名

<mappers>
        <mapper resource="com/lonelyWolf/mybatis/mapping/UserMapper.xml"/>
    </mappers>

2、通過url配置本地或者遠端對映檔案路徑

<mappers>
        <mapper url="file://xxx.xxx.UserMapper.xml"></mapper>
    </mappers>

3、通過配置Mapper介面的方式來配置。

<mappers>
        <mapper class="com.lonelyWolf.mybatis.mapper.UserMapper"></mapper>
    </mappers>

4、通過配置Mapper介面包名的形式來配置

<mappers>
        <package name="com.lonelyWolf.mybatis.mapper"/>
    </mappers>

注意：在使用第3和第4兩種方式配置的時候，需要把xml對映檔案和Mapper介面檔案放在同一個目錄，而且必須同名。

如果用的是maven配置的話，可能會出現以下錯誤：Invalid bound statement (not found)，出現之後需要注意檢查一下target下面的class目錄內有沒有xml對映檔案，如果沒有的話需要在pom檔案中加入以下配置(因為maven預設不會載入xml檔案)：

<build> 
       <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
    </build>

總結

本文主要介紹了MyBatis中的核心配置檔案的使用，本文其實更適合作為手冊來參考，只需大致瀏覽，心裡有個印象，需要用的時候再去查詢即可