深入了解 MyBatis :详解配置

这是我的 MyBatis 学习笔记的第二篇:深入了解 MyBatis 之详解配置。


mybatis-config.xml

通常我们约定 MyBatis 的全局配置文件命名为 mybatis-config.xml

在对 mybatis-config.xml 进行配置的时候首先要遵循它的配置顺序规则:

  • properties(属性)
  • settings(设置)
  • typeAliases(类型别名)
  • typeHandlers(类型处理器)
  • objectFactory(对象工厂)
  • plugins(插件)
  • environments(环境配置)
  • databaseIdProvider(数据库厂商标识)
  • mappers(映射器)

下面来讲解几个比较重点的:

mybatis-config.xml:properties(属性)

1
2
3
4
5
<!-- 可以在外部进行配置,并可以进行动态替换 -->
<properties resource="jdbc.properties">
<property name="jdbc.driver" value="com.mysql.jdbc.Driver"/>
<property name="jdbc.url" value="jdbc:mysql://localhost:3306/test"/>
</properties>

当我们先使用了 property 来设置了属性之后,就可以使用 ${property_name} 来取值,而不用再使用全类名的方式:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?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 resource="jdbc.properties">
<property name="jdbc.driver" value="com.mysql.jdbc.Driver"/>
<property name="jdbc.url" value="jdbc:mysql://localhost:3306/test"/>
</properties>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!-- 从 </property> 获取 -->
<property name="driver" value="${jdbc.driver}"/>
<!-- 从 </property> 获取 -->
<property name="url" value="${jdbc.url}"/>
<!-- 从 </properties> 中的 resource 获取 -->
<property name="username" value="${jdbc.user}"/>
<!-- 从 </properties> 中的 resource 获取 -->
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="UserMapper.xml"/>
</mappers>
</configuration>


mybatis-config.xml:settings(设置)

1
2
3
4
5
6
7
8
9
10
11
<!-- 改变 MyBatis 的运行时行为 -->
<settings>
<!-- 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存 默认值: true -->
<setting name="cacheEnabled" value="true"/>
<!-- 允许 JDBC 支持自动生成主键,需要数据库驱动支持 默认值: false -->
<setting name="useGeneratedKeys" value="true"/>
<!-- 是否开启驼峰命名自动映射 默认值: false -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
<!-- 设置超时时间,它决定数据库驱动等待数据库响应的秒数 默认值: false -->
<setting name="defaultStatementTimeout" value="true"/>
</settings>

设置 描述
cacheEnabled 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。 true(默认)
false
lazyLoadingEnabled 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。
特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。
true
false(默认)
aggressiveLazyLoading 是否允许单个语句返回多结果集(需要数据库驱动支持)。 true
false(默认)
multipleResultSetsEnabled 是否允许单个语句返回多结果集(需要数据库驱动支持)。 true(默认)
false
useColumnLabel 使用列标签代替列名。
实际表现依赖于数据库驱动,具体可参考数据库驱动的相关文档,或通过对比测试来观察。
true(默认)
false
useGeneratedKeys 允许 JDBC 支持自动生成主键,需要数据库驱动支持。如果设置为 true,将强制使用自动生成主键。
尽管一些数据库驱动不支持此特性,但仍可正常工作(如 Derby)。
true
false(默认)
autoMappingBehavior 指定 MyBatis 应如何自动映射列到字段或属性。
NONE 表示关闭自动映射;
PARTIAL 只会自动映射没有定义嵌套结果映射的字段;
FULL 会自动映射任何复杂的结果集(无论是否嵌套)。
NONE
PARTIAL(默认)
FULL
autoMappingUnknownColumnBehavior 指定发现自动映射目标未知列(或未知属性类型)的行为。
NONE: 不做任何反应
WARNING: 输出警告日志
FAILING: 映射失败 (抛出 SqlSessionException)
NONE(默认)
WARNING
FAILING
defaultExecutorType 配置默认的执行器。
SIMPLE 就是普通的执行器;
REUSE 执行器会重用预处理语句(PreparedStatement);
BATCH 执行器不仅重用语句还会执行批量更新。
SIMPLE(默认)
REUSE
BATCH
defaultStatementTimeout 设置超时时间,它决定数据库驱动等待数据库响应的秒数。 任意正整数
默认未设置 (null)
defaultFetchSize 为驱动的结果集获取数量(fetchSize)设置一个建议值。此参数只可以在查询设置中被覆盖。 任意正整数
默认未设置 (null)
safeRowBoundsEnabled 是否允许在嵌套语句中使用分页(RowBounds)。如果允许使用则设置为 false。 true
false(默认)
safeResultHandlerEnabled 是否允许在嵌套语句中使用结果处理器(ResultHandler)。如果允许使用则设置为 false。 true(默认)
false
mapUnderscoreToCamelCase 是否开启驼峰命名自动映射,即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。 true
false(默认)
localCacheScope MyBatis 利用本地缓存机制(Local Cache)防止循环引用和加速重复的嵌套查询。
默认值为 SESSION,会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT,本地缓存将仅用于执行语句,对相同 SqlSession 的不同查询将不会进行缓存。
SESSION(默认)
STATEMENT
jdbcTypeForNull 当没有为参数指定特定的 JDBC 类型时,空值的默认 JDBC 类型。
某些数据库驱动需要指定列的 JDBC 类型,多数情况直接用一般类型即可。
比如 NULL、VARCHAR 或 OTHER。
NULL
VARCHAR
OTHER(默认)
lazyLoadTriggerMethods 指定对象的哪些方法触发一次延迟加载。 用逗号分隔的方法列表
equals
clone
hashCode
toString
defaultScriptingLanguage 指定动态 SQL 生成使用的默认脚本语言。 一个类型别名或全限定类名
XMLLanguageDriver
defaultEnumTypeHandler 指定 Enum 使用的默认 TypeHandler 一个类型别名或全限定类名
EnumTypeHandler
callSettersOnNulls 指定当结果集中值为 null 的时候是否调用映射对象的 setter(map 对象时为 put)方法,这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型(int、boolean 等)是不能设置成 null 的。 true
false(默认)
returnInstanceForEmptyRow 当返回行的所有列都是空时,MyBatis默认返回 null
当开启这个设置时,MyBatis会返回一个空实例。
请注意,它也适用于嵌套的结果集(如集合或关联)。
true
false(默认)
logPrefix 指定 MyBatis 增加到日志名称的前缀。 任何字符串
默认未设置 (null)
logImpl 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。 SLF4J
LOG4J
LOG4J2
JDK_LOGGING
COMMONS_LOGGING
STDOUT_LOGGING
NO_LOGGING
默认未设置
proxyFactory 指定 Mybatis 创建可延迟加载对象所用到的代理工具。 CGLIB
JAVASSIST(默认)
vfsImpl 指定 VFS 的实现 自定义 VFS 的实现的类全限定名,以逗号分隔。
默认未设置
useActualParamName 允许使用方法签名中的名称作为语句参数名称。
为了使用该特性,你的项目必须采用 Java 8 编译,并且加上 -parameters 选项。
true(默认)
false
configurationFactory 指定一个提供 Configuration 实例的类。
这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。
这个类必须包含一个签名为static Configuration getConfiguration() 的方法。
一个类型别名或完全限定类名。
默认未设置

一个官方的配置完整的 settings 元素的示例如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<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>


mybatis-config.xml:typeAliases(类型别名)

1
2
3
4
5
6
7
<!-- 使用 typeAlias 元素可以让 mapper.xml 文件中需要填写的全类名能用短写代替 -->
<typeAliases>
<typeAlias type="com.peterxx.manager.mapper.UserMapper" alias="UserMapper"/>
<typeAlias type="com.peterxx.manager.mapper.OrderMapper" alias="OrderMapper"/>
<typeAlias type="com.peterxx.manager.mapper.HistoryMapper" alias="HistoryMapper"/>
<typeAlias type="com.peterxx.manager.mapper.LotteryMapper" alias="LotteryMapper"/>
</typeAliases>


mybatis-config.xml:typeHandlers(类型处理器)

类型处理器的作用是 MyBatis 在设置预处理语句(PreparedStatement)中的参数或从结果集中取出一个值时, 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。


mybatis-config.xml:environments(环境配置)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<!-- 使用 environment 配置多个环境 使用 default 指定默认 -->
<environments default="dev">
<environment id="dev">
<!--
JDBC : 这个配置直接使用了 JDBC 的提交和回滚设施,它依赖从数据源获得的连接来管理事务作用域
MANAGED : 这个配置几乎没做什么。它从不提交或回滚一个连接
-->
<transactionManager type="JDBC"/>
<!--
UNPOOLED : 这个数据源的实现会每次请求时打开和关闭连接
POOLED : 复用连接池
-->
<dataSource type="POOLED">
<!-- 从 </property> -->
<property name="driver" value="${jdbc.driver}"/>
<!-- 从 </property> -->
<property name="url" value="${jdbc.url}"/>
<!-- 从 </properties> 中的 resource -->
<property name="username" value="${jdbc.user}"/>
<!-- 从 </properties> 中的 resource -->
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>

<environment id="prod">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.prod.driver}"/>
<property name="url" value="${jdbc.prod.url}"/>
<property name="username" value="${jdbc.prod.user}"/>
<property name="password" value="${jdbc.prod.password}"/>
</dataSource>
</environment>

<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.test.driver}"/>
<property name="url" value="${jdbc.test.url}"/>
<property name="username" value="${jdbc.test.user}"/>
<property name="password" value="${jdbc.test.password}"/>
</dataSource>
</environment>
</environments>


mybatis-config.xml:mappers(映射器)

1
2
3
4
5
6
7
8
9
<!-- mapper 注册 mapper.xml -->
<mappers>
<!-- 使用相对于类路径的资源引用 -->
<mapper resource="com/peterxx/manager/mapper/UserMapper.xml"/>
<!-- 使用完全限定资源定位符(URL) -->
<mapper url="file:///var/mappers/UserMapper.xml"/>
<!-- 使用映射器接口实现类的完全限定类名 -->
<mapper class="com.peterxx.manager.mapper.UserMapper"/>
</mappers>


XXMapper.xml

通常约定命名为 XXMapper.xml ,XX 对应 POJO 名称,也可以说是对应数据库表名称。

e.g. UserMapper.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.peterxx.manager.mapper.UserMapper">
<!--
在 SQL 中使用 #{} 传递参数,会使用 ? 进行占位,再填充得到完整的 SQL
也就是对应 JDBC 中的 PreparedStatement 进行执行
这时候 {} 里面填充的是参数名称 e.g. #{uid}
-->
<!--
在 SQL 中使用 ${} 传递参数,会使用拼接的方式得到完整的 SQL
也就是对应 JDBC 中的 Statement 进行执行
这时候 {} 里面填充的是 value e.g. ${value}
-->
<!-- 推荐使用 #{} 传递参数 -->
<select id="getUser" resultType="com.peterxx.domain.User">
SELECT *
FROM t_user
WHERE uid = #{uid}
</select>
</mapper>

主要的配置内容说明:

</mapper> 标签:namespace 属性填写该 XML 文件对应接口的全类名

</mapper> 标签内的顶级标签: </mapper> 里的顶级标签共以下几种:

SQL 类型标签
  1. cache : 该命名空间的缓存配置

  2. cache-ref : 引用其它命名空间的缓存配置

  3. parameterMap : 描述如何进行参数映射(即将作废)

  4. resultMap : 描述如何从数据库结果集中加载对象,是最复杂也是最强大的元素

  5. insert : 插入类型 SQL

  6. delete : 删除类型 SQL

  7. select : 查询类型 SQL

  8. update : 更新类型 SQL

  9. sql : 可被其它语句引用的可重用语句块

当中用的最多的是 select ,针对 select 可以设置的属性有很多,以下列举部分:

属性 描述
id 在命名空间中唯一的标识符,可以被用来引用这条语句。
通常直接绑定 Mapper 接口中的方法名。
parameterType 将会传入这条语句的参数的类全限定名或别名。
这个属性是可选的,因为 MyBatis 可以通过类型处理器(TypeHandler)推断出具体传入语句的参数,默认值为未设置(unset)。
resultType 期望从这条语句中返回结果的类全限定名或别名。
注意,如果返回的是集合,那应该设置为集合包含的类型,而不是集合本身的类型。
resultType 和 resultMap 之间只能同时使用一个。
resultMap 对外部 resultMap 的命名引用。
结果映射是 MyBatis 最强大的特性,如果你对其理解透彻,许多复杂的映射问题都能迎刃而解。
resultType 和 resultMap 之间只能同时使用一个。
flushCache 将其设置为 true 后,只要语句被调用,都会导致本地缓存和二级缓存被清空。
默认值:false。
useCache 将其设置为 true 后,将会导致本条语句的结果被二级缓存缓存起来。
默认值:对 select 元素为 true。
statementType 可选 STATEMENT,PREPARED 或 CALLABLE。
这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement。
默认值:PREPARED。

insertupdatedelete 也有不少可设置的属性,部分如下(只列出与 select 没有重合的部分)

属性 描述
useGeneratedKeys 这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键(仅适用于 insert 和 update)。
默认值:false。
比如:像 MySQL 和 SQL Server 这样的关系型数据库管理系统的自动递增字段。
keyProperty 指定能够唯一识别对象的属性。
默认值:未设置(unset)。
如果生成列不止一个,可以用逗号分隔多个属性名称。
MyBatis 会使用 getGeneratedKeys 的返回值或 insert 语句的 selectKey 子元素设置它的值。

useGeneratedKeys 和 keyProperty 的相关示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
<!-- 手动指定 id 插入数据 -->
<insert id="insertAuthor">
insert into Author (id,username,password,email,bio)
values (#{id},#{username},#{password},#{email},#{bio})
</insert>
...
<!-- 使用数据库 id 自增 -->
<insert id="insertAuthor"
useGeneratedKeys="true"
keyProperty="id">
insert into Author (username,password,email,bio)
values (#{username},#{password},#{email},#{bio})
</insert>


相关阅读

MyBatis 快速入门

深入了解 MyBatis :ResultMap

深入了解 MyBatis :动态 SQL

深入了解 MyBatis :缓存

深入了解 MyBatis :ResultMap MyBatis 快速入门

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×