MyBatis官方文档——XML配置部分

文章目录

• ​​XML配置​​

• ​​1、属性(properties)​​
• ​​2、设置(settings)​​
• ​​3、类型别名(typeAliases)​​
• ​​4、类型处理器(typeHandlers)​​
• ​​5、对象工厂(objectFactory)​​
• ​​6、插件(plugins)​​
• ​​7、环境配置(environments)​​
• ​​8、数据库厂商标识(databaseIdProvider)​​
• ​​9、映射器(mappers)​​

---

XML配置

MyBatis 的配置文件（MyBatis-config.xml）包含了会深深影响 MyBatis 行为的设置和属性信息。该层主要是对MyBatis连接数据库时的一些配置，与真实地和数据库的SQL无关。

配置文档的顶层结构如下：

1、属性(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>

---

批注：

时候后者的方式居多，某种程度上来说，使用后面的这种方式，也达到了MyBatis的配置文件和数据库配置信息的解耦。

---

方式三：也可以在 SqlSessionFactoryBuilder.build() 方法中传入属性值。例如：

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

// ... 或者 ...

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

如果一个属性在不只一个地方进行了配置，那么，MyBatis 将按照下面的顺序来加载：

• 首先读取在 properties 元素体内指定的属性。
• 然后根据 properties 元素中的 resource 属性读取类路径下属性文件，或根据 url 属性指定的路径读取属性文件，并覆盖之前读取过的同名属性。
• 最后读取作为方法参数传递的属性，并覆盖之前读取过的同名属性。

因此，通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的则是 properties 元素中指定的属性。

配置属性的占位符

从 MyBatis 3.4.2 开始，你可以为占位符指定一个默认值。例如：

<dataSource type="POOLED">
  <!-- ... -->
  <property name="username" value="${username:ut_user}"/> <!-- 如果属性 'username' 没有被配置，'username' 属性的值将为 'ut_user' -->
</dataSource>

这个特性默认是关闭的。要启用这个特性，需要添加一个特定的属性来开启这个特性。例如：

<properties resource="org/mybatis/example/config.properties">
  <!-- ... -->
  <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> <!-- 启用默认值特性 -->
</properties>

提示 如果你在属性名中使用了 ​​":"​​​ 字符（如：​​db:username​​），就需要设置特定的属性来修改分隔属性名和默认值的字符。例如：

<properties resource="org/mybatis/example/config.properties">
  <!-- ... -->
  <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/> <!-- 修改默认值的分隔符 -->
</properties>

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

---

批注：

1. 默认情况下MyBatis不支持占位符的用法
2. 如果想要使用占位符，则需要将enable-default-value属性的状态修改为true，默认为false
3. 如果你的属性名中有：字符，那么我们还需要修改对应的分隔符（避免和我们的占位符冲突）

我们的属性相关的配置都放在property标签中，对于数据库信息这块的配置，在Spring项目中，我们会将其以一个bean的形式注入到IOC容器中

<property name="xx" value="xx"/>

---

2、设置(settings)

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。

设置名	描述	有效值	默认值
cacheEnabled	全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。	true | false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 ​​fetchType​​ 属性来覆盖该项的开关状态。	true | false	false
aggressiveLazyLoading	开启时，任一方法的调用都会加载该对象的所有延迟加载属性。 否则，每个延迟加载属性会按需加载（参考 ​​lazyLoadTriggerMethods​​)。	true | false	false （在 3.4.1 及之前的版本中默认为 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	指定发现自动映射目标未知列（或未知属性类型）的行为。​​NONE​​​: 不做任何反应​​WARNING​​​: 输出警告日志（​​'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior'​​​ 的日志等级必须设置为 ​​WARN​​​）​​FAILING​​​: 映射失败 (抛出 ​​SqlSessionException​​)	NONE, WARNING, FAILING	NONE
defaultExecutorType	配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（PreparedStatement）； BATCH 执行器不仅重用语句还会执行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定数据库驱动等待数据库响应的秒数。	任意正整数	未设置 (null)
defaultFetchSize	为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。	任意正整数	未设置 (null)
defaultResultSetType	指定语句默认的滚动策略。（新增于 3.5.2）	FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT（等同于未设置）	未设置 (null)
safeRowBoundsEnabled	是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false。	true | false	False
safeResultHandlerEnabled	是否允许在嵌套语句中使用结果处理器（ResultHandler）。如果允许使用则设置为 false。	true | false	True
mapUnderscoreToCamelCase	是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。	true | false	False
localCacheScope	MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。 默认值为 SESSION，会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。	SESSION | STATEMENT	SESSION
jdbcTypeForNull	当没有为参数指定特定的 JDBC 类型时，空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType 常量，常用值：NULL、VARCHAR 或 OTHER。	OTHER
lazyLoadTriggerMethods	指定对象的哪些方法触发一次延迟加载。	用逗号分隔的方法列表。	equals,clone,hashCode,toString
defaultScriptingLanguage	指定动态 SQL 生成使用的默认脚本语言。	一个类型别名或全限定类名。	org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
defaultEnumTypeHandler	指定 Enum 使用的默认 ​​TypeHandler​​ 。（新增于 3.4.5）	一个类型别名或全限定类名。	org.apache.ibatis.type.EnumTypeHandler
callSettersOnNulls	指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的。	true | false	false
returnInstanceForEmptyRow	当返回行的所有列都是空时，MyBatis默认返回 ​​null​​。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2）	true | false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀。	任何字符串	未设置
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	未设置
proxyFactory	指定 Mybatis 创建可延迟加载对象所用到的代理工具。	CGLIB | JAVASSIST	JAVASSIST （MyBatis 3.3 以上）
vfsImpl	指定 VFS 的实现	自定义 VFS 的实现的类全限定名，以逗号分隔。	未设置
useActualParamName	允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 ​​-parameters​​ 选项。（新增于 3.4.1）	true | false	true
configurationFactory	指定一个提供 ​​Configuration​​​ 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为​​static Configuration getConfiguration()​​ 的方法。（新增于 3.2.3）	一个类型别名或完全限定类名。	未设置
shrinkWhitespacesInSql	从SQL中删除多余的空格字符。请注意，这也会影响SQL中的文字字符串。 (新增于 3.5.5)	true | false	false
defaultSqlProviderType	Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the ​​type​​​(or ​​value​​​) attribute on sql provider annotation(e.g. ​​@SelectProvider​​), when these attribute was omitted.	A type alias or fully qualified class name	Not set

一个配置完整的 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="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>

---

批注：

有关设置的相关配置，都在settings标签中

<settings>
      <setting name="XXX" value="XXX"/>
      ......
</settings>

配置项特别多，但自己使用过的比较少，记录下自己觉得能理解的：

1. cacheEnabled： 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。默认为true
2. lazyLoadingEnabled： 延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 ​​fetchType​​ 属性来覆盖该项的开关状态。默认为false
3. multipleResultSetsEnabled：是否允许单个语句返回多结果集（需要数据库驱动支持）。默认为true
4. useGeneratedKeys：允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键。尽管一些数据库驱动不支持此特性，但仍可正常工作（如 Derby）。默认为false
5. defaultStatementTimeout：设置超时时间，它决定数据库驱动等待数据库响应的秒数。可以设置为任意整数，默认未设置
6. safeRowBoundsEnabled： 是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false。默认为false
7. mapUnderscoreToCamelCase：是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。默认为false
8. localCacheScope：MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。 默认值为 SESSION，会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。默认为session
9. returnInstanceForEmptyRow：当返回行的所有列都是空时，MyBatis默认返回 ​​null​​。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2）。默认为false
10. logPrefix：指定 MyBatis 增加到日志名称的前缀。可以设置为任意字符串，默认未设置
11. logImpl：指定 MyBatis 所用日志的具体实现，未指定时将自动查找。SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING，默认未设置
12. shrinkWhitespacesInSql：从SQL中删除多余的空格字符。请注意，这也会影响SQL中的文字字符串。 (新增于 3.5.5)。默认为false

---

3、类型别名(typeAliases)

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。例如：

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

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

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

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

每一个在包 ​​domain.blog​​​ 中的 Java Bean，在没有注解的情况下，会使用 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

---

4、类型处理器(typeHandlers)

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

提示 从 3.4.5 开始，MyBatis 默认支持 JSR-310（日期和时间 API） 。

类型处理器	Java 类型	JDBC 类型
​​BooleanTypeHandler​​	​​java.lang.Boolean​​​, ​​boolean​​	数据库兼容的 ​​BOOLEAN​​
​​ByteTypeHandler​​	​​java.lang.Byte​​​, ​​byte​​	数据库兼容的 ​​NUMERIC​​​ 或 ​​BYTE​​
​​ShortTypeHandler​​	​​java.lang.Short​​​, ​​short​​	数据库兼容的 ​​NUMERIC​​​ 或 ​​SMALLINT​​
​​IntegerTypeHandler​​	​​java.lang.Integer​​​, ​​int​​	数据库兼容的 ​​NUMERIC​​​ 或 ​​INTEGER​​
​​LongTypeHandler​​	​​java.lang.Long​​​, ​​long​​	数据库兼容的 ​​NUMERIC​​​ 或 ​​BIGINT​​
​​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​​ 类型，用来存储枚举的序数值（而不是名称）。
​​SqlxmlTypeHandler​​	​​java.lang.String​​	​​SQLXML​​
​​InstantTypeHandler​​	​​java.time.Instant​​	​​TIMESTAMP​​
​​LocalDateTimeTypeHandler​​	​​java.time.LocalDateTime​​	​​TIMESTAMP​​
​​LocalDateTypeHandler​​	​​java.time.LocalDate​​	​​DATE​​
​​LocalTimeTypeHandler​​	​​java.time.LocalTime​​	​​TIME​​
​​OffsetDateTimeTypeHandler​​	​​java.time.OffsetDateTime​​	​​TIMESTAMP​​
​​OffsetTimeTypeHandler​​	​​java.time.OffsetTime​​	​​TIME​​
​​ZonedDateTimeTypeHandler​​	​​java.time.ZonedDateTime​​	​​TIMESTAMP​​
​​YearTypeHandler​​	​​java.time.Year​​	​​INTEGER​​
​​MonthTypeHandler​​	​​java.time.Month​​	​​INTEGER​​
​​YearMonthTypeHandler​​	​​java.time.YearMonth​​	​​VARCHAR​​​ 或 ​​LONGVARCHAR​​
​​JapaneseDateTypeHandler​​	​​java.time.chrono.JapaneseDate​​	​​DATE​​

你可以重写已有的类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。 具体做法为：实现 ​​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 元素）上增加一个 ​​javaType​​​ 属性（比如：​​javaType="String"​​）；
• 在类型处理器的类上增加一个 ​​@MappedTypes​​​ 注解指定与其关联的 Java 类型列表。 如果在 ​​javaType​​ 属性中也同时指定，则注解上的配置将被忽略。

可以通过两种方式来指定关联的 JDBC 类型：

• 在类型处理器的配置元素上增加一个 ​​jdbcType​​​ 属性（比如：​​jdbcType="VARCHAR"​​）；
• 在类型处理器的类上增加一个 ​​@MappedJdbcTypes​​​ 注解指定与其关联的 JDBC 类型列表。 如果在 ​​jdbcType​​ 属性中也同时指定，则注解上的配置将被忽略。

当在 ​​ResultMap​​​ 中决定使用哪种类型处理器时，此时 Java 类型是已知的（从结果类型中获得），但是 JDBC 类型是未知的。 因此 Mybatis 使用 ​​javaType=[Java 类型], jdbcType=null​​​ 的组合来选择一个类型处理器。 这意味着使用 ​​@MappedJdbcTypes​​​ 注解可以限制类型处理器的作用范围，并且可以确保，除非显式地设置，否则类型处理器在 ​​ResultMap​​​ 中将不会生效。 如果希望能在 ​​ResultMap​​​ 中隐式地使用类型处理器，那么设置 ​​@MappedJdbcTypes​​​ 注解的 ​​includeNullJdbcType=true​​ 即可。 然而从 Mybatis 3.4.0 开始，如果某个 Java 类型只有一个注册的类型处理器，即使没有设置 ​​includeNullJdbcType=true​​​，那么这个类型处理器也会是 ​​ResultMap​​ 使用 Java 类型时的默认处理器。

最后，可以让 MyBatis 帮你查找类型处理器：

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

注意在使用自动发现功能的时候，只能通过注解方式来指定 JDBC 的类型。

你可以创建能够处理多个类的泛型类型处理器。为了使用泛型类型处理器， 需要增加一个接受该类的 class 作为参数的构造器，这样 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;
  }java
  ...

---

批注：

类型处理器就是对Java类型和数据库字段类型的一个匹配操作。使用了类型处理器，它能够帮你智能的去识别一些属性类型，但是如果我们没有配置的，并且自己也没有去手动的指定，那么就会出现Java类型和数据库字段类型不匹配到导致的错误。

就像文档中所说：当在ResultMap中决定使用哪种类型处理器时，此时 Java 类型是已知的（从结果类型中获得），但是 JDBC 类型是未知的。 因此 Mybatis 使用javaType=[Java 类型], jdbcType=null的组合来选择一个类型处理器。自己在工作中进行数据类型的绑定时，也通常都是写一个字段，绑定一个类型，你可能看起来有些繁琐，但对代码后期的维护却是十分友好的，一但字段类型不匹配，我们就能快速的定位到问题，并改正。

自定义类型处理器的作用就是让我们的能够，在Java类型和数据库字段不匹配的时候依然能够进行关联持久化存储。如Java实体类是boolean，数据库字段是int，我们就可以指定相应的匹配规则，让1和true关联上，0和false关联上，继而让我们的代码更加的富有扩展性。

---

处理枚举类型

​​EnumTypeHandler​​​ 和 ​​EnumOrdinalTypeHandler​​ 都是泛型类型处理器，我们将会在接下来的部分详细探讨。

若想映射枚举类型 ​​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​​。

---

批注：

枚举类的类型处理器，用来处理实体类中的枚举类属性。结合前面提到的类型处理器，就能完整的处理我们Java数据类型和 数据库字段类型的对应问题了。

---

5、对象工厂(objectFactory)

每次 MyBatis 创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成实例化工作。 默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认无参构造方法，要么通过存在的参数映射来调用带有参数的构造方法。 如果想覆盖对象工厂的默认行为，可以通过创建自己的对象工厂来实现。比如：

// ExampleObjectFactory.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 方法。

---

6、插件(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})})

public class ExamplePlugin implements Interceptor {
  private Properties properties = new Properties();
  public Object intercept(Invocation invocation) throws Throwable {
    // implement pre processing if need
    Object returnObject = invocation.proceed();
    // implement post processing if need
    return returnObject;
  }
  public void setProperties(Properties properties) {
    this.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 的行为，务请慎之又慎。

---

7、环境配置(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);

environments 元素定义了如何配置环境。

<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 要匹配其中一个环境 ID。

---

批注：

我们可以在配置文件中添加多套环境，依次来应对开发中的各种情况。配置的方式就是在environments标签内部，添加一个environment组。比如：

当然，于此同时，我们需要在environments标签中表明我们使用的默认环境，以及配置对应的数据源和事务管理器。

---

事务管理器（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 {
  default void setProperties(Properties props) { // 从 3.5.2 开始，该方法为默认方法
    // 空实现
  }
  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;
  Integer getTimeout() throws SQLException;
}

使用这两个接口，你可以完全自定义 MyBatis 对事务的处理。

数据源（dataSource）

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

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

• 大多数 MyBatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源。

UNPOOLED– 这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。 性能表现则依赖于使用的数据库，对某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：

• ​​driver​​ – 这是 JDBC 驱动的 Java 类全限定名（并不是 JDBC 驱动中可能包含的数据源类）。
• ​​url​​ – 这是数据库的 JDBC URL 地址。
• ​​username​​ – 登录数据库的用户名。
• ​​password​​ – 登录数据库的密码。
• ​​defaultTransactionIsolationLevel​​ – 默认的连接事务隔离级别。
• ​​defaultNetworkTimeout​​​ – 等待数据库操作完成的默认网络超时时间（单位：毫秒）。查看 ​​java.sql.Connection#setNetworkTimeout()​​ 的 API 文档以获取更多信息。

作为可选项，你也可以传递属性给数据库驱动。只需在属性名加上“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 秒）。
• ​​poolMaximumLocalBadConnectionTolerance​​​ – 这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程。 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过 ​​poolMaximumIdleConnections​​​ 与 ​​poolMaximumLocalBadConnectionTolerance​​ 之和。 默认值：3（新增于 3.4.5）
• ​​poolPingQuery​​ – 发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动出错时返回恰当的错误消息。
• ​​poolPingEnabled​​​ – 是否启用侦测查询。若开启，需要设置 ​​poolPingQuery​​ 属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false。
• ​​poolPingConnectionsNotUsedFor​​ – 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。

JNDI – 这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的数据源引用。这种数据源配置只需要两个属性：

• ​​initial_context​​ – 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么将会直接从 InitialContext 中寻找 data_source 属性。
• ​​data_source​​ – 这是引用数据源实例位置的上下文路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。

和其他数据源配置类似，可以通过添加前缀“env.”直接把属性传递给 InitialContext。比如：

• ​​env.encoding=UTF8​​

这就会在 InitialContext 实例化时往它的构造方法传递值为 ​​UTF8​​​ 的 ​​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>

---

批注：

事务管理器和数据源是以一种可插拔的方式来更好的管理我们的与数据库之间的操作。当然对应的事务管理器和数据源我们都可以根据实际的场景进行自定义选择。

---

8、数据库厂商标识(databaseIdProvider)

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

<databaseIdProvider type="DB_VENDOR" />

databaseIdProvider 对应的 DB_VENDOR 实现会将 databaseId 设置为 ​​DatabaseMetaData#getDatabaseProductName()​​ 返回的字符串。 由于通常情况下这些字符串都非常长，而且相同产品的不同版本会返回不同的值，你可能想通过设置属性别名来使其变短：

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

在提供了属性别名时，databaseIdProvider 的 DB_VENDOR 实现会将 databaseId 设置为数据库产品名与属性中的名称第一个相匹配的值，如果没有匹配的属性，将会设置为 “null”。 在这个例子中，如果 ​​getDatabaseProductName()​​ 返回“Oracle (DataDirect)”，databaseId 将被设置为“oracle”。

你可以通过实现接口 ​​org.apache.ibatis.mapping.DatabaseIdProvider​​ 并在 mybatis-config.xml 中注册来构建自己的 DatabaseIdProvider：

public interface DatabaseIdProvider {
  default void setProperties(Properties p) { // 从 3.5.2 开始，该方法为默认方法
    // 空实现
  }
  String getDatabaseId(DataSource dataSource) throws SQLException;
}

---

9、映射器(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>

<!-- 使用完全限定资源定位符（URL） -->
<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 映射文件了，也就是接下来我们要讨论的。

---

批注：

mapper的配置，就好比让我们的MyBatis 知道，我们要去哪里找mapper映射文件，继而执行mapper文件中的SQL语句。他就像一个指路人，告诉你目标（mapper文件）在哪里。

配置的方式有四种，可以使用resource（资源定位）、url（文件定位）、class（类名定位）、name（包名定位）

---