筆記：MyBatis XML配置詳解_ZenDei技術網路在線

MyBatis 的配置文件包含了影響 MyBatis 行為甚深的設置（settings）和屬性（properties）信息。文檔的頂層結構如下： configuration 配置 properties 屬性 settings 設置 typeAliases 類型命名 typeHandlers 類型處理... ...

MyBatis 的配置文件包含了影響 MyBatis 行為甚深的設置（settings）和屬性（properties）信息。文檔的頂層結構如下：

configuration 配置
- properties 屬性
- settings 設置
- typeAliases 類型命名
- typeHandlers 類型處理器
- objectFactory 對象工廠
- plugins 插件
- environments 環境
  - environment 環境變數
    - transactionManager 事務管理器
    - dataSource 數據源
- databaseIdProvider 資料庫廠商標識
- mappers 映射器

properties 屬性
這些屬性都是可外部配置且可動態替換的，既可以在典型的 Java 屬性文件中配置，亦可通過 properties 元素的子元素來傳遞，配置示例：

<properties resource="org/mybatis/example/config.properties">
    <property name="username" value="dev_user"/>
    <property name="password" value="F2Fa3!33TYyg"/>
</properties>
配置 properties 後，可以在其他配置中使用 property，示例如下：
<dataSource type="POOLED">
    <property name="driver" value="${driver}"/>
    <property name="url" value="${url}"/>
    <property name="username" value="${username}"/>
    <property name="password" value="${password}"/>
</dataSource>
這個例子中的 username 和 password 將會由 properties 元素中設置的相應值來替換。
如果屬性在不只一個地方進行了配置，那麼 MyBatis 將按照下麵的順序來載入：

在 properties 元素體內指定的屬性首先被讀取。
然後根據 properties 元素中的 resource 屬性讀取類路徑下屬性文件或根據 url 屬性指定的路徑讀取屬性文件，並覆蓋已讀取的同名屬性。
最後讀取作為方法參數傳遞的屬性，並覆蓋已讀取的同名屬性。

因此，通過方法參數傳遞的屬性具有最高優先順序，resource/url 屬性中指定的配置文件次之，最低優先順序的是 properties 屬性中指定的屬性

MyBatis 3.4.2 增加了預設值，可以通過 ${username:ut_user} 來設置預設值，可以通過配置 property 來啟用預設值，或者設置預設值的分隔符，如下配置：

settings 屬性
這是 MyBatis 中極為重要的調整設置，它們會改變 MyBatis 的運行時行為，完整屬性及說明表可以參考鏈接。一個配置完整的示例如下：
<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="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 類型設置一個短的名字。它只和 XML 配置有關，存在的意義僅在於用來減少類完全限定名的冗餘。指定別名配置如下：
<typeAliases>
    <typeAlias alias="Author" type="domain.blog.Author"/>
    <typeAlias alias="Blog" type="domain.blog.Blog"/>
    <typeAlias alias="Comment" type="domain.blog.Comment"/>
    <typeAlias alias="Post" type="domain.blog.Post"/>
    <typeAlias alias="Section" type="domain.blog.Section"/>
    <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>
也可以指定一個包名，MyBatis 會搜索包名下麵的需要的 Java Bean ，比如：
<typeAliases>
    <package name="domain.blog"/>
</typeAliases>
每一個在包 domain.blog 中的 Java Bean，在沒有註解的情況下，會使用 Bean 的首字母小寫的非限定類名來作為它的別名。比如 domain.blog.Author 的別名為 author；若有註解，則別名為其註解值。看下麵的例子：
@Alias("author")
public class Author {
    ...
}
已經為許多常見的 Java 類型內建了相應的類型別名。它們都是大小寫不敏感的，需要註意的是由基本類型名稱重覆導致的特殊處理，內建相應的類型表參見鏈接。
typeHandlers 屬性
無論是 MyBatis 在預處理語句（PreparedStatement）中設置一個參數時，還是從結果集中取出一個值時，都會用類型處理器將獲取的值以合適的方式轉換成 Java 類型，預設的類型處理器參考鏈接。可以重寫類型處理器或創建自己的類型處理器來處理不支持的或非標準的類型。具體做法為：實現 org.apache.ibatis.type.TypeHandler 介面，或繼承一個很便利的類 org.apache.ibatis.type.BaseTypeHandler，然後可以選擇性地將它映射到一個 JDBC 類型，示例代碼：

自定義TypeHandler 代碼
package org.mybatisExamples.simple;

import java.sql.*;

import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
// 繼承基類重寫方法，通過類型處理器的泛型，MyBatis 可以得知該類型處理器處理的 Java 類型
public class StringTypeHandler extends BaseTypeHandler<String> {

    @Override
    public String getNullableResult(ResultSet arg0, String arg1) throws SQLException {
        System.out.printf("getNullableResult arg1=%s%n", arg1);
        return arg0.getString(arg1);
    }

    @Override
    public String getNullableResult(ResultSet arg0, int arg1) throws SQLException {
        System.out.printf("getNullableResult arg1=%d%n", arg1);
        return arg0.getString(arg1);
    }

    @Override
    public String getNullableResult(CallableStatement arg0, int arg1) throws SQLException {
        System.out.printf("getNullableResult arg1=%d%n", arg1);
        return arg0.getString(arg1);
    }

    @Override
    public void setNonNullParameter(PreparedStatement arg0, int arg1, String arg2, JdbcType arg3) throws SQLException {
        System.out.printf("Index=%d Value=%s JdbcType=%s%n", arg1, arg2, arg3);
        arg0.setString(arg1, arg2);
    }
}
配置文件代碼：
<typeHandlers>
<typeHandler handler="org.mybatisExamples.simple.StringTypeHandler"/>
</typeHandlers>

通過類型處理器的泛型，MyBatis 可以得知該類型處理器處理的 Java 類型，不過這種行為可以通過兩種方法改變：

在類型處理器的配置元素（typeHandler element）上增加一個 javaType 屬性（比如：javaType="String"）；
在類型處理器的類上（TypeHandler class）增加一個 @MappedTypes 註解來指定與其關聯的 Java 類型列表。如果在 javaType 屬性中也同時指定，則註解方式將被忽略。

可以通過兩種方式來指定被關聯的 JDBC 類型：

在類型處理器的配置元素上增加一個 jdbcType 屬性（比如：jdbcType="VARCHAR"）；
在類型處理器的類上（TypeHandler class）增加一個 @MappedJdbcTypes 註解來指定與其關聯的 JDBC 類型列表。如果在 jdbcType 屬性中也同時指定，則註解方式將被忽略。

當決定在 <ResultMap…/> 中使用某一TypeHandler時，此時java類型是已知的（從結果類型中獲得），但是JDBC類型是未知的。因此Mybatis使用javaType=[TheJavaType], jdbcType=null的組合來選擇一個TypeHandler。這意味著使用@MappedJdbcTypes註解可以限制TypeHandler的範圍，同時除非顯示的設置，否則TypeHandler在ResultMap中將是無效的。如果希望在ResultMap中使用TypeHandler，那麼設置@MappedJdbcTypes註解的includeNullJdbcType=true即可。然而從Mybatis 3.4.0開始，如果只有一個註冊的TypeHandler來處理Java類型，那麼它將是ResultMap使用Java類型時的預設值（即使沒有includeNullJdbcType=true）。

typeHandlers 屬性處理枚舉類型
若想映射枚舉類型 Enum，則需要從 org.apache.ibatis.type.EnumTypeHandler 或者 org.apache.ibatis.type.EnumOrdinalTypeHandler 中選一個來使用。比如說我們想存儲取近似值時用到的舍入模式。預設情況下，MyBatis 會利用 EnumTypeHandler 來把 Enum 值轉換成對應的名字。
註意 EnumTypeHandler 在某種意義上來說是比較特別的，其他的處理器只針對某個特定的類，而它不同，它會處理任意繼承了 Enum 的類。
不過，我們可能不想存儲名字，相反我們的 DBA 會堅持使用整形值代碼。那也一樣輕而易舉：在配置文件中把 EnumOrdinalTypeHandler 加到 typeHandlers 中即可，這樣每個 RoundingMode 將通過他們的序數值來映射成對應的整形，配置示例：
<typeHandlers>
<typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="java.math.RoundingMode"/>
</typeHandlers>
自動映射器（auto-mapper）會自動地選用 EnumOrdinalTypeHandler 來處理，所以如果我們想用普通的 EnumTypeHandler，就非要為那些 SQL 語句顯式地設置要用到的類型處理器不可。
objectFactory（對象工廠）
MyBatis 每次創建結果對象的新實例時，它都會使用一個對象工廠（ObjectFactory）實例來完成。預設的對象工廠需要做的僅僅是實例化目標類，要麼通過預設構造方法，要麼在參數映射存在的時候通過參數構造方法來實例化。如果想覆蓋對象工廠的預設行為，則可以通過創建自己的對象工廠來實現，示例代碼：
package org.mybatisExamples.simple;

import java.util.List;
import java.util.Properties;

import org.apache.ibatis.reflection.factory.DefaultObjectFactory;

@SuppressWarnings("serial")
public class ExampleObjectFactory extends DefaultObjectFactory {
    @Override
    public <T> T create(Class<T> type) {
        System.out.println("create is type=" + type.getName());
        return super.create(type);
    }

    @Override
    public <T> T create(Class<T> type, List<Class<?>> constructorArgTypes, List<Object> constructorArgs) {
        System.out.println("create is type=" + type.getName());
        return super.create(type, constructorArgTypes, constructorArgs);
    }

    @Override
    public void setProperties(Properties properties) {
        System.out.println("setProperties is properties=" + properties.toString());
        super.setProperties(properties);
    }
}
配置文件：
<objectFactory type=" org.mybatisExamples.simple.ExampleObjectFactory ">
    <property name="someProperty" value="100"/>
</objectFactory>
插件（plugins）
MyBatis 允許你在已映射語句執行過程中的某一點進行攔截調用。預設情況下，MyBatis 允許使用插件來攔截的方法調用包括：

Executor 介面的方法 update, query, flushStatements, commit, rollback, getTransaction, close, isClosed
ParameterHandler 介面的方法 getParameterObject, setParameters
ResultSetHandler 介面的方法 handleResultSets, handleOutputParameters
StatementHandler 介面的方法 prepare, parameterize, batch, update, query

這些類中方法的細節可以通過查看每個方法的簽名來發現，或者直接查看 MyBatis 的發行包中的源代碼。假設你想做的不僅僅是監控方法的調用，那麼你應該很好的瞭解正在重寫的方法的行為。因為如果在試圖修改或重寫已有方法的行為的時候，你很可能在破壞 MyBatis 的核心模塊。這些都是更低層的類和方法，所以使用插件的時候要特別當心。通過 MyBatis 提供的強大機制，使用插件是非常簡單的，只需實現 Interceptor 介面，並指定了想要攔截的方法簽名即可，示例代碼：

@Intercepts({@Signature(

// type：表示需要攔截的上面列出的介面

type= Executor.class,

// method：表示攔截介面的方法

method = "update",

// args：表示攔截方法的參數

args = {MappedStatement.class,Object.class})})

public class ExamplePlugin implements Interceptor {

// 執行攔截對象的方法 invocation.proceed 表示執行原始方法

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

}

配置文件：

</plugin>

</plugins>

配置環境（environments）
MyBatis 可以配置成適應多種環境，這種機制有助於將 SQL 映射應用於多種資料庫之中，現實情況下有多種理由需要這麼做。例如，開發、測試和生產環境需要有不同的配置；或者共用相同 Schema 的多個生產資料庫，想使用相同的 SQL 映射。許多類似的用例。
不過要記住：儘管可以配置多個環境，每個 SqlSessionFactory 實例只能選擇其一。
所以，如果你想連接兩個資料庫，就需要創建兩個 SqlSessionFactory 實例，每個資料庫對應一個。而如果是三個資料庫，就需要三個實例，依此類推，記起來很簡單：

每個資料庫對應一個 SqlSessionFactory 實例

為了指定創建哪種環境，只要將它作為可選的參數傳遞給 SqlSessionFactoryBuilder 即可。可以接受環境配置的兩個方法簽名是：

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

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

如果忽略了環境參數，那麼預設環境將會被載入，如下所示：

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

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

環境元素定義瞭如何配置環境，配置示例如下：

</transactionManager>

</dataSource>

</environment>

</environments>

註意這裡的關鍵點:

預設的環境 ID（比如:default="development"）。
每個 environment 元素定義的環境 ID（比如:id="development"）。
事務管理器的配置（比如:type="JDBC"）。
數據源的配置（比如:type="POOLED"）。

預設的環境和環境 ID 是一目瞭然的。隨你怎麼命名，只要保證預設環境要匹配其中一個環境ID

事務管理器（transactionManager）
在 MyBatis 中有兩種類型的事務管理器（也就是 type="[JDBC|MANAGED]"）：

JDBC – 這個配置就是直接使用了 JDBC 的提交和回滾設置，它依賴於從數據源得到的連接來管理事務作用域。
MANAGED – 這個配置幾乎沒做什麼。它從來不提交或回滾一個連接，而是讓容器來管理事務的整個生命周期（比如 JEE 應用伺服器的上下文）。預設情況下它會關閉連接，然而一些容器並不希望這樣，因此需要將 closeConnection 屬性設置為 false 來阻止它預設的關閉行為。例如:
<transactionManager type="MANAGED">
<property name="closeConnection" value="false"/>