最全 MyBatis 核心配置文件總結(jié)，速度收藏了～

前言

今天這咱主要介紹一下 MyBatis 的全局配置文件的使用。

configuration

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

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內(nèi)的全部頂層節(jié)點(diǎn)只有9個(gè)，下面我們就一個(gè)個(gè)來(lái)分析一下

properties

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

<properties?resource="xxx/xxx.properties">
???<property?name="jdbc.driver"?value="db.properties"/>
properties>

<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ì)給后期維護(hù)造成困難，而且不同類型的配置屬性混合時(shí)可讀性也不好。

settings

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

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

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

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

typeAliases

類型別名是為 Java 類型設(shè)置一個(gè)短的名字。它只和 XML 配置有關(guān)，存在的意義僅在于用來(lái)減少類完全限定名的冗余。

直接指定類名

例如：

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

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

只指定包名

也可以指定一個(gè)包名，MyBatis會(huì)在包名下面搜索需要的 Java Bean，比如:

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

這么配置的話每一個(gè)在指定包名中的Java類，如果沒(méi)有使用注解指定名稱，則會(huì)默認(rèn)使用Bean的首字母小寫(xiě)的非限定類名來(lái)作為它的別名，如果有注解，則優(yōu)先使用注解指定的別名。如：

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

這里因?yàn)樽⒔庵付藙e名，所以會(huì)以注解為準(zhǔn)，如果沒(méi)有注解，則默認(rèn)使用lonelyWolf作為別名。

系統(tǒng)默認(rèn)提供的別名

實(shí)際開(kāi)發(fā)中，有很多返回類型是數(shù)據(jù)基本類型或者String,Map,List等非常常見(jiàn)的類型，這些類型MyBatis已經(jīng)為我們提供好了別名，我們就不需要另外再定義了。以下就時(shí)MyBatis中默認(rèn)提供的別名：PS：這些別名的字母都是不區(qū)分大小寫(xiě)的，因?yàn)?a target="_blank" textvalue="MyBatis" data-itemshowtype="0" tab="innerlink" style="font-family: Optima-Regular, Optima, PingFangSC-light, PingFangTC-light, "PingFang SC", Cambria, Cochin, Georgia, Times, "Times New Roman", serif;font-size: 16px;letter-spacing: 0.8px;text-align: left;white-space: normal;word-spacing: 0.8px;" data-linktype="2">MyBatis在注冊(cè)別名的時(shí)候會(huì)全部轉(zhuǎn)為小寫(xiě)字母存儲(chǔ)。

typeHandlers

typeHandlers主要是用來(lái)實(shí)現(xiàn)Java對(duì)象和數(shù)據(jù)庫(kù)字段類型額轉(zhuǎn)換關(guān)系。無(wú)論是 MyBatis 在預(yù)處理語(yǔ)句（PreparedStatement）中設(shè)置一個(gè)參數(shù)時(shí)，還是從結(jié)果集中取出一個(gè)值時(shí)， 都會(huì)用類型處理器將獲取的值以合適的方式轉(zhuǎn)換成 Java 類型。配置方式如下：

<typeHandlers>
??
????<typeHandler?handler="xxx.xxx.xxx">typeHandler>
????
????<package?name="xxx.xxx"/>
typeHandlers>

MyBatis默認(rèn)提供的Java Bean和數(shù)據(jù)庫(kù)字段類型映射關(guān)系如下：

自定義typeHandlers

上面是MyBatis提供的默認(rèn)映射類型，可以處理大部分需求，如果我們需要有不同的需求，則可以自己定義類型，具體如何定義，在后面的文章會(huì)單獨(dú)分析，在這里不展開(kāi)，感興趣的可以關(guān)注Java技術(shù)棧，留意后續(xù)文章。關(guān)注公眾號(hào)Java技術(shù)棧獲取更多 Mybatis 教程。

objectFactory

MyBatis 每次創(chuàng)建結(jié)果對(duì)象的新實(shí)例時(shí)，它都會(huì)使用一個(gè)對(duì)象工廠（ObjectFactory）實(shí)例來(lái)完成。

默認(rèn)的對(duì)象工廠需要做的僅僅是實(shí)例化目標(biāo)類，要么通過(guò)默認(rèn)構(gòu)造方法，要么在參數(shù)映射存在的時(shí)候通過(guò)參數(shù)構(gòu)造方法來(lái)實(shí)例化。如果想覆蓋對(duì)象工廠的默認(rèn)行為，則 可以通過(guò)創(chuàng)建自己的對(duì)象工廠來(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 映射。

許多類似的用例。注意：盡管可以配置多個(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 中有兩種類型的事務(wù)管理器（也就是 type=”JDBC"或者"MANAGED”）:

• JDBC：這個(gè)配置就是直接使用了 JDBC 的提交和回滾設(shè)置，它依賴于從數(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)閉行為。如:注意：如果單獨(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ù)源類型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）。

UNPOOLED

非連接池?cái)?shù)據(jù)源。UNPOOLED 類型的數(shù)據(jù)源僅僅需要配置以下 5 種屬性：

• driver – 這是 JDBC 驅(qū)動(dòng)的 Java 類的完全限定名（并不是JDBC驅(qū)動(dòng)中可能包含的數(shù)據(jù)源類）
• url – 這是數(shù)據(jù)庫(kù)的 JDBC URL 地址
• username – 登錄數(shù)據(jù)庫(kù)的用戶名
• 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)值：10
• poolMaximumIdleConnections – 任意時(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è)查詢，用來(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è)查詢。若開(kāi)啟，也必須使用一個(gè)可執(zhí)行的 SQL 語(yǔ)句設(shè)置 poolPingQuery 屬性（最好是一個(gè)非常快的 SQL），默認(rèn)值：false
• poolPingConnectionsNotUsedFor – 配置 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ù)器這類容器中使用，容器可以集中或在外部配置數(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接口。然后采用如下配置：

"自定義數(shù)據(jù)源全限定類名">dataSource>

databaseIdProvider

MyBatis 可以根據(jù)不同的數(shù)據(jù)庫(kù)廠商執(zhí)行不同的語(yǔ)句，這種多廠商的支持是基于映射語(yǔ)句中的 databaseId 屬性。

MyBatis 會(huì)加載不帶 databaseId 屬性和帶有匹配當(dāng)前數(shù)據(jù)庫(kù) databaseId 屬性的所有語(yǔ)句。如果同時(shí)找到帶有databaseId 和不帶 databaseId 的相 同語(yǔ)句，則后者會(huì)被舍棄。

為支持多廠商特性只要像下面這樣在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

type="DB_VENDOR"?/>

mappers

這個(gè)就是用來(lái)配置sql映射語(yǔ)句的xml文件了。

mappers文件共有4種配置方式：

1、直接配置xml映射文件全限定名

????<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)配置

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

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

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

<build>?
???<resources>
????????<resource>
????????????<directory>src/main/javadirectory>
????????????<includes>
????????????????<include>**/*.xmlinclude>
????????????includes>
????????resource>
????resources>
build>

總結(jié)

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

戳原文，獲取精選面試題！