Mybatis的配置文件包含了影響MyBatis行為的設(shè)置（setting）和屬性（properties）信息吮便。

properties

properties中配置的屬性都是可外部配置且可動態(tài)替換的笔呀。可以在典型的Java屬性文件中配置髓需，也可以通過properties元素的子元素來傳遞许师。

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="root"/>
  <property name="password" value="sa"/>
</properties>

然后其屬性就可以在整個配置文件中用來替換需要動態(tài)配置的屬性值：

<dataSource type="POOLED">
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

屬性也可以被傳遞到SqlSessionFactoryBuilder.build()方法中：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, props);
// ... or ..
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);

多個地方配置屬性

如果屬性不只在一個地方進(jìn)行了配置，那么MyBatis按照如下順序加載：

• properties元素內(nèi)指定的元素首先讀取
• 根據(jù)properties元素中的resource屬性讀取類路徑下屬性文件或者根據(jù)url屬性指定的路徑讀取屬性文件僚匆，并覆蓋已讀取的同名屬性
• 最后讀取作為方法參數(shù)傳遞的屬性微渠，并覆蓋已讀取的同名屬性

屬性默認(rèn)值

可以為屬性指定一個默認(rèn)值：

<dataSource type="POOLED">
  <!-- ... -->
  <!-- If 'username' property not present, username become 'ut_user' -->
  <property name="username" value="${username:ut_user}"/> 
</dataSource>

該功能默認(rèn)關(guān)閉，需要指定一個屬性來開啟：

<properties resource="org/mybatis/example/config.properties">
  <!-- ... -->
  <!-- Enable this feature -->
  <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
</properties>

可以使用 ":" 作為屬性鍵(e.g. db:username) 或者你也可以在sql定義中使用 OGNL 表達(dá)式的三元運算符(e.g. ${tableName != null ? tableName : 'global_constants'})白热， 你應(yīng)該通過增加一個指定的屬性來改變分隔鍵和默認(rèn)值的字符敛助。例如：

<properties resource="org/mybatis/example/config.properties">
  <!-- ... -->
  <!-- Change default value of separator -->
  <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/> 
</properties>

<dataSource type="POOLED">
  <!-- ... -->
  <property name="username" value="${db:username?:ut_user}"/>
</dataSource>

setting

改變MyBatis運行時的行為。

一個配置完整的setting元素

<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

類別名是為Java類型設(shè)置一個短的名字而芥，只與XML配置有關(guān)矾屯，存在的意義僅在于減少類完全限定名的冗余。

<typeAliases>
    <typeAlias alias="Author" type="domain.blog.Author"/>
    <typeAlias alias="Blog" type="domain.blog.Blog"/>
</typeAliases>

也可以指定包名，MyBatis會在包名下面搜索需要的Java Bean：

<typeAliases>
    <package name="domain.blog"/>
</typeAliases>

每一個在包 domain.blog 中的 Java Bean砰苍，在沒有注解的情況下嗤形，會使用 Bean 的首字母小寫的非限定類名來作為它的別名无埃。 比如 domain.blog.Author 的別名為 author鹤树；若有注解，則別名為其注解值椰拒。例如：

@Alias("author")
public class Author {
    ...
}

內(nèi)建別名

這是一些為常見的 Java 類型內(nèi)建的相應(yīng)的類型別名晶渠。它們都是大小寫不敏感的，需要注意的是由基本類型名稱重復(fù)導(dǎo)致的特殊處理耸三。

typeHandlers

MyBatis 在預(yù)處理語句（PreparedStatement）中設(shè)置一個參數(shù)乱陡，或者從結(jié)果集中取出一個值， 都會用類型處理器將獲取的值以合適的方式轉(zhuǎn)換成 Java 類型仪壮。下表描述了一些默認(rèn)的類型處理器：

重寫/創(chuàng)建類型處理器

可以重寫類型處理器或創(chuàng)建類型處理器來處理不支持的或非標(biāo)準(zhǔn)的類型爽彤。 具體做法為：

• 實現(xiàn) org.apache.ibatis.type.TypeHandler 接口
• 繼承一個很便利的類 org.apache.ibatis.type.BaseTypeHandler，
  然后可以選擇性地將它映射到一個 JDBC 類型缚陷。比如：

// ExampleTypeHandler.java
@MappedJdbcTypes(JdbcType.VARCHAR)
public class ExampleTypeHandler extends BaseTypeHandler<String> {

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
    ps.setString(i, parameter);
  }

  @Override
  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
    return rs.getString(columnName);
  }

  @Override
  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    return rs.getString(columnIndex);
  }

  @Override
  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    return cs.getString(columnIndex);
  }
}

<!-- mybatis-config.xml -->
<typeHandlers>
  <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
</typeHandlers>

處理枚舉類型

若想映射枚舉類型 Enum适篙，則需要從 EnumTypeHandler 或者 EnumOrdinalTypeHandler 中選一個來使用。

對象工廠（objectFactory）

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

效斑。非春。。

插件（plugins）

MyBatis 允許你在已映射語句執(zhí)行過程中的某一點進(jìn)行攔截調(diào)用缓屠。默認(rèn)情況下奇昙，MyBatis 允許使用插件來攔截的方法調(diào)用包括：

• Executor(update,query,flushStatements,commit,rollback,getTransaction, close,isClosed)
• ParameterHandler (getParameterObject, setParameters)
• ResultSetHandler (handleResultSets, handleOutputParameters)
• StatementHandler (prepare, parameterize, batch, update, query)

使用插件，只需要實現(xiàn) Interceptor 接口敌完，并指定想要攔截的方法簽名即可储耐。

// ExamplePlugin.java
@Intercepts({@Signature(
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  public Object intercept(Invocation invocation) throws Throwable {
    return invocation.proceed();
  }
  public Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }
  public void setProperties(Properties properties) {
  }
}

<!-- mybatis-config.xml -->
<plugins>
  <plugin interceptor="org.mybatis.example.ExamplePlugin">
    <property name="someProperty" value="100"/>
  </plugin>
</plugins>

上面的插件將會攔截在 Executor 實例中所有的 “update” 方法調(diào)用， 這里的 Executor 是負(fù)責(zé)執(zhí)行低層映射語句的內(nèi)部對象蠢挡。

配置環(huán)境（environment）

盡管可以配置多個環(huán)境弧岳，每個 SqlSessionFactory 實例只能選擇其一。每個數(shù)據(jù)庫對應(yīng)一個 SqlSessionFactory 實例
為了指定創(chuàng)建哪種環(huán)境业踏，只要將它作為可選的參數(shù)傳遞給 SqlSessionFactoryBuilder 即可〗眩可以接受環(huán)境配置的兩個方法簽名是：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

如果忽略了環(huán)境參數(shù)勤家，那么默認(rèn)環(huán)境將會被加載，如下所示：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, properties);

環(huán)境元素定義了如何配置環(huán)境變量

    <!--默認(rèn)的環(huán)境ID-->
    <environments default="development">
        <!--各環(huán)境元素自己的ID-->
        <environment id="development">
            <!--事務(wù)管理器的配置-->
            <transactionManager type="JDBC">
                <property name="..." value="..."/>
            </transactionManager>
            <!--數(shù)據(jù)源的配置-->
            <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>

事務(wù)管理器（transactionManager）

MyBatis中有兩種類型的事務(wù)管理器（type=”[JDBC|MANAGED]”）：

• JDBC – 這個配置就是直接使用了 JDBC 的提交和回滾設(shè)置柳恐，它依賴于從數(shù)據(jù)源得到的連接來管理事務(wù)作用域伐脖。
• MANAGED – 這個配置幾乎沒做什么。它從來不提交或回滾一個連接乐设，而是讓容器來管理事務(wù)的整個生命周期（比如 JEE 應(yīng)用服務(wù)器的上下文）讼庇。 默認(rèn)情況下它會關(guān)閉連接，然而一些容器并不希望這樣近尚，因此需要將 closeConnection 屬性設(shè)置為 false 來阻止它默認(rèn)的關(guān)閉行為蠕啄。例如:

<transactionManager type="MANAGED">
  <property name="closeConnection" value="false"/>
</transactionManager>

如果你正在使用 Spring + MyBatis，則沒有必要配置事務(wù)管理器戈锻， 因為 Spring 模塊會使用自帶的管理器來覆蓋前面的配置歼跟。

數(shù)據(jù)源（dataSource）

dataSource 元素使用標(biāo)準(zhǔn)的 JDBC 數(shù)據(jù)源接口來配置 JDBC 連接對象的資源。

• 許多 MyBatis 的應(yīng)用程序會按示例中的例子來配置數(shù)據(jù)源格遭。雖然這是可選的哈街，但為了使用延遲加載，數(shù)據(jù)源是必須配置的拒迅。

有三種內(nèi)建的數(shù)據(jù)源類型（也就type=”[UNPOOLED|POOLED|JNDI]”）：

UNPOOLED – 這個數(shù)據(jù)源的實現(xiàn)只是每次被請求時打開和關(guān)閉連接骚秦。雖然有點慢她倘，但對于在數(shù)據(jù)庫連接可用性方面沒有太高要求的簡單應(yīng)用程序來說，是一個很好的選擇作箍。 不同的數(shù)據(jù)庫在性能方面的表現(xiàn)也是不一樣的硬梁，對于某些數(shù)據(jù)庫來說，使用連接池并不重要蒙揣，這個配置就很適合這種情形靶溜。UNPOOLED 類型的數(shù)據(jù)源僅僅需要配置以下 5 種屬性：

• driver – 這是 JDBC 驅(qū)動的 Java 類的完全限定名（并不是 JDBC 驅(qū)動中可能包含的數(shù)據(jù)源類）。
• url – 這是數(shù)據(jù)庫的 JDBC URL 地址懒震。
• username – 登錄數(shù)據(jù)庫的用戶名罩息。
• password – 登錄數(shù)據(jù)庫的密碼。
• defaultTransactionIsolationLevel – 默認(rèn)的連接事務(wù)隔離級別个扰。
  作為可選項瓷炮，你也可以傳遞屬性給數(shù)據(jù)庫驅(qū)動。要這樣做递宅，屬性的前綴為“driver.”娘香，例如：
• driver.encoding=UTF8
  這將通過 DriverManager.getConnection(url,driverProperties) 方法傳遞值為 UTF8 的 encoding 屬性給數(shù)據(jù)庫驅(qū)動。

POOLED– 這種數(shù)據(jù)源的實現(xiàn)利用“池”的概念將 JDBC 連接對象組織起來办龄，避免了創(chuàng)建新的連接實例時所必需的初始化和認(rèn)證時間烘绽。 這是一種使得并發(fā) Web 應(yīng)用快速響應(yīng)請求的流行處理方式。

除了上述提到 UNPOOLED 下的屬性外俐填，還有更多屬性用來配置 POOLED 的數(shù)據(jù)源：

• poolMaximumActiveConnections – 在任意時間可以存在的活動（也就是正在使用）連接數(shù)量安接，默認(rèn)值：10
• poolMaximumIdleConnections – 任意時間可能存在的空閑連接數(shù)。
• poolMaximumCheckoutTime – 在被強制返回之前英融，池中連接被檢出（checked out）時間盏檐，默認(rèn)值：20000 毫秒（即 20 秒）
• poolTimeToWait – 這是一個底層設(shè)置，如果獲取連接花費了相當(dāng)長的時間驶悟，連接池會打印狀態(tài)日志并重新嘗試獲取一個連接（避免在誤配置的情況下一直安靜的失敽啊），默認(rèn)值：20000 毫秒（即 20 秒）痕鳍。
• poolMaximumLocalBadConnectionTolerance – 這是一個關(guān)于壞連接容忍度的底層設(shè)置硫豆， 作用于每一個嘗試從緩存池獲取連接的線程. 如果這個線程獲取到的是一個壞的連接，那么這個數(shù)據(jù)源允許這個線程嘗試重新獲取一個新的連接额获，但是這個重新嘗試的次數(shù)不應(yīng)該超過 poolMaximumIdleConnections 與 poolMaximumLocalBadConnectionTolerance 之和够庙。 默認(rèn)值：3 (新增于 3.4.5)
• poolPingQuery – 發(fā)送到數(shù)據(jù)庫的偵測查詢，用來檢驗連接是否正常工作并準(zhǔn)備接受請求抄邀。默認(rèn)是“NO PING QUERY SET”耘眨，這會導(dǎo)致多數(shù)數(shù)據(jù)庫驅(qū)動失敗時帶有一個恰當(dāng)?shù)腻e誤消息。
• poolPingEnabled – 是否啟用偵測查詢境肾。若開啟剔难，需要設(shè)置 poolPingQuery 屬性為一個可執(zhí)行的 SQL 語句（最好是一個速度非车ㄓ欤快的 SQL 語句），默認(rèn)值：false偶宫。
• poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的頻率非迹。可以被設(shè)置為和數(shù)據(jù)庫連接超時時間一樣纯趋，來避免不必要的偵測憎兽，默認(rèn)值：0（即所有連接每一時刻都被偵測 — 當(dāng)然僅當(dāng) poolPingEnabled 為 true 時適用）。

JNDI – 這個數(shù)據(jù)源的實現(xiàn)是為了能在如 EJB 或應(yīng)用服務(wù)器這類容器中使用吵冒，容器可以集中或在外部配置數(shù)據(jù)源纯命，然后放置一個 JNDI 上下文的引用。這種數(shù)據(jù)源配置只需要兩個屬性：

• initial_context – 這個屬性用來在 InitialContext 中尋找上下文（即痹栖，initialContext.lookup(initial_context)）亿汞。這是個可選屬性，如果忽略揪阿，那么 data_source 屬性將會直接從 InitialContext 中尋找疗我。
• data_source – 這是引用數(shù)據(jù)源實例位置的上下文的路徑。提供了 initial_context 配置時會在其返回的上下文中進(jìn)行查找南捂，沒有提供時則直接在 InitialContext 中查找吴裤。

和其他數(shù)據(jù)源配置類似，可以通過添加前綴“env.”直接把屬性傳遞給初始上下文溺健。比如：

• env.encoding=UTF8
  這就會在初始上下文（InitialContext）實例化時往它的構(gòu)造方法傳遞值為 UTF8 的 encoding 屬性嚼摩。

你可以通過實現(xiàn)接口 org.apache.ibatis.datasource.DataSourceFactory 來使用第三方數(shù)據(jù)源：

public interface DataSourceFactory {
  void setProperties(Properties props);
  DataSource getDataSource();
}

org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory可被用作父類來構(gòu)建新的數(shù)據(jù)源適配器，比如下面這段插入 C3P0 數(shù)據(jù)源所必需的代碼：

import org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory;
import com.mchange.v2.c3p0.ComboPooledDataSource;
        
public class C3P0DataSourceFactory extends UnpooledDataSourceFactory {

  public C3P0DataSourceFactory() {
    this.dataSource = new ComboPooledDataSource();
  }
}

為了令其工作矿瘦，記得為每個希望 MyBatis 調(diào)用的 setter 方法在配置文件中增加對應(yīng)的屬性。下面是一個可以連接至 PostgreSQL 數(shù)據(jù)庫的例子：

<dataSource type="org.myproject.C3P0DataSourceFactory">
  <property name="driver" value="org.postgresql.Driver"/>
  <property name="url" value="jdbc:postgresql:mydb"/>
  <property name="username" value="postgres"/>
  <property name="password" value="root"/>
</dataSource>

databaseIdProvider

MyBatis 可以根據(jù)不同的數(shù)據(jù)庫廠商執(zhí)行不同的語句愿卒，這種多廠商的支持是基于映射語句中的 databaseId 屬性缚去。 MyBatis 會加載不帶databaseId 屬性和帶有匹配當(dāng)前數(shù)據(jù)庫 databaseId 屬性的所有語句。 如果同時找到帶有 databaseId 和不帶 databaseId 的相同語句琼开，則后者會被舍棄易结。 為支持多廠商特性只要像下面這樣在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

<databaseIdProvider type="DB_VENDOR" />

這里的 DB_VENDOR 會通過DatabaseMetaData#getDatabaseProductName()返回的字符串進(jìn)行設(shè)置。 由于通常情況下這個字符串都非常長而且相同產(chǎn)品的不同版本會返回不同的值柜候，所以最好通過設(shè)置屬性別名來使其變短搞动，如下：

<databaseIdProvider type="DB_VENDOR">
  <property name="SQL Server" value="sqlserver"/>
  <property name="DB2" value="db2"/>        
  <property name="Oracle" value="oracle" />
</databaseIdProvider>

在提供了屬性別名時，DB_VENDOR databaseIdProvider 將被設(shè)置為第一個能匹配數(shù)據(jù)庫產(chǎn)品名稱的屬性鍵對應(yīng)的值渣刷，如果沒有匹配的屬性將會設(shè)置為 “null”鹦肿。 在這個例子中，如果 getDatabaseProductName() 返回“Oracle (DataDirect)”辅柴，databaseId 將被設(shè)置為“oracle”箩溃。

你可以通過實現(xiàn)接口 org.apache.ibatis.mapping.DatabaseIdProvider 并在 mybatis-config.xml 中注冊來構(gòu)建自己的 DatabaseIdProvider：

public interface DatabaseIdProvider {
  void setProperties(Properties p);
  String getDatabaseId(DataSource dataSource) throws SQLException;
}

映射器（mappers）

既然 MyBatis 的行為已經(jīng)由上述元素配置完了瞭吃，我們現(xiàn)在就要定義 SQL 映射語句了。但是首先我們需要告訴 MyBatis 到哪里去找到這些語句涣旨。 Java 在自動查找這方面沒有提供一個很好的方法歪架，所以最佳的方式是告訴 MyBatis 到哪里去找映射文件。你可以使用相對于類路徑的資源引用霹陡， 或完全限定資源定位符（包括 file:/// 的 URL）和蚪，或類名和包名等。例如：

<!-- 使用相對于類路徑的資源引用 -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

<!-- 使用完全限定資源定位符（URL） -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

<!-- 使用映射器接口實現(xiàn)類的完全限定類名 -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

<!-- 將包內(nèi)的映射器接口實現(xiàn)全部注冊為映射器 -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

這些配置會告訴了 MyBatis 去哪里找映射文件烹棉。