前言

上一篇我們通過(guò)將MyBatis和傳統(tǒng)JDBC,DBUtils,以及Hibernate作了簡(jiǎn)單的對(duì)比，并且列舉了一個(gè)非常簡(jiǎn)單的demo，今天這篇主要介紹一下MyBatis的全局配置文件的使用

configuration

mybatis-config.xml文件的頭部格式我們就不說(shuō)了，直接從屬性開(kāi)始介紹，configuration為最頂層節(jié)點(diǎn)，其余所有的屬性都必須嵌套在configuration內(nèi),MyBatis配置文件的頂層節(jié)點(diǎn)如下：

<properties></properties><!-- 屬性 --><settings></settings> <!-- 設(shè)置--><typeAliases></typeAliases><!-- 配置別名 --><typeHandlers></typeHandlers><!-- 類(lèi)型處理器 --><objectFactory></objectFactory><!-- 對(duì)象工廠(chǎng) --><plugins></plugins><!-- 插件 --><environments default=''><!-- 環(huán)境配置--> <environment id=''><!-- 環(huán)境變量 --> <transactionManager></transactionManager><!-- 事務(wù)管理器 --> <dataSource></dataSource><!-- 數(shù)據(jù)源 --> </environment></environments><databaseIdProvider></databaseIdProvider><!-- 數(shù)據(jù)庫(kù)廠(chǎng)商標(biāo)識(shí) --><mappers></mappers><!-- 映射器 -->

可以看到configuration內(nèi)的全部頂層節(jié)點(diǎn)只有9個(gè)，下面我們就一個(gè)個(gè)來(lái)分析一下

properties

下面是一個(gè)相對(duì)完整的屬性配置

<!-- 配置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>

上面我特意分開(kāi)寫(xiě)，就是怕引起大家的誤解，因?yàn)閞esource和url只允許存在一個(gè)，不能同時(shí)配置兩個(gè)屬性，可以看到源碼中的解析過(guò)程：

同時(shí)配置了resource和url會(huì)拋出異常。

配置了properties屬性之后，在xml其他配置文件中可以直接通過(guò)${xxx}來(lái)讀取。

properties配置有三種方式，resource或者url指定，直接配置在子節(jié)點(diǎn)properties中，另一種就是上一篇提到的，直接代碼中去其他地方讀取properties文件，然后傳入build方法。

那么這三種方式既然都能配置，假如屬性配置重復(fù)了，優(yōu)先級(jí)是怎么樣的呢？

properties優(yōu)先級(jí)

properties配置的屬性如果重復(fù)，優(yōu)先級(jí)如下：1、第一優(yōu)先：在代碼中直接通過(guò)properties傳入build方法。2、第二優(yōu)先：通過(guò)resource或者url讀取到的properties文件中屬性。3、第三優(yōu)先：直接在properties內(nèi)的子標(biāo)簽property內(nèi)定義的屬性。

在實(shí)際開(kāi)發(fā)中，建議是只使用一種，使用多種方式混合的話(huà)會(huì)給后期維護(hù)造成困難，而且不同類(lèi)型的配置屬性混合時(shí)可讀性也不好。

settings

settings是MyBatis中最復(fù)雜，也是最重要的內(nèi)容之一。當(dāng)然這里說(shuō)的復(fù)雜并不是說(shuō)配置方式復(fù)雜，而是settings能配置的東西非常多，一些很核心的功能都是通過(guò)settings標(biāo)簽配置的。

下面是一個(gè)完整的屬性配置示例：

<settings><!-- 設(shè)置--> <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>

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

參數(shù) 描述 可選值 默認(rèn)值 cacheEnabled 緩存配置的全局開(kāi)關(guān) true false true lazyLoadingEnabled 延遲加載全局開(kāi)關(guān)。當(dāng)開(kāi)啟時(shí)，所有關(guān)聯(lián)對(duì)象都會(huì)延遲加載。 特定關(guān)聯(lián)關(guān)系中可通過(guò)設(shè)置 sql語(yǔ)句上標(biāo)簽的fetchType 屬性來(lái)覆蓋該項(xiàng)的開(kāi)關(guān)狀態(tài)。 true false false aggressiveLazyLoading 當(dāng)啟用時(shí)，對(duì)任意延遲屬性的調(diào)用會(huì)使帶有延遲加載屬性的對(duì)象完整加載；反之，每種屬性將會(huì)按需加載。 true false true multipleResultSetsEnabled 是否允許單一語(yǔ)句返回多結(jié)果集（需要兼容驅(qū)動(dòng)） true false true useColumnLabel 使用列標(biāo)簽代替列名。不同的驅(qū)動(dòng)在這方面會(huì)有不同的表現(xiàn)， 具體可參考相關(guān)驅(qū)動(dòng)文檔或通過(guò)測(cè)試這兩種不同的模式來(lái)觀(guān)察所用驅(qū)動(dòng)的結(jié)果。 true false true useGeneratedKeys 允許 JDBC 支持自動(dòng)生成主鍵，需要驅(qū)動(dòng)兼容。 如果設(shè)置為 true 則這個(gè)設(shè)置強(qiáng)制使用自動(dòng)生成主鍵，盡管一些驅(qū)動(dòng)不能兼容但仍可正常工作（比如Derby）。 true false false autoMappingBehavior 指定 MyBatis 應(yīng)如何自動(dòng)映射列到字段或?qū)傩浴?NONE表示取消自動(dòng)映射；PARTIAL只會(huì)自動(dòng)映射沒(méi)有定義嵌套結(jié)果集映射的結(jié)果集。FULL會(huì)自動(dòng)映射任意復(fù)雜的結(jié)果集（無(wú)論是否嵌套）。 NONE PARTIAL FULL PARTIAL defaultExecutorType 配置默認(rèn)的執(zhí)行器。SIMPLE 就是普通的執(zhí)行器；REUSE 執(zhí)行器會(huì)重用預(yù)處理語(yǔ)句（prepared statements）；BATCH 執(zhí)行器將重用語(yǔ)句并執(zhí)行批量更新。 SIMPLE REUSE BATCH SIMPLE defaultStatementTimeout 設(shè)置超時(shí)時(shí)間，它決定驅(qū)動(dòng)等待數(shù)據(jù)庫(kù)響應(yīng)的秒數(shù) 有效的整數(shù) 默認(rèn)null safeRowBoundsEnabled 允許在嵌套語(yǔ)句中使用分頁(yè)（RowBounds） true false false mapUnderscoreToCamelCase 是否開(kāi)啟駝峰驗(yàn)證 true false false localCacheScope MyBatis 利用本地緩存機(jī)制（LocalCache）防止循環(huán)引用（circular references）和加速重復(fù)嵌套查詢(xún)。默認(rèn)值為SESSION，這種情況下會(huì)緩存一個(gè)會(huì)話(huà)中執(zhí)行的所有查詢(xún)。 若設(shè)置值為STATEMENT，本地會(huì)話(huà)僅用在語(yǔ)句執(zhí)行上，對(duì)相同SqlSESSION的不同調(diào)用將不會(huì)共享數(shù)據(jù)。 SESSION STATEMENT SESSION jdbcTypeForNull 當(dāng)沒(méi)有為參數(shù)提供特定的 JDBC 類(lèi)型時(shí)，為空值指定JDBC 類(lèi)型。 某些驅(qū)動(dòng)需要指定列的JDBC 類(lèi)型，多數(shù)情況直接用一般類(lèi)型即可，比如 NULL、VARCHAR 或OTHER。 JdbcType枚舉類(lèi)中的所有枚舉類(lèi)型 OTHER lazyLoadTriggerMethods 指定哪個(gè)對(duì)象的方法觸發(fā)一次延遲加載，多個(gè)方法則用逗號(hào)隔開(kāi) - equals,clone,hashCode,toString defaultScriptingLanguage 指定動(dòng)態(tài)SQL生成的默認(rèn)語(yǔ)言 可以是類(lèi)的別名也可以是全限定類(lèi)名 org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver callSettersOnNulls 指定當(dāng)結(jié)果集中值為null的時(shí)候是否調(diào)用映射對(duì)象的setter（map 對(duì)象時(shí)為 put）方法，這對(duì)于有Map.keySet()依賴(lài)或null值初始化的時(shí)候是有用的。注意基本類(lèi)型（int、boolean等）是不能設(shè)置成null的 true false false logPrefix 指定 MyBatis 增加到日志名稱(chēng)的前綴 任意字符串 - logImpl 指定 MyBatis 所用日志的具體實(shí)現(xiàn)，未指定時(shí)將自動(dòng)查找 SLF4J LOG4J LOG4J2 JDK_LOGGING COMMONS_LOGGING STDOUT_LOGGING NO_LOGGING - proxyFactory 指定 Mybatis 創(chuàng)建具有延遲加載能力的對(duì)象所用到的代理工具。 CGLIB JAVASSIST JAVASSIST

自定義typeHandlers

上面是MyBatis提供的默認(rèn)映射類(lèi)型，可以處理大部分需求，如果我們需要有不同的需求，則可以自己定義類(lèi)型，具體如何定義，在后面的文章會(huì)單獨(dú)分析，在這里不展開(kāi)，感興趣的可以關(guān)注我，留意后續(xù)文章。

objectFactory

MyBatis 每次創(chuàng)建結(jié)果對(duì)象的新實(shí)例時(shí)，它都會(huì)使用一個(gè)對(duì)象工廠(chǎng)（ObjectFactory）實(shí)例來(lái)完成。 默認(rèn)的對(duì)象工廠(chǎng)需要做的僅僅是實(shí)例化目標(biāo)類(lèi)，要么通過(guò)默認(rèn)構(gòu)造方法，要么在參數(shù)映射存在的時(shí)候通過(guò)參數(shù)構(gòu)造方法來(lái)實(shí)例化。 如果想覆蓋對(duì)象工廠(chǎng)的默認(rèn)行為，則 可以通過(guò)創(chuàng)建自己的對(duì)象工廠(chǎng)來(lái)實(shí)現(xiàn)

plugins

MyBatis 允許你在已映射語(yǔ)句執(zhí)行過(guò)程中的某一點(diǎn)進(jìn)行攔截調(diào)用。這里我們不詳細(xì)討論，后期會(huì)有單獨(dú)文章介紹MyBatis插件

environments

MyBatis 可以配置成適應(yīng)多種環(huán)境，這種機(jī)制有助于將 SQL 映射應(yīng)用于多種數(shù)據(jù)庫(kù)之中，例如：開(kāi)發(fā)、測(cè)試和生產(chǎn)環(huán)境需要有不同的配置；或者共享相同 Schema 的多個(gè)生產(chǎn)數(shù)據(jù)庫(kù)， 想使用相同的 SQL 映射。許多類(lèi)似的用例。 注意：盡管可以配置多個(gè)環(huán)境，每個(gè)SqlSessionFactory實(shí)例只能選擇其一。所以，如果想連接兩個(gè)數(shù)據(jù)庫(kù)，就需要?jiǎng)?chuàng)建兩個(gè)SqlSessionFactory實(shí)例，每個(gè)數(shù)據(jù)庫(kù)對(duì)應(yīng)一個(gè)。 配置示例如下：<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配置關(guān)鍵點(diǎn):默認(rèn)的環(huán)境 ID（比如:default=”development”）每個(gè) environment 元素定義的環(huán)境 ID（比如:id=”development”）。事務(wù)管理器的配置（比如:type=”JDBC”）。數(shù)據(jù)源的配置（比如:type=”P(pán)OOLED”）。

事務(wù)管理器

在 MyBatis 中有兩種類(lèi)型的事務(wù)管理器（也就是 type=”JDBC'或者'MANAGED”）:JDBC：這個(gè)配置就是直接使用了 JDBC 的提交和回滾設(shè)置，它依賴(lài)于從數(shù)據(jù)源得到的連接來(lái)管理事務(wù)范圍。MANAGED：這個(gè)配置幾乎沒(méi)做什么。它從來(lái)不提交或回滾一個(gè)連接，而是讓容器來(lái)管理事務(wù)的整個(gè)生命周期（比如J2EE應(yīng)用容器上下文）。 默認(rèn)情況下它會(huì)關(guān)閉連接，然而一些容器并不希望這樣，因此需要將 closeConnection 屬性設(shè)置為 false 來(lái)阻止它默認(rèn)的關(guān)閉行為。 如:<transactionManager type='MANAGED'><property name='closeConnection' value='false'/></transactionManager>

注意：如果單獨(dú)使用MyBatis而沒(méi)有集成能管理事務(wù)的容器，那么配置成MANAGED就會(huì)等同于沒(méi)有事務(wù)，所以一般單獨(dú)使用MyBatis時(shí)，應(yīng)配置為JDBC。

數(shù)據(jù)源

dataSource元素使用標(biāo)準(zhǔn)的 JDBC 數(shù)據(jù)源接口來(lái)配置JDBC連接對(duì)象的資源。有三種內(nèi)建的數(shù)據(jù)源類(lèi)型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）。

UNPOOLED

非連接池?cái)?shù)據(jù)源。UNPOOLED 類(lèi)型的數(shù)據(jù)源僅僅需要配置以下 5 種屬性：driver ? 這是 JDBC 驅(qū)動(dòng)的 Java 類(lèi)的完全限定名（并不是JDBC驅(qū)動(dòng)中可能包含的數(shù)據(jù)源類(lèi)）url ? 這是數(shù)據(jù)庫(kù)的 JDBC URL 地址username ? 登錄數(shù)據(jù)庫(kù)的用戶(hù)名password ? 登錄數(shù)據(jù)庫(kù)的密碼defaultTransactionIsolationLevel ? 默認(rèn)的連接事務(wù)隔離級(jí)別

POOLED

連接池?cái)?shù)據(jù)源。除了上述提到UNPOOLED下的屬性外，會(huì)有更多屬性用來(lái)配置 POOLED 的數(shù)據(jù)源：poolMaximumActiveConnections ? 在任意時(shí)間可以存在的活動(dòng)（也就是正在使用）連接數(shù)量，默認(rèn)值：10poolMaximumIdleConnections ? 任意時(shí)間可能存在的空閑連接數(shù)poolMaximumCheckoutTime ? 在被強(qiáng)制返回之前，池中連接被檢出（checked out）時(shí)間，默認(rèn)值：20000 毫秒（即 20 秒）poolTimeToWait ? 這是一個(gè)底層設(shè)置，如果獲取連接花費(fèi)的相當(dāng)長(zhǎng)的時(shí)間，它會(huì)給連接池打印狀態(tài)日志并重新嘗試獲取一個(gè)連接（避免在誤配置的情況下一直安靜的失敗），默認(rèn)值：20000 毫秒（即 20 秒）poolPingQuery ? 發(fā)送到數(shù)據(jù)庫(kù)的偵測(cè)查詢(xún)，用來(lái)檢驗(yàn)連接是否處在正常工作秩序中并準(zhǔn)備接受請(qǐng)求。默認(rèn)是“NO PING QUERY SET”，這會(huì)導(dǎo)致多數(shù)數(shù)據(jù)庫(kù)驅(qū)動(dòng)失敗時(shí)帶有一個(gè)恰當(dāng)?shù)腻e(cuò)誤消息。poolPingEnabled ? 是否啟用偵測(cè)查詢(xún)。若開(kāi)啟，也必須使用一個(gè)可執(zhí)行的 SQL 語(yǔ)句設(shè)置 poolPingQuery 屬性（最好是一個(gè)非常快的 SQL），默認(rèn)值：falsepoolPingConnectionsNotUsedFor ? 配置 poolPingQuery 的使用頻度。這可以被設(shè)置成匹配具體的數(shù)據(jù)庫(kù)連接超時(shí)時(shí)間，來(lái)避免不必要的偵測(cè)，默認(rèn)值：0（即所有連接每一時(shí)刻都被偵測(cè) — 當(dāng)然僅當(dāng) poolPingEnabled 為 true 時(shí)適用）

JNDI

這個(gè)數(shù)據(jù)源的實(shí)現(xiàn)是為了能在如 EJB 或應(yīng)用服務(wù)器這類(lèi)容器中使用，容器可以集中或在外部配置數(shù)據(jù)源，然后放置一個(gè) JNDI 上下文的引用。這種數(shù)據(jù)源配置只需要兩個(gè)屬性：initial_context ? 這個(gè)屬性用來(lái)在 InitialContext 中尋找上下文（即，initialContext.lookup(initial_context)）。這是個(gè)可選屬性，如果忽略，那么 data_source 屬性將會(huì)直接從 InitialContext 中尋找。data_source ? 這是引用數(shù)據(jù)源實(shí)例位置的上下文的路徑。提供了 initial_context 配置時(shí)會(huì)在其返回的上下文中進(jìn)行查找，沒(méi)有提供時(shí)則直接在 InitialContext 中查找。

自定義數(shù)據(jù)源

有些業(yè)務(wù)場(chǎng)景可能需要自己自定義數(shù)據(jù)源，MyBatis也是支持的。自定義數(shù)據(jù)源必須要實(shí)現(xiàn)DataSourceFactory接口。然后采用如下配置： <dataSource type='自定義數(shù)據(jù)源全限定類(lèi)名'></dataSource>

databaseIdProvider

MyBatis 可以根據(jù)不同的數(shù)據(jù)庫(kù)廠(chǎng)商執(zhí)行不同的語(yǔ)句，這種多廠(chǎng)商的支持是基于映射語(yǔ)句中的 databaseId 屬性。 MyBatis 會(huì)加載不帶 databaseId 屬性和帶有匹配當(dāng)前數(shù)據(jù)庫(kù) databaseId 屬性的所有語(yǔ)句。如果同時(shí)找到帶有databaseId 和不帶 databaseId 的相 同語(yǔ)句，則后者會(huì)被舍棄。 為支持多廠(chǎng)商特性只要像下面這樣在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：<databaseIdProvider type='DB_VENDOR' />

mappers

這個(gè)就是用來(lái)配置sql映射語(yǔ)句的xml文件了。mappers文件共有4種配置方式：1、直接配置xml映射文件全限定名<mappers><mapper resource='com/lonelyWolf/mybatis/mapping/UserMapper.xml'/> </mappers>

2、通過(guò)url配置本地或者遠(yuǎn)程映射文件路徑<mappers><mapper url='file://xxx.xxx.UserMapper.xml'></mapper> </mappers> 3、通過(guò)配置Mapper接口的方式來(lái)配置。<mappers><mapper class='com.lonelyWolf.mybatis.mapper.UserMapper'></mapper> </mappers>

4、通過(guò)配置Mapper接口包名的形式來(lái)配置<mappers><package name='com.lonelyWolf.mybatis.mapper'/> </mappers>

注意：在使用第3和第4兩種方式配置的時(shí)候，需要把xml映射文件和Mapper接口文件放在同一個(gè)目錄，而且必須同名。

如果用的是maven配置的話(huà)，可能會(huì)出現(xiàn)以下錯(cuò)誤：Invalid bound statement (not found)，出現(xiàn)之后需要注意檢查一下target下面的class目錄內(nèi)有沒(méi)有xml映射文件，如果沒(méi)有的話(huà)需要在pom文件中加入以下配置(因?yàn)閙aven默認(rèn)不會(huì)加載xml文件)： <build><resources> <resource><directory>src/main/java</directory><includes> <include>**/*.xml</include></includes> </resource></resources> </build>

PS：上面的配置文件中所有的根節(jié)點(diǎn)需要按照順序配置，可以不配置某些屬性，但是如果配置了，從上到下一定要按照以下順序配置：properties，settings，typeAliases，typeHandlers，objectFactory，objectWrapperFactory，reflectorFactory，plugins，environments，databaseIdProvider，mappers

總結(jié)

本文主要介紹了MyBatis中的核心配置文件的使用，本文其實(shí)更適合作為手冊(cè)來(lái)參考，只需大致瀏覽，心里有個(gè)印象，需要用的時(shí)候再去查詢(xún)即可