Java數據持久層框架 MyBatis之API學習四（xml配置文件詳解）

摘錄網址： http://blog.csdn.net/u010107350/article/details/51292500

 

對於MyBatis的學習而言，最好去MyBatis的官方文檔：http://www.mybatis.org/mybatis-3/zh/index.html

對於語言的學習而言，馬上上手去編程，多多練習是最好的辦法。J

 

一、MyBatis 配置文件基本結構

       在使用mybatis框架時，首先導入其對應的jar包，並進行相應的配置，所以得對配置文件的每個參數都得了解。一個完全的mybatis配置文件結構如下：

<?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></properties>
    <!-- 設置：定義mybatis的一些全局性設置 -->
    <settings>
       <!-- 具體的參數名和參數值 -->
       <setting name="" value=""/>
    </settings>
    <!-- 類型名稱：為一些類定義別名 -->
    <typeAliases></typeAliases>
    <!-- 類型處理器：定義Java類型與數據庫中的數據類型之間的轉換關系 -->
    <typeHandlers></typeHandlers>
    <!-- 對象工廠 -->
    <objectFactory type=""></objectFactory>
    <!-- 插件：mybatis的插件,插件可以修改mybatis的內部運行規則 -->
    <plugins>
       <plugin interceptor=""></plugin>
    </plugins>
    <!-- 環境：配置mybatis的環境 -->
    <environments default="">
       <!-- 環境變量：可以配置多個環境變量，比如使用多數據源時，就需要配置多個環境變量 -->
       <environment id="">
          <!-- 事務管理器 -->
          <transactionManager type=""></transactionManager>
          <!-- 數據源 -->
          <dataSource type=""></dataSource>
       </environment>
    </environments>
    <!-- 數據庫廠商標識 -->
    <databaseIdProvider type=""></databaseIdProvider>
    <!-- 映射器：指定映射文件或者映射類 -->
    <mappers></mappers>
</configuration>

 

properties

 

properties元素主要是用來定義配置外在化，比如數據庫的連接屬性等。這些屬性都是可外部配置且可動態替換的，既可以在典型的Java屬性文件中配置，亦可以通過properties元素的子元素來傳遞。例如：

 

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

其中的屬性就可以在整個配置文件中使用來替換需要動態配置的屬性值。比如在數據源中使用的例子：

 

 

<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元素中設置的相應值來替換。driver和url屬性將會由config.properties文件中對應的值來替換。這樣就為配置提供了諸多靈活選擇。屬性也可以被傳遞到SqlSessionBuilder.build()方法中。例如：

 

 

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, props);


// ... or ...


SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, environment, props);

但是，這也就涉及到了優先級的問題，如果屬性不只在一個地方配置，那么mybatis將會按照下面的順序來加載：

 

 

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

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

 settings

setting是指定MyBatis的一些全局配置屬性，這是MyBatis中極為重要的調整設置，它們會改變MyBatis的運行時行為，所以我們需要清楚的知道這些屬性的作用及默認值。

設置參數	描述	有效值	默認值
cacheEnabled	該配置影響的所有映射器中配置的緩存的全局開關	true | false	true
lazyLoadingEnabled	延遲加載的全局開關。當開啟時，所有關聯對象都會延遲加載。 特定關聯關系中可通過設置fetchType屬性來覆蓋該項的開關狀態	true | false	false
aggressiveLazyLoading	當啟用時，對任意延遲屬性的調用會使帶有延遲加載屬性的對象完整加載；反之，每種屬性將會按需加載。	true | false	true
multipleResultSetsEnabled	是否允許單一語句返回多結果集（需要兼容驅動）。	true | false	true
useColumnLabel	使用列標簽代替列名。不同的驅動在這方面會有不同的表現， 具體可參考相關驅動文檔或通過測試這兩種不同的模式來觀察所用驅動的結果。	true | false	true
useGeneratedKeys	允許 JDBC 支持自動生成主鍵，需要驅動兼容。 如果設置為 true 則這個設置強制使用自動生成主鍵，盡管一些驅動不能兼容但仍可正常工作（比如 Derby）。	true | false	False
autoMappingBehavior	指定 MyBatis 應如何自動映射列到字段或屬性。 NONE 表示取消自動映射；PARTIAL 只會自動映射沒有定義嵌套結果集映射的結果集。 FULL 會自動映射任意復雜的結果集（無論是否嵌套）。	NONE, PARTIAL, FULL	PARTIAL
defaultExecutorType	配置默認的執行器。SIMPLE 就是普通的執行器；REUSE 執行器會重用預處理語句（prepared statements）； BATCH 執行器將重用語句並執行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	設置超時時間，它決定驅動等待數據庫響應的秒數。	Any positive integer	Not Set (null)
defaultFetchSize	Sets the driver a hint as to control fetching size for return results. This parameter value can be override by a query setting.	Any positive integer	Not Set (null)
safeRowBoundsEnabled	允許在嵌套語句中使用分頁（RowBounds）。	true | false	False
mapUnderscoreToCamelCase	是否開啟自動駝峰命名規則（camel case）映射，即從經典數據庫列名 A_COLUMN 到經典 Java 屬性名 aColumn 的類似映射。	true | false	False
localCacheScope	MyBatis 利用本地緩存機制（Local Cache）防止循環引用（circular references）和加速重復嵌套查詢。 默認值為 SESSION，這種情況下會緩存一個會話中執行的所有查詢。 若設置值為 STATEMENT，本地會話僅用在語句執行上，對相同 SqlSession 的不同調用將不會共享數據。	SESSION | STATEMENT	SESSION
jdbcTypeForNull	當沒有為參數提供特定的 JDBC 類型時，為空值指定 JDBC 類型。 某些驅動需要指定列的 JDBC 類型，多數情況直接用一般類型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType enumeration. Most common are: NULL, VARCHAR and OTHER	OTHER
lazyLoadTriggerMethods	指定哪個對象的方法觸發一次延遲加載。	A method name list separated by commas	equals,clone,hashCode,toString
defaultScriptingLanguage	指定動態 SQL 生成的默認語言。	A type alias or fully qualified class name.	org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver
callSettersOnNulls	指定當結果集中值為 null 的時候是否調用映射對象的 setter（map 對象時為 put）方法，這對於有 Map.keySet() 依賴或 null 值初始化的時候是有用的。注意基本類型（int、boolean等）是不能設置成 null 的。	true | false	false
logPrefix	指定 MyBatis 增加到日志名稱的前綴。	Any String	Not set
logImpl	指定 MyBatis 所用日志的具體實現，未指定時將自動查找。	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	Not set
proxyFactory	指定 Mybatis 創建具有延遲加載能力的對象所用到的代理工具。	CGLIB | JAVASSIST	JAVASSIST (MyBatis 3.3 or above)

 

一個完整的settings元素示例如下：

 

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

當這樣配置時，Blog可以用在任何使用domain.blog.Blog的地方。

 

也可以指定一個包名，MyBatis會在包名下搜索需要的JavaBean，比如：

 

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

每一個在包domain.blog中的JavaBean，在沒有注解的情況下，會使用Bean的首字母小寫的非限類名來作為它的別名。比如domain.blog.Author的別名為author；若有注解，則別名為注解值。看下面的例子：

 

 

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

已經為許多常見的Java類型內建了相應的類型別名。它們都是大小寫不敏感的，需要注意的是有基本類型名稱重復導致的特殊處理。

別名	映射的類型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

 

typeHandlers

無論是 MyBatis 在預處理語句（PreparedStatement）中設置一個參數時，還是從結果集中取出一個值時， 都會用類型處理器將獲取的值以合適的方式轉換成 Java 類型。下表描述了一些默認的類型處理器。

類型處理器	Java 類型	JDBC 類型
BooleanTypeHandler	java.lang.Boolean, boolean	數據庫兼容的 BOOLEAN
ByteTypeHandler	java.lang.Byte, byte	數據庫兼容的 NUMERIC 或 BYTE
ShortTypeHandler	java.lang.Short, short	數據庫兼容的 NUMERIC 或 SHORT INTEGER
IntegerTypeHandler	java.lang.Integer, int	數據庫兼容的 NUMERIC 或 INTEGER
LongTypeHandler	java.lang.Long, long	數據庫兼容的 NUMERIC 或 LONG INTEGER
FloatTypeHandler	java.lang.Float, float	數據庫兼容的 NUMERIC 或 FLOAT
DoubleTypeHandler	java.lang.Double, double	數據庫兼容的 NUMERIC 或 DOUBLE
BigDecimalTypeHandler	java.math.BigDecimal	數據庫兼容的 NUMERIC 或 DECIMAL
StringTypeHandler	java.lang.String	CHAR, VARCHAR
ClobTypeHandler	java.lang.String	CLOB, LONGVARCHAR
NStringTypeHandler	java.lang.String	NVARCHAR, NCHAR
NClobTypeHandler	java.lang.String	NCLOB
ByteArrayTypeHandler	byte[]	數據庫兼容的字節流類型
BlobTypeHandler	byte[]	BLOB, LONGVARBINARY
DateTypeHandler	java.util.Date	TIMESTAMP
DateOnlyTypeHandler	java.util.Date	DATE
TimeOnlyTypeHandler	java.util.Date	TIME
SqlTimestampTypeHandler	java.sql.Timestamp	TIMESTAMP
SqlDateTypeHandler	java.sql.Date	DATE
SqlTimeTypeHandler	java.sql.Time	TIME
ObjectTypeHandler	Any	OTHER 或未指定類型
EnumTypeHandler	Enumeration Type	VARCHAR-任何兼容的字符串類型，存儲枚舉的名稱（而不是索引）
EnumOrdinalTypeHandler	Enumeration Type	任何兼容的 NUMERIC 或 DOUBLE 類型，存儲枚舉的索引（而不是名稱）。

 

可以重寫類型處理器或創建自己的類型處理器來處理不支持的或非標准的類型。具體的做法為：實現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>

使用這個的類型處理器將會覆蓋已經存在的處理Java的String類型屬性和VARCHAR參數及結果的類型處理器。要注意MyBatis不會窺探數據庫元信息來決定使用哪種類型，所以必須在參數和結果映射中指明是VARCHAR類型字段，以使其能綁定到正確的類型處理器上。這是因為，MyBatis直到語句被執行才清楚數據類型。
通過類型處理器的泛型，MyBatis可以得知該類型處理器的Java類型，不過這種行為可以通過兩種方法改變：

 

 

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

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

 

 

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

最后，還可以讓MyBatis查找類型處理器：

 

 

<!-- mybatis-config.xml -->
<typeHandlers>
  <package name="org.mybatis.example"/>
</typeHandlers>

注意在使用自動檢索（autodiscovery）功能的時候，只能通過注解的方式來指定JDBC類型。

 

你能創建一個泛型類型處理器，它可以處理多於一個類。為達到此目的，需要增加一個接收該類作為參數的構造器，這樣在構造一個類型處理器的時候MyBatis就會傳入一個具體的類。

 

//GenericTypeHandler.java public class GenericTypeHandler<E extends MyObject> extends BaseTypeHandler<E>

  { private Class<E>

  type; public GenericTypeHandler(Class<E> type){
    if (type == null) throw new IllegalArgumentException("Type argument cannot be null");
    this.type =
  type;}
  ...

EnumTypeHandler和EnumOrdinalTypeHandler都是泛型處理器（generic TypeHandlers），接下來的部分詳細探討。

 

處理枚舉類型

 

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

比如說我們想存儲近似值時用到的舍入模式。默認情況下，MyBatis會利用EnumTypeHandler來把Enum值轉換成對應的名字。

注意EnumTypeHandler在某種意義上來說是比較特別的，其他的處理器只針對某個特定的類，而它不同，它會處理任意繼承了Enum的類。

不過，我們可能不想存儲名字，相反我們的DBA會堅持使用整形值代碼。那也一樣輕而易舉；在配置文件中把EnumOrdinalTypeHandler加到typeHandlers中即可，這樣每個RoundingMode將通過他們的序數值來映射成對應的整形。

 

<!-- mybatis-config.xml -->
<typeHandlers>
  <typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="java.math.RoundingMode"/>
</typeHandlers>

但是怎么樣能將同樣的Enum既映射成字符串又映射成整形呢？

 

自動映射器（auto-mapper）會自動選用EnumOrdinalTypeHandler來處理，所以如果我們想用普通的EnumTypeHandler，就非要為那些SQL語句顯示地設置要用到的類型處理器不可。

 

<!DOCTYPE mapper
    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">


<mapper namespace="org.apache.ibatis.submitted.rounding.Mapper">
    <resultMap type="org.apache.ibatis.submitted.rounding.User" id="usermap">
        <id column="id" property="id"/>
        <result column="name" property="name"/>
        <result column="funkyNumber" property="funkyNumber"/>
        <result column="roundingMode" property="roundingMode"/>
    </resultMap>


    <select id="getUser" resultMap="usermap">
        select * from users
    </select>
    <insert id=
        "insert"> insert into users (id, name, funkyNumber, roundingMode) values
            ( #{id}, #{name}, #{funkyNumber},
        #{roundingMode})
    </insert>

    <resultMap type="org.apache.ibatis.submitted.rounding.User" id="usermap2">
        <id column="id" property="id"/>
        <result column="name" property="name"/>
        <result column="funkyNumber" property="funkyNumber"/>
        <result column="roundingMode" property="roundingMode" typeHandler="org.apache.ibatis.type.EnumTypeHandler"/>
    </resultMap>
    <select id="getUser2" resultMap="usermap2">
        select * from users2
    </select>
    <insert id=
        "insert2"> insert into users2 (id, name, funkyNumber, roundingMode) values(
            #{id}, #{name}, #{funkyNumber}, #{roundingMode, typeHandler=
        org.apache.ibatis.type.EnumTypeHandler})
    </insert>


</mapper>

注意，這里的select語句強制使用resultMap來代替resultType。

 

對象工廠（objectFactory）

MyBatis每次創建結果對象的新實例時，它都會使用一個對象工廠（ObjectFactory）實例來完成。默認的對象工廠需要做的僅僅是實例化目標類，要么通過默認構造方法，要么在參數映射存在的時候通過參數構造方法來實例化。如果想覆蓋對象工廠的行為，則可以通過創建自己的對象工廠來實現，比如：

 

 

//
xampleObjectFactory.java public class ExampleObjectFactory extends DefaultObjectFactory
 { public Object create(Class type)
   { return
 super.create(type);
 } public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs)
   { return super.create(type, constructorArgTypes,
 constructorArgs);
 } public void setProperties(Properties properties)
   {
 super.setProperties(properties);
 } public <T> boolean isCollection(Class<T> type){
   return Collection.class.isAssignableFrom(type);
 }}

<!-- mybatis-config.xml -->
<objectFactory type="org.mybatis.example.ExampleObjectFactory">
  <property name="someProperty" value="100"/>
</objectFactory>

ObjectFactory接口很簡單，它包含兩個創建用的方法，一個是處理默認構造方法的，另外一個是處理帶參數的構造方法。最后setProperties方法可以被用來配置ObjectFactory,初始化你的ObjectFactory實例后，objectFactory元素體內定義的屬性會被傳遞給setProperties方法。

 

 

插件（plugins）

MyBatis允許你在已映射的語句執行過程中的某一點進行攔截調用。默認情況下，Mybatis允許使用插件來攔截的方法調用包括：

 

 

• Executor(update,query,flushStatements,commit,rollback,getTransaction,close,isClosed)
• ParameterHandler(getParameterObejct,setParameters)
• ResultSetHandler(handlerResultSets,handlerOutputParameters)
• StatementHandler(prepare,parameterize,batch,update,query)

這些類中方法的細節可以通過查看每個方法的簽名來發現，或者直接查看MyBatis的發行包中的源代碼。假設你想做的不僅僅是方法的調用，那么你應該很好的了解正在重寫的方法的行為。因為如果在視圖修改或重寫已有方法的行為的時候，你很有可能在破壞MyBatis的核心模塊。這些都是更低層的類和方法，所以使用插件的時候要特別擔心。

 

通過MyBatis提供強大的機制，使用插件是非常簡單的，只需要實現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”方法調用，這里的Executor是負責執行底層映射語句的內部對象。
覆蓋配置類

 

除了用插件來修改MyBatis核心行為之外，還可以通過完全覆蓋配置類來達到目的。只需繼承后覆蓋其中的每個方法，再把它傳遞到sqlSessionFactoryBuilder.build(myConfig)方法即可。再次重申，這可能會嚴重影響Mybatis的行為，務請慎之又慎！

配置環境（environments）

MyBatis可以配置成適應多種環境，這種機制有助於將sql映射應用於多種數據庫中，現實情況下有多種理由需要這么做。例如，開發、測試和生產環境需要有不同的配置；或者共享相同的Schema的多個生產數據庫，想使用相同的sql映射。許多類似的用例。
盡管可以配置多個環境，但是每個SqlSessionFactory實例只能選擇其一。
所以，如果想連接兩個數據庫，就需要創建兩個SqlSessionFactory實例，每個數據庫對應一個。而如果是三個數據庫，就需要三個實例，依此類推。

 

每個數據庫對應一個SqlSessionFactory實例

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

 

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

如果忽略了環境參數，那么默認環境將會被加載，如下所示：

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader);
SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader,properties);

環境元素定義了如何配置環境

 

 

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

注意這里的關鍵點：

 

 

• 默認環境的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"/>
</transactionManager>

如果正在使用Spring+MyBatis，則沒有必要配置事務管理器，因為Spring模塊會使用自帶的管理器來覆蓋前面的配置。
這兩種事務管理器類型都不需要任何屬性。它們只不過是類型別名，換句話說，你可以使用TransactionFactory接口的實現類的完全限定名或類型別名替代它們。

 

 

public interface TransactionFactory{
  void setProperties(Properties props);
  Transaction newTransaction(Connection conn);
  Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit);
}

任何在xml中配置的屬性在實例化之后將會被傳遞給setProperties方法。你也需要創建一個Transaction接口的實現類，這個接口也很簡單。

 

 

public interface Transaction{
 Connection getConnection() throws SQLException;
 void commit() throws SQLException;
 void rollback() throws SQLException;
 void close() throws SQLException;

使用這兩個接口，完全可以自定義MyBatis對事務的處理。
數據源（dataSource）
dataSource元素使用了標准的JDBC數據源接口來配置JDBC連接對象的資源。

 

 

• 許多MyBatis的應用程序將會按示例中的例子來配置數據源。然而它並不是必須的。要知道為了方便使用延遲加載，數據源才是必須的。

有三種內建的數據源類型（也就是 type="[]UNPOOLED|POOLED|JNDI]"）；

 

UNPOOLED --- 這個數據源的實現只是被請求時打開和關閉連接。雖然有一點慢，它對在及時可用連接方面沒有性能要求的簡單應用是一個很好的選擇。不同的數據庫在這方面表現也是不一樣的，所以對某些數據庫來說使用連接池並不重要，這個配置也是理想。UNPOOLED類型的數據源僅僅需要配置以下5種屬性：

 

• driver  -- 這是JDBC驅動的Java類的完全限定名（並不是JDBC驅動中可能包含的數據源類）
• url -- 這是數據庫的JDBC URL 地址。
• username -- 登錄數據庫的用戶名。
• password -- 登錄數據庫的密碼。
• defaultTransactionIsolationLevel -- 默認的連接事務隔離級別。

作為可選項，可以傳遞屬性給數據庫驅動。要這樣做，屬性的前綴為"driver."，例如：

 

 

• driver.encoding=UTF-8

這將通過DriverManager,getConnection(url,driverProperties)方法傳遞值為UTF-8的encoding屬性給數據庫驅動。

POOLED --- 這種數據源的實現利用“池”的概念將JDBC連接對象組織起來，避免了創建新的連接實例時所必需的初始化和認證時間。這是一種使得並發web應用快速響應請求的流行處理方式。

除了上述提到UNPOOLED下的屬性外，會有更多屬性用來配置POOLED的數據源：

 

• poolMaximumActiveConnections  -- 在任意時間可以存在的活動（也就是正在使用）連接數量，默認值10
• poolMaximumIdleConnections  -- 任意時間可能存在的空閑連接數。
• poolMaximumCheckoutTime  -- 在被強制返回之前，池中連接被檢出（checked out）時間，默認值：20000毫秒（即20秒）
• poolTimeToWait  -- 這是一個底層設置，如果獲取連接花費的相當長的時間，它會給連接池打印狀態日志並重新嘗試獲取一個連接（避免在誤配置的情況下一直安靜的失敗），默認值20000毫秒（即20秒）。
• poolPingQuery  -- 發送到數據庫的偵測查詢，用來檢驗連接是否處在正常的工作秩序中，並且准備接受請求。默認是"NOT PING QUERY SET"，這會導致多數數據庫連接失敗時帶有一個恰當的錯誤信息。
• poolPingEnabled  -- 是否啟用偵測。若開啟，也必須使用一個可執行的SQL語句設置poolPingQuery屬性（最好是一個非常快的SQL）,默認值：false。
• poolPingConnectionsNotUsedFor  -- 配置poolPingQuery使用的頻度。這可以被設置成匹配具體的數據庫連接超時時間，來避免不必要的偵測，默認值：0（即所有連接每一時刻都被偵測  --  當然僅當 poolPingEnabled為true時適用）。

JNDI  -- 這個數據源的實現是為了能在如EJB或應用服務器這類容器中使用，容器可以集中或在外部配置數據源，然后放置一個JNDI上下文的引用。這種數據源配置只要兩個屬性：

• initial_context  -- 這個屬性用來在InitialContext中尋找上下文（即，initialContext.lookup(initial_context)）。這是個可選屬性，如果忽略，那么data_source屬性將會直接從InitialContext中尋找。
• data_source  -- 這是引用數據源實例位置的上下文的路徑。提供了 initial_context配置時會在其返回的上下文中進行查找，沒有提供時則直接在InitialContext中查找。

和其他數據源配置類似，可以通過添加前綴"env."直接把屬性傳遞給初始上下文。比如：

• env.encoding=UTF-8

這會在初始上下文（InitialContext）實例化時往它的構造方法傳遞值為UTF-8的encoding屬性。

通過需要實現接口 org.apache.ibatis.datasource.DataSourceFactory，也可使用任何第三方數據源，：

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

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

 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調用的setter方法中增加一個屬性。下面是一個可以連接到PostgreSQL數據庫的例子：

<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可以根據不同的數據庫廠商執行不同的語句，這種多廠商的支持是基於映射語句中的databaseId屬性。MyBatis會加載不帶databaseId屬性和帶有匹配當前數據庫databaseId屬性的所有語句。如果同時找到帶有databaseId和不帶databaseId的相同語句，則后者被舍棄。為支持多廠商特性，只要像下面這樣在mybatis-config.xml文件中加入databaseIdProvider即可：

<databaseIdProvider type="DB_VENDOR" />

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

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

在有properties時，DB_VENDOR databaseIdProvider的將被設置為第一個能匹配數據庫產品名稱的屬性鍵值對應的值，如果沒有匹配的屬性將會設置為”null“。在這個例子中，如果getDatabaseProductName()返回”Oracle(DataDirect)“，databaseId將被設置為"oracle"。

可以通過實現接口org.apache.ibatis.mapping.DatabaseIdProvider並在mybatis-config.xml中注冊來構建自己的DatabaseIdProvider：

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

映射器（mappers）

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

<!-- Using classpath relative resources -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

<!-- Using url fully qualified paths -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

<!-- Using mapper interface classes -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

<!-- Register all interfaces in a package as mappers -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

這些配置會告訴了MyBatis去哪里找映射文件，剩下的細節就應該是每個SQL映射文件了。

XML 映射配置文件

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

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

properties

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

<propertiesresource="org/mybatis/example/config.properties"><propertyname="username"value="dev_user"/><propertyname="password"value="F2Fa3!33TYyg"/></properties>

其中的屬性就可以在整個配置文件中使用來替換需要動態配置的屬性值。比如:

<dataSourcetype="POOLED"><propertyname="driver"value="${driver}"/><propertyname="url"value="${url}"/><propertyname="username"value="${username}"/><propertyname="password"value="${password}"/></dataSource>

這個例子中的 username 和 password 將會由 properties 元素中設置的相應值來替換。 driver 和 url 屬性將會由 config.properties 文件中對應的值來替換。這樣就為配置提供了諸多靈活選擇。

屬性也可以被傳遞到 SqlSessionBuilder.build()方法中。例如：

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

如果屬性在不只一個地方進行了配置，那么 MyBatis 將按照下面的順序來加載：

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

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

settings

這是 MyBatis 中極為重要的調整設置，它們會改變 MyBatis 的運行時行為。下表描述了設置中各項的意圖、默認值等。

設置參數	描述	有效值	默認值
cacheEnabled	該配置影響的所有映射器中配置的緩存的全局開關。	true | false	true
lazyLoadingEnabled	延遲加載的全局開關。當開啟時，所有關聯對象都會延遲加載。 特定關聯關系中可通過設置fetchType屬性來覆蓋該項的開關狀態。	true | false	false
aggressiveLazyLoading	當啟用時，對任意延遲屬性的調用會使帶有延遲加載屬性的對象完整加載；反之，每種屬性將會按需加載。	true | false	true
multipleResultSetsEnabled	是否允許單一語句返回多結果集（需要兼容驅動）。	true | false	true
useColumnLabel	使用列標簽代替列名。不同的驅動在這方面會有不同的表現， 具體可參考相關驅動文檔或通過測試這兩種不同的模式來觀察所用驅動的結果。	true | false	true
useGeneratedKeys	允許 JDBC 支持自動生成主鍵，需要驅動兼容。 如果設置為 true 則這個設置強制使用自動生成主鍵，盡管一些驅動不能兼容但仍可正常工作（比如 Derby）。	true | false	False
autoMappingBehavior	指定 MyBatis 應如何自動映射列到字段或屬性。 NONE 表示取消自動映射；PARTIAL 只會自動映射沒有定義嵌套結果集映射的結果集。 FULL 會自動映射任意復雜的結果集（無論是否嵌套）。	NONE, PARTIAL, FULL	PARTIAL
autoMappingUnknownColumnBehavior	Specify the behavior when detects an unknown column (or unknown property type) of automatic mapping target. NONE: Do nothing WARNING: Output warning log (The log level of'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior'must be set to WARN) FAILING: Fail mapping (Throw SqlSessionException)	NONE, WARNING, FAILING	NONE
defaultExecutorType	配置默認的執行器。SIMPLE 就是普通的執行器；REUSE 執行器會重用預處理語句（prepared statements）； BATCH 執行器將重用語句並執行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	設置超時時間，它決定驅動等待數據庫響應的秒數。	Any positive integer	Not Set (null)
defaultFetchSize	Sets the driver a hint as to control fetching size for return results. This parameter value can be override by a query setting.	Any positive integer	Not Set (null)
safeRowBoundsEnabled	允許在嵌套語句中使用分頁（RowBounds）。 If allow, set the false.	true | false	False
safeResultHandlerEnabled	允許在嵌套語句中使用分頁（ResultHandler）。 If allow, set the false.	true | false	True
mapUnderscoreToCamelCase	是否開啟自動駝峰命名規則（camel case）映射，即從經典數據庫列名 A_COLUMN 到經典 Java 屬性名 aColumn 的類似映射。	true | false	False
localCacheScope	MyBatis 利用本地緩存機制（Local Cache）防止循環引用（circular references）和加速重復嵌套查詢。 默認值為 SESSION，這種情況下會緩存一個會話中執行的所有查詢。 若設置值為 STATEMENT，本地會話僅用在語句執行上，對相同 SqlSession 的不同調用將不會共享數據。	SESSION | STATEMENT	SESSION
jdbcTypeForNull	當沒有為參數提供特定的 JDBC 類型時，為空值指定 JDBC 類型。 某些驅動需要指定列的 JDBC 類型，多數情況直接用一般類型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType enumeration. Most common are: NULL, VARCHAR and OTHER	OTHER
lazyLoadTriggerMethods	指定哪個對象的方法觸發一次延遲加載。	A method name list separated by commas	equals,clone,hashCode,toString
defaultScriptingLanguage	指定動態 SQL 生成的默認語言。	A type alias or fully qualified class name.	org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver
callSettersOnNulls	指定當結果集中值為 null 的時候是否調用映射對象的 setter（map 對象時為 put）方法，這對於有 Map.keySet() 依賴或 null 值初始化的時候是有用的。注意基本類型（int、boolean等）是不能設置成 null 的。	true | false	false
logPrefix	指定 MyBatis 增加到日志名稱的前綴。	Any String	Not set
logImpl	指定 MyBatis 所用日志的具體實現，未指定時將自動查找。	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	Not set
proxyFactory	指定 Mybatis 創建具有延遲加載能力的對象所用到的代理工具。	CGLIB | JAVASSIST	JAVASSIST (MyBatis 3.3 or above)
vfsImpl	Specifies VFS implementations	Fully qualified class names of custom VFS implementation separated by commas.	Not set
useActualParamName	Allow referencing statement parameters by their actual names declared in the method signature. To use this feature, your project must be compiled in Java 8 with -parameters option. (Since: 3.4.1)	true | false	true

一個配置完整的 settings 元素的示例如下：

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

typeAliases

類型別名是為 Java 類型設置一個短的名字。它只和 XML 配置有關，存在的意義僅在於用來減少類完全限定名的冗余。例如:

<typeAliases><typeAliasalias="Author"type="domain.blog.Author"/><typeAliasalias="Blog"type="domain.blog.Blog"/><typeAliasalias="Comment"type="domain.blog.Comment"/><typeAliasalias="Post"type="domain.blog.Post"/><typeAliasalias="Section"type="domain.blog.Section"/><typeAliasalias="Tag"type="domain.blog.Tag"/></typeAliases>

當這樣配置時，Blog可以用在任何使用domain.blog.Blog的地方。

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

<typeAliases><packagename="domain.blog"/></typeAliases>

每一個在包 domain.blog 中的 Java Bean，在沒有注解的情況下，會使用 Bean 的首字母小寫的非限定類名來作為它的別名。 比如 domain.blog.Author 的別名為author；若有注解，則別名為其注解值。看下面的例子：

@Alias("author")publicclassAuthor{...}

已經為許多常見的 Java 類型內建了相應的類型別名。它們都是大小寫不敏感的，需要注意的是由基本類型名稱重復導致的特殊處理。

別名	映射的類型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

typeHandlers

無論是 MyBatis 在預處理語句（PreparedStatement）中設置一個參數時，還是從結果集中取出一個值時， 都會用類型處理器將獲取的值以合適的方式轉換成 Java 類型。下表描述了一些默認的類型處理器。

NOTE If you use classes provided by JSR-310(Date and Time API), you can use the mybatis-typehandlers-jsr310.

類型處理器	Java 類型	JDBC 類型
BooleanTypeHandler	java.lang.Boolean, boolean	數據庫兼容的 BOOLEAN
ByteTypeHandler	java.lang.Byte, byte	數據庫兼容的 NUMERIC 或 BYTE
ShortTypeHandler	java.lang.Short, short	數據庫兼容的 NUMERIC 或 SHORT INTEGER
IntegerTypeHandler	java.lang.Integer, int	數據庫兼容的 NUMERIC 或 INTEGER
LongTypeHandler	java.lang.Long, long	數據庫兼容的 NUMERIC 或 LONG INTEGER
FloatTypeHandler	java.lang.Float, float	數據庫兼容的 NUMERIC 或 FLOAT
DoubleTypeHandler	java.lang.Double, double	數據庫兼容的 NUMERIC 或 DOUBLE
BigDecimalTypeHandler	java.math.BigDecimal	數據庫兼容的 NUMERIC 或 DECIMAL
StringTypeHandler	java.lang.String	CHAR, VARCHAR
ClobReaderTypeHandler	java.io.Reader	-
ClobTypeHandler	java.lang.String	CLOB, LONGVARCHAR
NStringTypeHandler	java.lang.String	NVARCHAR, NCHAR
NClobTypeHandler	java.lang.String	NCLOB
BlobInputStreamTypeHandler	java.io.InputStream	-
ByteArrayTypeHandler	byte[]	數據庫兼容的字節流類型
BlobTypeHandler	byte[]	BLOB, LONGVARBINARY
DateTypeHandler	java.util.Date	TIMESTAMP
DateOnlyTypeHandler	java.util.Date	DATE
TimeOnlyTypeHandler	java.util.Date	TIME
SqlTimestampTypeHandler	java.sql.Timestamp	TIMESTAMP
SqlDateTypeHandler	java.sql.Date	DATE
SqlTimeTypeHandler	java.sql.Time	TIME
ObjectTypeHandler	Any	OTHER 或未指定類型
EnumTypeHandler	Enumeration Type	VARCHAR-任何兼容的字符串類型，存儲枚舉的名稱（而不是索引）
EnumOrdinalTypeHandler	Enumeration Type	任何兼容的 NUMERIC 或 DOUBLE 類型，存儲枚舉的索引（而不是名稱）。

你可以重寫類型處理器或創建你自己的類型處理器來處理不支持的或非標准的類型。 具體做法為：實現 org.apache.ibatis.type.TypeHandler 接口， 或繼承一個很便利的類 org.apache.ibatis.type.BaseTypeHandler， 然后可以選擇性地將它映射到一個 JDBC 類型。比如：

// ExampleTypeHandler.java@MappedJdbcTypes(JdbcType.VARCHAR)publicclassExampleTypeHandlerextendsBaseTypeHandler<String>{@Overridepublicvoid setNonNullParameter(PreparedStatement ps,int i,String parameter,JdbcType jdbcType)throwsSQLException{
    ps.setString(i, parameter);}@OverridepublicString getNullableResult(ResultSet rs,String columnName)throwsSQLException{return rs.getString(columnName);}@OverridepublicString getNullableResult(ResultSet rs,int columnIndex)throwsSQLException{return rs.getString(columnIndex);}@OverridepublicString getNullableResult(CallableStatement cs,int columnIndex)throwsSQLException{return cs.getString(columnIndex);}}

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

使用這個的類型處理器將會覆蓋已經存在的處理 Java 的 String 類型屬性和 VARCHAR 參數及結果的類型處理器。 要注意 MyBatis 不會窺探數據庫元信息來決定使用哪種類型，所以你必須在參數和結果映射中指明那是 VARCHAR 類型的字段， 以使其能夠綁定到正確的類型處理器上。 這是因為：MyBatis 直到語句被執行才清楚數據類型。

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

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

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

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

When deciding which TypeHandler to use in a ResultMap, the Java type is known (from the result type), but the JDBC type is unknown. MyBatis therefore uses the combination javaType=[TheJavaType], jdbcType=null to choose a TypeHandler. This means that using a @MappedJdbcTypes annotation restricts the scope of a TypeHandler and makes it unavailable for use in ResultMaps unless explicity set. To make a TypeHandler available for use in a ResultMap, setincludeNullJdbcType=true on the @MappedJdbcTypes annotation. Since Mybatis 3.4.0 however, if a single TypeHandler is registered to handle a Java type, it will be used by default in ResultMaps using this Java type (i.e. even without includeNullJdbcType=true).

最后，可以讓 MyBatis 為你查找類型處理器：

<!-- mybatis-config.xml --><typeHandlers><packagename="org.mybatis.example"/></typeHandlers>

注意在使用自動檢索（autodiscovery）功能的時候，只能通過注解方式來指定 JDBC 的類型。

你能創建一個泛型類型處理器，它可以處理多於一個類。為達到此目的， 需要增加一個接收該類作為參數的構造器，這樣在構造一個類型處理器的時候 MyBatis 就會傳入一個具體的類。

//GenericTypeHandler.javapublicclassGenericTypeHandler<E extendsMyObject>extendsBaseTypeHandler<E>{privateClass<E> type;publicGenericTypeHandler(Class<E> type){if(type ==null)thrownewIllegalArgumentException("Type argument cannot be null");this.type = type;}...

EnumTypeHandler 和 EnumOrdinalTypeHandler 都是泛型類型處理器（generic TypeHandlers）， 我們將會在接下來的部分詳細探討。

處理枚舉類型

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

比如說我們想存儲取近似值時用到的舍入模式。默認情況下，MyBatis 會利用 EnumTypeHandler 來把 Enum 值轉換成對應的名字。

注意 EnumTypeHandler 在某種意義上來說是比較特別的，其他的處理器只針對某個特定的類，而它不同，它會處理任意繼承了 Enum 的類。

不過，我們可能不想存儲名字，相反我們的 DBA 會堅持使用整形值代碼。那也一樣輕而易舉： 在配置文件中把 EnumOrdinalTypeHandler 加到 typeHandlers 中即可， 這樣每個 RoundingMode 將通過他們的序數值來映射成對應的整形。

<!-- mybatis-config.xml --><typeHandlers><typeHandlerhandler="org.apache.ibatis.type.EnumOrdinalTypeHandler"javaType="java.math.RoundingMode"/></typeHandlers>

但是怎樣能將同樣的 Enum 既映射成字符串又映射成整形呢？

自動映射器（auto-mapper）會自動地選用 EnumOrdinalTypeHandler 來處理， 所以如果我們想用普通的 EnumTypeHandler，就非要為那些 SQL 語句顯式地設置要用到的類型處理器不可。

（下一節才開始講映射器文件，所以如果是首次閱讀該文檔，你可能需要先越過這一步，過會再來看。）

<!DOCTYPE mapper
    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mappernamespace="org.apache.ibatis.submitted.rounding.Mapper"><resultMaptype="org.apache.ibatis.submitted.rounding.User"id="usermap"><idcolumn="id"property="id"/><resultcolumn="name"property="name"/><resultcolumn="funkyNumber"property="funkyNumber"/><resultcolumn="roundingMode"property="roundingMode"/></resultMap><selectid="getUser"resultMap="usermap">
		select * from users
	</select><insertid="insert">
	    insert into users (id, name, funkyNumber, roundingMode) values (
	    	#{id}, #{name}, #{funkyNumber}, #{roundingMode}
	    )
	</insert><resultMaptype="org.apache.ibatis.submitted.rounding.User"id="usermap2"><idcolumn="id"property="id"/><resultcolumn="name"property="name"/><resultcolumn="funkyNumber"property="funkyNumber"/><resultcolumn="roundingMode"property="roundingMode"typeHandler="org.apache.ibatis.type.EnumTypeHandler"/></resultMap><selectid="getUser2"resultMap="usermap2">
		select * from users2
	</select><insertid="insert2">
	    insert into users2 (id, name, funkyNumber, roundingMode) values (
	    	#{id}, #{name}, #{funkyNumber}, #{roundingMode, typeHandler=org.apache.ibatis.type.EnumTypeHandler}
	    )
	</insert></mapper>

注意，這里的 select 語句強制使用 resultMap 來代替 resultType。

對象工廠（objectFactory）

MyBatis 每次創建結果對象的新實例時，它都會使用一個對象工廠（ObjectFactory）實例來完成。 默認的對象工廠需要做的僅僅是實例化目標類，要么通過默認構造方法，要么在參數映射存在的時候通過參數構造方法來實例化。 如果想覆蓋對象工廠的默認行為，則可以通過創建自己的對象工廠來實現。比如：

// ExampleObjectFactory.javapublicclassExampleObjectFactoryextendsDefaultObjectFactory{publicObject create(Class type){returnsuper.create(type);}publicObject create(Class type,List<Class> constructorArgTypes,List<Object> constructorArgs){returnsuper.create(type, constructorArgTypes, constructorArgs);}publicvoid setProperties(Properties properties){super.setProperties(properties);}public<T>boolean isCollection(Class<T> type){returnCollection.class.isAssignableFrom(type);}}

<!-- mybatis-config.xml --><objectFactorytype="org.mybatis.example.ExampleObjectFactory"><propertyname="someProperty"value="100"/></objectFactory>

ObjectFactory 接口很簡單，它包含兩個創建用的方法，一個是處理默認構造方法的，另外一個是處理帶參數的構造方法的。 最后，setProperties 方法可以被用來配置 ObjectFactory，在初始化你的 ObjectFactory 實例后， objectFactory 元素體中定義的屬性會被傳遞給 setProperties 方法。

插件（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 接口，並指定了想要攔截的方法簽名即可。

// ExamplePlugin.java@Intercepts({@Signature(
  type=Executor.class,
  method ="update",
  args ={MappedStatement.class,Object.class})})publicclassExamplePluginimplementsInterceptor{publicObject intercept(Invocation invocation)throwsThrowable{return invocation.proceed();}publicObject plugin(Object target){returnPlugin.wrap(target,this);}publicvoid setProperties(Properties properties){}}

<!-- mybatis-config.xml --><plugins><plugininterceptor="org.mybatis.example.ExamplePlugin"><propertyname="someProperty"value="100"/></plugin></plugins>

上面的插件將會攔截在 Executor 實例中所有的 “update” 方法調用， 這里的 Executor 是負責執行低層映射語句的內部對象。

NOTE 覆蓋配置類

除了用插件來修改 MyBatis 核心行為之外，還可以通過完全覆蓋配置類來達到目的。只需繼承后覆蓋其中的每個方法，再把它傳遞到 sqlSessionFactoryBuilder.build(myConfig) 方法即可。再次重申，這可能會嚴重影響 MyBatis 的行為，務請慎之又慎。

配置環境（environments）

MyBatis 可以配置成適應多種環境，這種機制有助於將 SQL 映射應用於多種數據庫之中， 現實情況下有多種理由需要這么做。例如，開發、測試和生產環境需要有不同的配置；或者共享相同 Schema 的多個生產數據庫， 想使用相同的 SQL 映射。許多類似的用例。

不過要記住：盡管可以配置多個環境，每個 SqlSessionFactory 實例只能選擇其一。

所以，如果你想連接兩個數據庫，就需要創建兩個 SqlSessionFactory 實例，每個數據庫對應一個。而如果是三個數據庫，就需要三個實例，依此類推，記起來很簡單：

• 每個數據庫對應一個 SqlSessionFactory 實例

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

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

如果忽略了環境參數，那么默認環境將會被加載，如下所示：

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader);SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader,properties);

環境元素定義了如何配置環境。

<environmentsdefault="development"><environmentid="development"><transactionManagertype="JDBC"><propertyname="..."value="..."/></transactionManager><dataSourcetype="POOLED"><propertyname="driver"value="${driver}"/><propertyname="url"value="${url}"/><propertyname="username"value="${username}"/><propertyname="password"value="${password}"/></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 來阻止它默認的關閉行為。例如:

  <transactionManagertype="MANAGED"><propertyname="closeConnection"value="false"/></transactionManager>

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

這兩種事務管理器類型都不需要任何屬性。它們不過是類型別名，換句話說，你可以使用 TransactionFactory 接口的實現類的完全限定名或類型別名代替它們。

publicinterfaceTransactionFactory{void setProperties(Properties props);Transaction newTransaction(Connection conn);Transaction newTransaction(DataSource dataSource,TransactionIsolationLevel level,boolean autoCommit);}

任何在 XML 中配置的屬性在實例化之后將會被傳遞給 setProperties() 方法。你也需要創建一個 Transaction 接口的實現類，這個接口也很簡單：

publicinterfaceTransaction{Connection getConnection()throwsSQLException;void commit()throwsSQLException;void rollback()throwsSQLException;void close()throwsSQLException;Integer getTimeout()throwsSQLException;}

使用這兩個接口，你可以完全自定義 MyBatis 對事務的處理。

數據源（dataSource）

dataSource 元素使用標准的 JDBC 數據源接口來配置 JDBC 連接對象的資源。

• 許多 MyBatis 的應用程序將會按示例中的例子來配置數據源。然而它並不是必須的。要知道為了方便使用延遲加載，數據源才是必須的。

有三種內建的數據源類型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）：

UNPOOLED– 這個數據源的實現只是每次被請求時打開和關閉連接。雖然一點慢，它對在及時可用連接方面沒有性能要求的簡單應用程序是一個很好的選擇。 不同的數據庫在這方面表現也是不一樣的，所以對某些數據庫來說使用連接池並不重要，這個配置也是理想的。UNPOOLED 類型的數據源僅僅需要配置以下 5 種屬性：

• driver – 這是 JDBC 驅動的 Java 類的完全限定名（並不是JDBC驅動中可能包含的數據源類）。
• url – 這是數據庫的 JDBC URL 地址。
• username – 登錄數據庫的用戶名。
• password – 登錄數據庫的密碼。
• defaultTransactionIsolationLevel – 默認的連接事務隔離級別。

作為可選項，你也可以傳遞屬性給數據庫驅動。要這樣做，屬性的前綴為“driver.”，例如：

• driver.encoding=UTF8

這將通過DriverManager.getConnection(url,driverProperties)方法傳遞值為 UTF8 的 encoding 屬性給數據庫驅動。

POOLED– 這種數據源的實現利用“池”的概念將 JDBC 連接對象組織起來，避免了創建新的連接實例時所必需的初始化和認證時間。 這是一種使得並發 Web 應用快速響應請求的流行處理方式。

除了上述提到 UNPOOLED 下的屬性外，會有更多屬性用來配置 POOLED 的數據源：

• poolMaximumActiveConnections – 在任意時間可以存在的活動（也就是正在使用）連接數量，默認值：10
• poolMaximumIdleConnections – 任意時間可能存在的空閑連接數。
• poolMaximumCheckoutTime – 在被強制返回之前，池中連接被檢出（checked out）時間，默認值：20000 毫秒（即 20 秒）
• poolTimeToWait – 這是一個底層設置，如果獲取連接花費的相當長的時間，它會給連接池打印狀態日志並重新嘗試獲取一個連接（避免在誤配置的情況下一直安靜的失敗），默認值：20000 毫秒（即 20 秒）。
• poolPingQuery – 發送到數據庫的偵測查詢，用來檢驗連接是否處在正常工作秩序中並准備接受請求。默認是“NO PING QUERY SET”，這會導致多數數據庫驅動失敗時帶有一個恰當的錯誤消息。
• poolPingEnabled – 是否啟用偵測查詢。若開啟，也必須使用一個可執行的 SQL 語句設置 poolPingQuery 屬性（最好是一個非常快的 SQL），默認值：false。
• poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的使用頻度。這可以被設置成匹配具體的數據庫連接超時時間，來避免不必要的偵測，默認值：0（即所有連接每一時刻都被偵測 — 當然僅當 poolPingEnabled 為 true 時適用）。

JNDI– 這個數據源的實現是為了能在如 EJB 或應用服務器這類容器中使用，容器可以集中或在外部配置數據源，然后放置一個 JNDI 上下文的引用。這種數據源配置只需要兩個屬性：

• initial_context – 這個屬性用來在 InitialContext 中尋找上下文（即，initialContext.lookup(initial_context)）。這是個可選屬性，如果忽略，那么 data_source 屬性將會直接從 InitialContext 中尋找。
• data_source – 這是引用數據源實例位置的上下文的路徑。提供了 initial_context 配置時會在其返回的上下文中進行查找，沒有提供時則直接在 InitialContext 中查找。

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

• env.encoding=UTF8

這就會在初始上下文（InitialContext）實例化時往它的構造方法傳遞值為 UTF8 的 encoding 屬性。

通過需要實現接口 org.apache.ibatis.datasource.DataSourceFactory ， 也可使用任何第三方數據源，：

publicinterfaceDataSourceFactory{void setProperties(Properties props);DataSource getDataSource();}

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

import org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory;import com.mchange.v2.c3p0.ComboPooledDataSource;publicclass C3P0DataSourceFactory extendsUnpooledDataSourceFactory{public C3P0DataSourceFactory(){this.dataSource =newComboPooledDataSource();}}

為了令其工作，為每個需要 MyBatis 調用的 setter 方法中增加一個屬性。下面是一個可以連接至 PostgreSQL 數據庫的例子：

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

databaseIdProvider

MyBatis 可以根據不同的數據庫廠商執行不同的語句，這種多廠商的支持是基於映射語句中的 databaseId 屬性。 MyBatis 會加載不帶 databaseId 屬性和帶有匹配當前數據庫 databaseId 屬性的所有語句。 如果同時找到帶有 databaseId 和不帶 databaseId 的相同語句，則后者會被舍棄。 為支持多廠商特性只要像下面這樣在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

<databaseIdProvidertype="DB_VENDOR"/>

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

<databaseIdProvidertype="DB_VENDOR"><propertyname="SQL Server"value="sqlserver"/><propertyname="DB2"value="db2"/><propertyname="Oracle"value="oracle"/></databaseIdProvider>

在有 properties 時，DB_VENDOR databaseIdProvider 的將被設置為第一個能匹配數據庫產品名稱的屬性鍵對應的值，如果沒有匹配的屬性將會設置為 “null”。 在這個例子中，如果 getDatabaseProductName() 返回“Oracle (DataDirect)”，databaseId 將被設置為“oracle”。

你可以通過實現接口 org.apache.ibatis.mapping.DatabaseIdProvider 並在 mybatis-config.xml 中注冊來構建自己的 DatabaseIdProvider：

publicinterfaceDatabaseIdProvider{void setProperties(Properties p);String getDatabaseId(DataSource dataSource)throwsSQLException;}

映射器（mappers）

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

<!-- Using classpath relative resources --><mappers><mapperresource="org/mybatis/builder/AuthorMapper.xml"/><mapperresource="org/mybatis/builder/BlogMapper.xml"/><mapperresource="org/mybatis/builder/PostMapper.xml"/></mappers>

<!-- Using url fully qualified paths --><mappers><mapperurl="file:///var/mappers/AuthorMapper.xml"/><mapperurl="file:///var/mappers/BlogMapper.xml"/><mapperurl="file:///var/mappers/PostMapper.xml"/></mappers>

<!-- Using mapper interface classes --><mappers><mapperclass="org.mybatis.builder.AuthorMapper"/><mapperclass="org.mybatis.builder.BlogMapper"/><mapperclass="org.mybatis.builder.PostMapper"/></mappers>

<!-- Register all interfaces in a package as mappers --><mappers><packagename="org.mybatis.builder"/></mappers>

這些配置會告訴了 MyBatis 去哪里找映射文件，剩下的細節就應該是每個 SQL 映射文件了，也就是接下來我們要討論的。