MyBatis 的配置文件包含了影响 MyBatis 行为甚深的设置(settings)和属性(properties)信息。
文档的顶层结构如下:
- configuration 配置
- properties 属性
- settings 设置
- typeAliases 类型命名
- typeHandlers 类型处理器
- objectFactory 对象工厂
- plugins 插件
- environments 环境
- environment 环境变量
- transactionManager 事务管理器
- dataSource 数据源
- environment 环境变量
- databaseIdProvider 数据库厂商标识
- mappers 映射器
mybatis 的 XML 配置文件中元素的放置有时需要按一定的先后顺序,所以最好按上面的结构进行配置
加载外部 properties 配置文件 —— properties
元素的配置如下:
一旦配置后,就可以加载对应 resource
属性中指定的 properties 键值对。如添加一个 jdbc.properties :
mysql.driver=com.mysql.jdbc.Driver
mysql.url=jdbc:mysql://localhost:3306/mybatis_test?characterEncoding=utf-8
mysql.username=root
mysql.password=123456
在 mybatis 的 XML 配置文件的
元素下添加
子元素,即可在配置文件引用 properties 文件中对应 key 的值,用来替换需要动态配置的属性值。
如前面的XML 配置文件可修改如下:
PS:properties 除了上述的加载方式,还可:1. 在创建 SqlSessionFactory 实例过程中的 SqlSessionFactoryBuilder 实例的 build 方法中作为参数传进去;2. 作为
元素的子元素
设置加载。三种方式的加载优先级从高到低为:通过方法参数传递 > resource
属性中指定的配置文件 >
元素的子元素
MyBatis 中的调整设置 —— settings
settings 是 MyBatis 中极为重要的调整设置或全局设置,它们会改变 MyBatis 的运行时行为。如下为完整的设置内容和对应的默认值
为 Java 类设置别名 —— typeAliases
类型别名是为 Java 类型设置一个短的名字。它只和 XML 映射文件有关,存在的意义仅在于用来减少类完全限定名的冗余。
修改上述 mybatis 的 XML 配置文件,为 Javabean User 增加
:
则上文的映射文件 UserMapper.xml 中 元素的
resultType
属性可修改为 resultType="User"
PS1:亦可在
中指定报名包名,则在该包中添加了 @Alias("xxx")
注解的类会添加相应的别名
@Alias("User")
public class User {
...
}
在没有注解的情况下,会使用 Bean 的首字母小写的非限定类名来作为它的别名(如 user )。若有注解,则别名为其注解值。
PS2:mybatis 亦内置了常见的 Java 类型内建的类型别名,如前面的 XML 映射文件中 元素的
resultType
属性用到的 hashmap。完整常见的 Java 类型内建的类型别名见 附录 - 常见的 Java 类型内建的类型别名
配置环境 —— environments
元素可包含多个
子元素,每个子元素代表一种连接的配置,前面提到
元素的配置大致如下:
每个
子元素需要配置 事务管理器(transactionManager)、数据源(dataSource)
事务管理器(transactionManager)
在 MyBatis 中有两种类型的事务管理器(也就是 type="[JDBC|MANAGED]"):
- JDBC – 这个配置就是直接使用了 JDBC 的提交和回滚设置,它依赖于从数据源得到的连接来管理事务作用域。
- MANAGED – 这个配置几乎没做什么。它从来不提交或回滚一个连接,而是让容器来管理事务的整个生命周期。 默认情况下它会关闭连接,然而一些容器并不希望这样,因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。
PS:如果使用 Spring + MyBatis,则没有必要配置事务管理器, 因为 Spring 模块会使用自带的管理器来覆盖前面的配置
数据源(dataSource)
dataSource
元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。
有三种内建的数据源类型(也就是 type="[UNPOOLED|POOLED|JNDI]"):
- UNPOOLED– 这个数据源的实现只是每次被请求时打开和关闭连接。虽然一点慢,它对在及时可用连接方面没有性能要求的简单应用程序是一个很好的选择。 不同的数据库在这方面表现也是不一样的,所以对某些数据库来说使用连接池并不重要,这个配置也是理想的。
UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性:- driver – 这是 JDBC 驱动的 Java 类的完全限定名
- url – 这是数据库的 JDBC URL 地址
- username – 登录数据库的用户名
- password – 登录数据库的密码
- defaultTransactionIsolationLevel – 默认的连接事务隔离级别
- driver.encoding=UTF8 ( 作为可选项,你也可以传递属性给数据库驱动 )
- 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.encoding=UTF8 ( 可以通过添加前缀“env.”直接把属性传递给初始上下文 )
映射器 —— mappers
有两种方式可加载 XML 映射文件,以及有两种方式可加载映射类
从 classpath 加载 XML 映射文件
从完全限定资源定位符(包括 file:/// 的 URL) 加载 XML 映射文件
从 classpath 加载映射类
扫描包加载映射类
typeHandlers(未完成)
无论是 MyBatis 在预处理语句(PreparedStatement)中设置一个参数时,还是从结果集中取出一个值时, 都会用类型处理器将获取的值以合适的方式转换成 Java 类型
一些默认的类型处理器:
类型处理器 | Java 类型器 | JDBC 类型 |
---|---|---|
row 1 col 1 | row 1 col 2 | row 1 col 2 |
自定义类型处理器:实现 TypeHandler 接口,或继承 BaseTypeHandler 类
对象工厂(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 constructorArgTypes, List
插件(plugins)(未完成)
MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用
默认情况下,MyBatis 允许使用插件来拦截的方法调用包括:
- Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)
使用插件只需实现 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) {
}
}
上面的插件将会拦截在 Executor 实例中所有的 “update” 方法调用, 这里的 Executor 是负责执行低层映射语句的内部对象
databaseIdProvider (未完成)
MyBatis 可以根据不同的数据库厂商执行不同的语句,这种多厂商的支持是基于映射语句中的 databaseId 属性
附录
常见的 Java 类型内建的类型别名
别名 | 映射的类型 |
---|---|
_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 |