MyBatis xml配置文件详解

谁借莪１个温暖的怀抱￠ 2021-09-02 05:31 479阅读 0赞

## 一、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>
        
        <settings>
           
           <setting name="" value=""/> 
        </settings>
        
        <typeAliases></typeAliases>
        
        <typeHandlers></typeHandlers>
        
        <objectFactory type=""></objectFactory>
        
        <plugins>
           <plugin interceptor=""></plugin>
        </plugins>
        
        <environments default="">
           
           <environment id="">
              
              <transactionManager type=""></transactionManager>
              
              <dataSource type=""></dataSource>
           </environment> 
        </environments>
        
        <databaseIdProvider type=""></databaseIdProvider>
        
        <mappers></mappers>
    </configuration>

### 1、properties ###

properties元素主要是用来定义配置外在化，比如数据库的连接属性等。这些属性都是可外部配置且可动态替换的，既可以在典型的Java属性文件中配置，亦可以通过properties元素的子元素来传递。例如：

其中的属性就可以在整个配置文件中使用来替换需要动态配置的属性值。比如在数据源中使用的例子：

这个例子中的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属性中指定的属性。

### 2、 settings ###

setting是指定MyBatis的一些全局配置属性，这是MyBatis中极为重要的调整设置，它们会改变MyBatis的运行时行为，所以我们需要清楚的知道这些属性的作用及默认值。

<table> 
 <tbody> 
  <tr> 
   <td>设置参数</td> 
   <td style="width:288px;">描述</td> 
   <td style="width:12px;">有效值</td> 
   <td>默认值</td> 
  </tr> 
  <tr> 
   <td>cacheEnabled</td> 
   <td style="width:288px;">该配置影响的所有映射器中配置的缓存的全局开关</td> 
   <td style="width:12px;">true | false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>lazyLoadingEnabled</td> 
   <td style="width:288px;">延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置fetchType属性来覆盖该项的开关状态</td> 
   <td style="width:12px;">true | false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>aggressiveLazyLoading</td> 
   <td style="width:288px;">当启用时，对任意延迟属性的调用会使带有延迟加载属性的对象完整加载；反之，每种属性将会按需加载。</td> 
   <td style="width:12px;">true | false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>multipleResultSetsEnabled</td> 
   <td style="width:288px;">是否允许单一语句返回多结果集（需要兼容驱动）。</td> 
   <td style="width:12px;">true | false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>useColumnLabel</td> 
   <td style="width:288px;">使用列标签代替列名。不同的驱动在这方面会有不同的表现， 具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。</td> 
   <td style="width:12px;">true | false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>useGeneratedKeys</td> 
   <td style="width:288px;">允许 JDBC 支持自动生成主键，需要驱动兼容。 如果设置为 true 则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工作（比如 Derby）。</td> 
   <td style="width:12px;">true | false</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>autoMappingBehavior</td> 
   <td style="width:288px;">指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）。</td> 
   <td style="width:12px;">NONE, PARTIAL, FULL</td> 
   <td>PARTIAL</td> 
  </tr> 
  <tr> 
   <td>defaultExecutorType</td> 
   <td style="width:288px;">配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）； BATCH 执行器将重用语句并执行批量更新。</td> 
   <td style="width:12px;">SIMPLE REUSE BATCH</td> 
   <td>SIMPLE</td> 
  </tr> 
  <tr> 
   <td>defaultStatementTimeout</td> 
   <td style="width:288px;">设置超时时间，它决定驱动等待数据库响应的秒数。</td> 
   <td style="width:12px;">Any positive integer</td> 
   <td>Not Set (null)</td> 
  </tr> 
  <tr> 
   <td>defaultFetchSize</td> 
   <td style="width:288px;">Sets the driver a hint as to control fetching size for return results. This parameter value can be override by a query setting.</td> 
   <td style="width:12px;">Any positive integer</td> 
   <td>Not Set (null)</td> 
  </tr> 
  <tr> 
   <td>safeRowBoundsEnabled</td> 
   <td style="width:288px;">允许在嵌套语句中使用分页（RowBounds）。</td> 
   <td style="width:12px;">true | false</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>mapUnderscoreToCamelCase</td> 
   <td style="width:288px;">是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。</td> 
   <td style="width:12px;">true | false</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>localCacheScope</td> 
   <td style="width:288px;">MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。 默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据。</td> 
   <td style="width:12px;">SESSION | STATEMENT</td> 
   <td>SESSION</td> 
  </tr> 
  <tr> 
   <td>jdbcTypeForNull</td> 
   <td style="width:288px;">当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。</td> 
   <td style="width:12px;">JdbcType enumeration. Most common are: NULL, VARCHAR and OTHER</td> 
   <td>OTHER</td> 
  </tr> 
  <tr> 
   <td>lazyLoadTriggerMethods</td> 
   <td style="width:288px;">指定哪个对象的方法触发一次延迟加载。</td> 
   <td style="width:12px;">A method name list separated by commas</td> 
   <td>equals,clone,hashCode,toString</td> 
  </tr> 
  <tr> 
   <td>defaultScriptingLanguage</td> 
   <td style="width:288px;">指定动态 SQL 生成的默认语言。</td> 
   <td style="width:12px;">A type alias or fully qualified class name.</td> 
   <td> <p>org.apache.ibatis.scripting.xmltags</p> <p>.XMLDynamicLanguageDriver</p> </td> 
  </tr> 
  <tr> 
   <td>callSettersOnNulls</td> 
   <td style="width:288px;">指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意基本类型（int、boolean等）是不能设置成 null 的。</td> 
   <td style="width:12px;">true | false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>logPrefix</td> 
   <td style="width:288px;">指定 MyBatis 增加到日志名称的前缀。</td> 
   <td style="width:12px;">Any String</td> 
   <td>Not set</td> 
  </tr> 
  <tr> 
   <td>logImpl</td> 
   <td style="width:288px;">指定 MyBatis 所用日志的具体实现，未指定时将自动查找。</td> 
   <td style="width:12px;">SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING</td> 
   <td>Not set</td> 
  </tr> 
  <tr> 
   <td>proxyFactory</td> 
   <td style="width:288px;">指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具。</td> 
   <td style="width:12px;">CGLIB | JAVASSIST</td> 
   <td>JAVASSIST (MyBatis 3.3 or above)</td> 
  </tr> 
 </tbody> 
</table>

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

### 3、typeAliases ###

类型别名是为Java类型设置一个短的名字。它只和xml配置有关，存在的意义仅在于用来减少类完全限定名的冗余，例如：

当这样配置时，Blog可以用在任何使用domain.blog.Blog的地方。

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

每一个在包domain.blog中的JavaBean，在没有注解的情况下，会使用Bean的首字母小写的非限类名来作为它的别名。比如domain.blog.Author的别名为author；若有注解，则别名为注解值。看下面的例子：

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

已经为许多常见的Java类型内建了相应的类型别名。它们都是大小写不敏感的，需要注意的是有基本类型名称重复导致的特殊处理。

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

### 4、typeHandlers  ###

无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时， 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器。

<table> 
 <tbody> 
  <tr> 
   <td>类型处理器</td> 
   <td>Java 类型</td> 
   <td>JDBC 类型</td> 
  </tr> 
  <tr> 
   <td>BooleanTypeHandler</td> 
   <td>java.lang.Boolean,&nbsp;boolean</td> 
   <td>数据库兼容的&nbsp;BOOLEAN</td> 
  </tr> 
  <tr> 
   <td>ByteTypeHandler</td> 
   <td>java.lang.Byte,&nbsp;byte</td> 
   <td>数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;BYTE</td> 
  </tr> 
  <tr> 
   <td>ShortTypeHandler</td> 
   <td>java.lang.Short,&nbsp;short</td> 
   <td>数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;SHORT INTEGER</td> 
  </tr> 
  <tr> 
   <td>IntegerTypeHandler</td> 
   <td>java.lang.Integer,&nbsp;int</td> 
   <td>数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;INTEGER</td> 
  </tr> 
  <tr> 
   <td>LongTypeHandler</td> 
   <td>java.lang.Long,&nbsp;long</td> 
   <td>数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;LONG INTEGER</td> 
  </tr> 
  <tr> 
   <td>FloatTypeHandler</td> 
   <td>java.lang.Float,&nbsp;float</td> 
   <td>数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;FLOAT</td> 
  </tr> 
  <tr> 
   <td>DoubleTypeHandler</td> 
   <td>java.lang.Double,&nbsp;double</td> 
   <td>数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;DOUBLE</td> 
  </tr> 
  <tr> 
   <td>BigDecimalTypeHandler</td> 
   <td>java.math.BigDecimal</td> 
   <td>数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;DECIMAL</td> 
  </tr> 
  <tr> 
   <td>StringTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>CHAR,&nbsp;VARCHAR</td> 
  </tr> 
  <tr> 
   <td>ClobTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>CLOB,&nbsp;LONGVARCHAR</td> 
  </tr> 
  <tr> 
   <td>NStringTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>NVARCHAR,&nbsp;NCHAR</td> 
  </tr> 
  <tr> 
   <td>NClobTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>NCLOB</td> 
  </tr> 
  <tr> 
   <td>ByteArrayTypeHandler</td> 
   <td>byte[]</td> 
   <td>数据库兼容的字节流类型</td> 
  </tr> 
  <tr> 
   <td>BlobTypeHandler</td> 
   <td>byte[]</td> 
   <td>BLOB,&nbsp;LONGVARBINARY</td> 
  </tr> 
  <tr> 
   <td>DateTypeHandler</td> 
   <td>java.util.Date</td> 
   <td>TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>DateOnlyTypeHandler</td> 
   <td>java.util.Date</td> 
   <td>DATE</td> 
  </tr> 
  <tr> 
   <td>TimeOnlyTypeHandler</td> 
   <td>java.util.Date</td> 
   <td>TIME</td> 
  </tr> 
  <tr> 
   <td>SqlTimestampTypeHandler</td> 
   <td>java.sql.Timestamp</td> 
   <td>TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>SqlDateTypeHandler</td> 
   <td>java.sql.Date</td> 
   <td>DATE</td> 
  </tr> 
  <tr> 
   <td>SqlTimeTypeHandler</td> 
   <td>java.sql.Time</td> 
   <td>TIME</td> 
  </tr> 
  <tr> 
   <td>ObjectTypeHandler</td> 
   <td>Any</td> 
   <td>OTHER&nbsp;或未指定类型&nbsp;</td> 
  </tr> 
  <tr> 
   <td>EnumTypeHandler</td> 
   <td>Enumeration Type&nbsp;</td> 
   <td>VARCHAR-任何兼容的字符串类型，存储枚举的名称（而不是索引）</td> 
  </tr> 
  <tr> 
   <td>EnumOrdinalTypeHandler</td> 
   <td>Enumeration Type</td> 
   <td>任何兼容的&nbsp;NUMERIC&nbsp;或&nbsp;DOUBLE&nbsp;类型，存储枚举的索引（而不是名称）。&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

可以重写类型处理器或创建自己的类型处理器来处理不支持的或非标准的类型。具体的做法为：实现org.apache.ibatis.type.TypeHandler接口，或继承一个很便利的类org.apache.ibatis.type.BaseTypeHandler,然后可以选择性地将它映射到一个JDBC类型。比如：

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);
    	}
    }

并且还需要在配置文件里面加上：

<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查找类型处理器：

<typeHandlers>
      <package name="org.mybatis.example"/>
    </typeHandlers>

注意在使用自动检索（autodiscovery）功能的时候，只能通过注解的方式来指定JDBC类型。

你能创建一个泛型类型处理器，它可以处理多于一个类。为达到此目的，需要增加一个接收该类作为参数的构造器，这样在构造一个类型处理器的时候MyBatis就会传入一个具体的类。

## 二、处理枚举类型 ##

### 1、映射枚举类型 ###

若想映射枚举类型Enum，则需要从EnumTypeHandler或者EnumOrdinalTypeHandler中选一个来使用

比如说我们想存储近似值时用到的舍入模式。默认情况下，MyBatis会利用EnumTypeHandler来把Enum值转换成对应的名字。

注意EnumTypeHandler在某种意义上来说是比较特别的，其他的处理器只针对某个特定的类，而它不同，它会处理任意继承了Enum的类。

不过，我们可能不想存储名字，相反我们的DBA会坚持使用整形值代码。那也一样轻而易举；在配置文件中把EnumOrdinalTypeHandler加到typeHandlers中即可，这样每个RoundingMode将通过他们的序数值来映射成对应的整形。

### 2、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）实例来完成。默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认构造方法，要么在参数映射存在的时候通过参数构造方法来实例化。如果想覆盖对象工厂的行为，则可以通过创建自己的对象工厂来实现，比如：

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);
    	}
    }

<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接口，并指定想要拦截的方法签名即可。

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

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

上面的插件将会拦截Executor实例中所有的“update”方法调用，这里的Executor是负责执行底层映射语句的内部对象。  
覆盖配置类

除了用插件来修改MyBatis核心行为之外，还可以通过完全覆盖配置类来达到目的。只需继承后覆盖其中的每个方法，再把它传递到sqlSessionFactoryBuilder.build(myConfig)方法即可。再次重申，这可能会严重影响Mybatis的行为，务请慎之又慎！

## 五、配置环境（environments） ##

### 1、配置环境简介 ###

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

### 2、环境元素定义了如何配置环境 ###

### 3、注意这里的关键点 ###

*  默认环境的ID（比如：default="development"）
 *  每个environment元素定义的环境ID（比如：id="development"）
 *  事务管理器的配置（比如：type="JDBC"）
 *  数据源的配置（比如：type="POOLED"）

默认的环境和环境ID是一目了然的。随你怎么命名，只要保证默认环境要匹配其中一个环境ID  
事务管理器（transactionManager）

### 4、事务管理器 ###

在MyBatis中有两种类型的事务管理器（也就是 type="\[JDBC|MANAGED\]"）

*  JDBC --- 这个配置就是直接使用了JDBC的提交和回滚设置，它依赖于从数据源得到的连接来管理事务范围。
 *  MANAGED --- 这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如JEE应用服务器上下文）。默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将closeConnection属性设置为false来阻止它默认的行为。例如

如果正在使用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的应用程序将会按示例中的例子来配置数据源。然而它并不是必须的。要知道为了方便使用延迟加载，数据源才是必须的。

### 5、数据源类型 ###

有三种内建的数据源类型（也就是 type="\[\]UNPOOLED|POOLED|JNDI\]"）；

（1）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属性给数据库驱动。

（2）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时适用）。

（3）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所必需的代码：

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

为了令其工作，为每个需要MyBatis调用的setter方法中增加一个属性。下面是一个可以连接到PostgreSQL数据库的例子：

##  六、databaseIdProvider ##

MyBatis可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的databaseId属性。MyBatis会加载不带databaseId属性和带有匹配当前数据库databaseId属性的所有语句。如果同时找到带有databaseId和不带databaseId的相同语句，则后者被舍弃。为支持多厂商特性，只要像下面这样在mybatis-config.xml文件中加入databaseIdProvider即可：

这里的DB\_VENDOR会通过DatabaseMetaData\#getDatabaseProductName()返回的字符串进行设置。由于通常情况下这个字符串都非常长而且相同产品的不同版本会返回不同的值，所以最好通过设置属性别名来使其变短，如下：

在有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），或类名和包名等等。例如：

<mappers>
      <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
      <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
      <mapper resource="org/mybatis/builder/PostMapper.xml"/>
    </mappers>

<mappers>
      <mapper url="file:///var/mappers/AuthorMapper.xml"/>
      <mapper url="file:///var/mappers/BlogMapper.xml"/>
      <mapper url="file:///var/mappers/PostMapper.xml"/>
    </mappers>

<mappers>
      <mapper class="org.mybatis.builder.AuthorMapper"/>
      <mapper class="org.mybatis.builder.BlogMapper"/>
      <mapper class="org.mybatis.builder.PostMapper"/>
    </mappers>

<mappers>
      <package name="org.mybatis.builder"/>
    </mappers>

这些配置会告诉了MyBatis去哪里找映射文件，剩下的细节就应该是每个SQL映射文件了。

上一篇：[MyBatis常用标签和注解（绝对经典）][MyBatis]

下一篇：[【全栈最全Java框架总结】SSH、SSM、Springboot][Java_SSH_SSM_Springboot]

[MyBatis]: https://blog.csdn.net/guorui_java/article/details/108875682
[Java_SSH_SSM_Springboot]: https://blog.csdn.net/guorui_java/article/details/104018528