最全MyBatis核心配置文件總結(需要收藏)
上一篇我們通過將MyBatis和傳統JDBC,DBUtils,以及Hibernate作了簡單的對比，并且列舉了一個非常簡單的demo，今天這篇主要介紹一下MyBatis的全局配置文件的使用
configurationmybatis-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內定義的屬性。
在實際開發中，建議是只使用一種，使用多種方式混合的話會給后期維護造成困難，而且不同類型的配置屬性混合時可讀性也不好。
settingssettings是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>
所有的可設置值列舉如下（這些屬性有個映像就可以了，不需要去記，常用的多用幾次自然就記住了，不常用的需要的時候再查一下資料就可以了，所以建議大家可以收藏之后方便查詢）：
參數 描述 可選值 默認值 cacheEnabled 緩存配置的全局開關 true false true lazyLoadingEnabled 延遲加載全局開關。當開啟時，所有關聯對象都會延遲加載。 特定關聯關系中可通過設置 sql語句上標簽的fetchType 屬性來覆蓋該項的開關狀態。 true false false aggressiveLazyLoading 當啟用時，對任意延遲屬性的調用會使帶有延遲加載屬性的對象完整加載；反之，每種屬性將會按需加載。 true false true multipleResultSetsEnabled 是否允許單一語句返回多結果集（需要兼容驅動） true false true useColumnLabel 使用列標簽代替列名。不同的驅動在這方面會有不同的表現， 具體可參考相關驅動文檔或通過測試這兩種不同的模式來觀察所用驅動的結果。 true false true useGeneratedKeys 允許 JDBC 支持自動生成主鍵，需要驅動兼容。 如果設置為 true 則這個設置強制使用自動生成主鍵，盡管一些驅動不能兼容但仍可正常工作（比如Derby）。 true false false autoMappingBehavior 指定 MyBatis 應如何自動映射列到字段或屬性。 NONE表示取消自動映射；PARTIAL只會自動映射沒有定義嵌套結果集映射的結果集。FULL會自動映射任意復雜的結果集（無論是否嵌套）。 NONE PARTIAL FULL PARTIAL defaultExecutorType 配置默認的執行器。SIMPLE 就是普通的執行器；REUSE 執行器會重用預處理語句（prepared statements）；BATCH 執行器將重用語句并執行批量更新。 SIMPLE REUSE BATCH SIMPLE defaultStatementTimeout 設置超時時間，它決定驅動等待數據庫響應的秒數 有效的整數 默認null safeRowBoundsEnabled 允許在嵌套語句中使用分頁（RowBounds） true false false mapUnderscoreToCamelCase 是否開啟駝峰驗證 true false false localCacheScope MyBatis 利用本地緩存機制（LocalCache）防止循環引用（circular references）和加速重復嵌套查詢。默認值為SESSION，這種情況下會緩存一個會話中執行的所有查詢。 若設置值為STATEMENT，本地會話僅用在語句執行上，對相同SqlSESSION的不同調用將不會共享數據。 SESSION STATEMENT SESSION jdbcTypeForNull 當沒有為參數提供特定的 JDBC 類型時，為空值指定JDBC 類型。 某些驅動需要指定列的JDBC 類型，多數情況直接用一般類型即可，比如 NULL、VARCHAR 或OTHER。 JdbcType枚舉類中的所有枚舉類型 OTHER lazyLoadTriggerMethods 指定哪個對象的方法觸發一次延遲加載，多個方法則用逗號隔開 - equals,clone,hashCode,toString defaultScriptingLanguage 指定動態SQL生成的默認語言 可以是類的別名也可以是全限定類名 org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver callSettersOnNulls 指定當結果集中值為null的時候是否調用映射對象的setter（map 對象時為 put）方法，這對于有Map.keySet()依賴或null值初始化的時候是有用的。注意基本類型（int、boolean等）是不能設置成null的 true false false logPrefix 指定 MyBatis 增加到日志名稱的前綴 任意字符串 - logImpl 指定 MyBatis 所用日志的具體實現，未指定時將自動查找 SLF4J LOG4J LOG4J2 JDK_LOGGING COMMONS_LOGGING STDOUT_LOGGING NO_LOGGING - proxyFactory 指定 Mybatis 創建具有延遲加載能力的對象所用到的代理工具。 CGLIB JAVASSIST JAVASSIST
自定義typeHandlers
上面是MyBatis提供的默認映射類型，可以處理大部分需求，如果我們需要有不同的需求，則可以自己定義類型，具體如何定義，在后面的文章會單獨分析，在這里不展開，感興趣的可以關注我，留意后續文章。
objectFactoryMyBatis 每次創建結果對象的新實例時，它都會使用一個對象工廠（ObjectFactory）實例來完成。 默認的對象工廠需要做的僅僅是實例化目標類，要么通過默認構造方法，要么在參數映射存在的時候通過參數構造方法來實例化。 如果想覆蓋對象工廠的默認行為，則 可以通過創建自己的對象工廠來實現
pluginsMyBatis 允許你在已映射語句執行過程中的某一點進行攔截調用。這里我們不詳細討論，后期會有單獨文章介紹MyBatis插件
environmentsMyBatis 可以配置成適應多種環境，這種機制有助于將 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 來阻止它默認的關閉行為。 如:<transactionManager type='MANAGED'><property name='closeConnection' value='false'/></transactionManager>
注意：如果單獨使用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 ? 在任意時間可以存在的活動（也就是正在使用）連接數量，默認值：10poolMaximumIdleConnections ? 任意時間可能存在的空閑連接數poolMaximumCheckoutTime ? 在被強制返回之前，池中連接被檢出（checked out）時間，默認值：20000 毫秒（即 20 秒）poolTimeToWait ? 這是一個底層設置，如果獲取連接花費的相當長的時間，它會給連接池打印狀態日志并重新嘗試獲取一個連接（避免在誤配置的情況下一直安靜的失敗），默認值：20000 毫秒（即 20 秒）poolPingQuery ? 發送到數據庫的偵測查詢，用來檢驗連接是否處在正常工作秩序中并準備接受請求。默認是“NO PING QUERY SET”，這會導致多數數據庫驅動失敗時帶有一個恰當的錯誤消息。poolPingEnabled ? 是否啟用偵測查詢。若開啟，也必須使用一個可執行的 SQL 語句設置 poolPingQuery 屬性（最好是一個非常快的 SQL），默認值：falsepoolPingConnectionsNotUsedFor ? 配置 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>
databaseIdProviderMyBatis 可以根據不同的數據庫廠商執行不同的語句，這種多廠商的支持是基于映射語句中的 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>
PS：上面的配置文件中所有的根節點需要按照順序配置，可以不配置某些屬性，但是如果配置了，從上到下一定要按照以下順序配置：properties，settings，typeAliases，typeHandlers，objectFactory，objectWrapperFactory，reflectorFactory，plugins，environments，databaseIdProvider，mappers
總結本文主要介紹了MyBatis中的核心配置文件的使用，本文其實更適合作為手冊來參考，只需大致瀏覽，心里有個印象，需要用的時候再去查詢即可
相關文章：
網公網安備