MyBatis配置文件（mybatis-config.xml）

在《第一個(gè)MyBatis程序》一節(jié)中，我們編寫了 MyBatis 的配置文件 mybatis-config.xml，在該文件中，您可以配置各種元素。

MyBatis 配置文件的結(jié)構(gòu)如下。

<?xml version="1.0" encoding="utf-8"?>
                    <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration><!-- 配置 -->
    <properties /><!-- 屬性 -->
    <settings /><!-- 設(shè)置 -->
    <typeAliases /><!-- 類型命名 -->
    <typeHandlers /><!-- 類型處理器 -->
    <objectFactory /><!-- 對(duì)象工廠 -->
    <plugins /><!-- 插件 -->
    <environments><!-- 配置環(huán)境 -->
        <environment><!-- 環(huán)境變量 -->
            <transactionManager /><!-- 事務(wù)管理器 -->
            <dataSource /><!-- 數(shù)據(jù)源 -->
        </environment>
    </environments>
    <databaseIdProvider /><!-- 數(shù)據(jù)庫(kù)廠商標(biāo)識(shí) -->
    <mappers /><!-- 映射器 -->
</configuration>
                

mybatis-config.xml 文件中的元素節(jié)點(diǎn)是有一定順序的，節(jié)點(diǎn)位置必須按以上位置排序，否則會(huì)編譯錯(cuò)誤。

下面介紹 XML 配置文件中的重要元素（標(biāo)簽）。

configuration 元素是整個(gè) XML 配置文件的根節(jié)點(diǎn)，其角色就相當(dāng)于是 MyBatis 的總管，MyBatis 所有的配置信息都會(huì)存放在它里面。

properties標(biāo)簽

properties 標(biāo)簽可以通過(guò) resource 屬性指定外部 properties 文件（database.properties），也可以通過(guò) properties 子元素配置。

1. 指定文件

使用 properties 指定外部文件，代碼如下。

<properties resource="mybatisDemo/resources/database.properties"/>
                

database.properties 用于描述數(shù)據(jù)庫(kù)連接的相關(guān)配置，例如數(shù)據(jù)庫(kù)驅(qū)動(dòng)、連接數(shù)據(jù)庫(kù)的 url、數(shù)據(jù)庫(kù)用戶名、數(shù)據(jù)庫(kù)密碼等。

2. properties子元素配置

通過(guò) properties 子元素 property 配置 username 和 password 變量，然后在 environments 節(jié)點(diǎn)中引用這些變量，代碼如下。

<properties>
    <property name="username" value="root"/>
    <property name="password" value="root"/>
</properties>
                

在 environments 節(jié)點(diǎn)中引用 username 和 password 變量。

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <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>
                

也可以不使用 properties 標(biāo)簽，直接將屬性值寫在 value 中。

settings標(biāo)簽

settings 標(biāo)簽用于配置 MyBatis 的運(yùn)行時(shí)行為，它能深刻的影響 MyBatis 的底層運(yùn)行，一般不需要大量配置，大部分情況下使用其默認(rèn)值即可。

settings 的配置項(xiàng)很多，但是真正用到的不會(huì)太多，我們把常用的配置項(xiàng)研究清楚就可以了。settings 配置項(xiàng)說(shuō)明如下表所示（表中紅色字體的配置項(xiàng)為常用配置項(xiàng)）。

settings 配置項(xiàng)說(shuō)明

下面給出一個(gè)全量的配置樣例，如下所示。

<settings>
    <setting name="cacheEnabled" value="true"/>
    <setting name="lazyLoadingEnabled" value="true"/>
    <setting name="multipleResultSetsEnabled" value="true"/>
    <setting name="useColumnLabel" value="true"/>
    <setting name="useGeneratedKeys" value="false"/>
    <setting name="autoMappingBehavior" value="PARTIAL"/>
    <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
    <setting name="defaultExecutorType" value="SIMPLE"/>
    <setting name="defaultStatementTimeout" value="25"/>
    <setting name="defaultFetchSize" value="100"/>
    <setting name="safeRowBoundsEnabled" value="false"/>
    <setting name="mapUnderscoreToCamelCase" value="false"/>
    <setting name="localCacheScope" value="SESSION"/>
    <setting name="jdbcTypeForNull" value="OTHER"/>
    <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>
                

typeAliases標(biāo)簽

為了不在任何地方都指定類的全限定名，我們可以使用 typeAliases 標(biāo)簽定義一個(gè)別名。

例如，在 net.bianchengbang.po 包中有一個(gè) Student 類，則該類的全限定名稱為 net.bianchengbang.po.Student。使用 typeAliases 標(biāo)簽定義別名，這樣就不用每次都書寫類的全限定名稱了，代碼如下。

<typeAliases>
    <typeAlias alias = "Student" type = "net.bianchengbang.po.Student"/>
</typeAliases>
                

如果需要對(duì)同一個(gè)包下的多個(gè)類定義別名，則可以定義為：

<typeAliases>
    <package name="net.biancheng.po"/>
</typeAliases>
                

這樣 MyBatis 將掃描 net.biancheng.po 包里面的類，將其第一個(gè)字母變?yōu)樾懽鳛槠鋭e名，例如 Student 別名為 student，User 別名為 user。

typeHandlers標(biāo)簽

typeHandlers 主要將獲取的值合理地轉(zhuǎn)化為 Java 類型。在 typeHandler 中，分為 jdbcType 和 javaType，其中 jdbcType 用于定義數(shù)據(jù)庫(kù)類型，而 javaType 用于定義 Java 類型，typeHandler 的作用就是承擔(dān) jdbcType 和 javaType 之間的相互轉(zhuǎn)換。

MyBatis 支持自定義處理類型，在自定義處理類型時(shí)，需要實(shí)現(xiàn) org.apache.ibatis.type.TypeHandler 接口或繼承 org.apache.ibatis.type.BaseTypeHandle 類。詳細(xì)可參考官網(wǎng)：http://www.mybatis.org/mybatis-3/zh/configuration.html#typeHandlers

environments標(biāo)簽

在 environments 標(biāo)簽中，可以配置 MyBatis 的多套運(yùn)行環(huán)境，將 SQL 映射到多個(gè)不同的數(shù)據(jù)庫(kù)上。

environment 是 environments 的子標(biāo)簽，用來(lái)配置 MyBatis 的一套運(yùn)行環(huán)境，需指定運(yùn)行環(huán)境 ID、事務(wù)管理、數(shù)據(jù)源配置等相關(guān)信息。

我們可以通過(guò)配置多個(gè) environment 標(biāo)簽來(lái)連接多個(gè)數(shù)據(jù)庫(kù)，需要注意的是必須指定其中一個(gè)為默認(rèn)運(yùn)行環(huán)境（通過(guò)default指定）。

environment 標(biāo)簽提供了兩個(gè)子標(biāo)簽，即 transactionManager 和 dataSource。

transactionManager標(biāo)簽

MyBatis 支持兩個(gè)事務(wù)管理器，即 JDBC 和 MANAGED。

如果使用 JDBC 類型的事務(wù)管理器，則應(yīng)用程序服務(wù)器負(fù)責(zé)事務(wù)管理操作，例如提交、回滾等。如果使用 MANAGED 類型的事務(wù)管理器，則應(yīng)用程序服務(wù)器負(fù)責(zé)管理連接生命周期。

dataSource標(biāo)簽

用于配置數(shù)據(jù)庫(kù)的連接屬性，例如要連接的數(shù)據(jù)庫(kù)的驅(qū)動(dòng)程序名稱、URL、用戶名和密碼等。

dataSource 中的 type 屬性用于指定數(shù)據(jù)源類型，有以下 3 種類型。

1）UNPOOLED

UNPOOLED 沒(méi)有數(shù)據(jù)庫(kù)連接池，效率低下。MyBatis 需要打開和關(guān)閉每個(gè)數(shù)據(jù)庫(kù)操作的連接，它有點(diǎn)慢，通常應(yīng)用于簡(jiǎn)單的應(yīng)用程序。

2）POOLED

對(duì)于 POOLED 數(shù)據(jù)源類型，MyBatis 將維護(hù)一個(gè)數(shù)據(jù)庫(kù)連接池。并且對(duì)于每個(gè)數(shù)據(jù)庫(kù)的操作，MyBatis 都會(huì)使用連接池中的連接，并在操作完成后將它們返回到池中。減少了創(chuàng)建新連接所需的初始連接和身份驗(yàn)證時(shí)間。

3）JNDI

對(duì)于 JNDI 的數(shù)據(jù)源類型，MyBatis 將從 JNDI 數(shù)據(jù)源中獲取連接。

dataSource 標(biāo)簽示例代碼如下：

<dataSource type="POOLED">
    <!-- MySQL數(shù)據(jù)庫(kù)驅(qū)動(dòng) -->
    <property name="driver" value="com.mysql.jdbc.Driver" />
    <!-- 連接數(shù)據(jù)庫(kù)的URL -->
    <property name="url"
              value="jdbc:mysql://localhost:3306/test?characterEncoding=utf8" />
    <property name="username" value="root" />
    <property name="password" value="root" />
</dataSource>
                

mappers標(biāo)簽

mappers 標(biāo)簽用于指定 MyBatis SQL 映射文件的路徑。

mapper 是 mappers 的子標(biāo)簽，mapper 中的 resource 屬性用于指定 SQL 映射文件的路徑（類資源路徑）

例如，SQL 映射文件的名稱是 Student.xml，它位于名為 net.biancheng.mapper 的包中，那么您可以這樣配置：

<mappers>
    <mapper resource="net/biancheng/mapper/Student.xml"/>
</mappers>