1. properties

配置文件方式

这些属性可以在外部进行配置，并可以进行动态替换。

你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。

设置好的属性可以在整个配置文件中用来替换需要动态配置的属性值。

1
2
3
4
5
6
7
8
9
10
<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 元素中设置的相应值来替换，默认认为外部文件不存在username 和 password

driver 和 url 属性将会由 config.properties 文件中对应的值来替换。

Java代码方式

也可以在 SqlSessionFactoryBuilder.build() 方法中传入属性值

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

属性应用优先级

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

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

总结

  • 通过 方法参数传递 的属性具有最高优先级

  • resource 属性中指定的配置文件次之（.properties文件）

  • 最低优先级的则是 properties 元素（xml子元素）中指定的属性。

2. settings

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。

详情表格看文档

3. typeAliases(类型别名)

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，

意在降低冗余的全限定类名书写。

主要简化了，Mapper.xml中的参数或者返回类型时的书写

1
2
3
4
<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <package name="domain.blog"/>
</typeAliases>

每一个在包 domain.blog 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。

比如 domain.blog.Author 的别名为 author

可以使用注解设置Bean的别名，优先级高于包

1
2
@Alias("author")
public class Author {}

4.typeHandlers(类型处理器)

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

MyBatis有许多内建类型处理器：详情看文档

1
2
3
4
<typeHandlers>
    <typeHandler handler="com.bk.Main"/>
    <package name="com.bk"/>
</typeHandlers>

自定义类型处理器

你可以重写已有的类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。

具体做法为：

  • 或 实现 org.apache.ibatis.type.TypeHandler 接口

  • 或 继承 org.apache.ibatis.type.BaseTypeHandler类

  • 并且可以将它映射到一个 JDBC 类型（可选地）。

5.ObjectFactory(对象工厂)

每次 MyBatis 创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成实例化工作。

默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认无参构造方法，要么通过存在的参数映射来调用带有参数的构造方法。

如果想覆盖对象工厂的默认行为，可以通过创建自己的对象工厂并继承 DefaultObjectFactory 类 来实现。

然后在配置中配置即可

1
2
3
<objectFactory type="org.mybatis.example.ExampleObjectFactory">
  <property name="someProperty" value="100"/>
</objectFactory>

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)

使用插件，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。

且需要配置

1
2
3
4
5
<plugins>
  <plugin interceptor="org.mybatis.example.ExamplePlugin">
    <property name="someProperty" value="100"/>
  </plugin>
</plugins>

7. environments(环境配置)

可以配置成适应多种环境，这种机制有助于将 SQL 映射 应用于多种数据库之中

现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置

尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境

如果你想连接两个数据库，就需要创建两个 SqlSessionFactory 实例

配置详情

一个环境 = 事务管理器 + 数据源 ，可配置多个环境

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<environments default="dev"><!-- 选择了开发环境 -->
    
  <environment id="dev"> <!-- 开发环境 -->
      
    <transactionManager type="JDBC"> <!-- 事务管理器类型为JDBC -->
      <property name="..." value="..."/>
    </transactionManager>
      
    <dataSource type="POOLED"><!-- 数据源类型为POOLELD -->
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
      
  </environment>
    
  <environment id="pro"><!-- 生产环境 -->
      ....
  </environment>
</environments>

注意：

  • 默认使用的环境 ID（比如：default=”dev”）。
  • 每个 environment 元素定义的环境 ID（比如：id=”dev”）。
  • 事务管理器的配置（比如：type=”JDBC”）。
  • 数据源的配置（比如：type=”POOLED”）。

transactionManager(事务管理器)

在 MyBatis 中有两种类型的事务管理器

  • JDBC

    • 这个配置直接使用了 JDBC 的提交和回滚功能，它依赖从数据源获得的连接来管理事务作用域。默认情况下，为了与某些驱动程序兼容，它在关闭连接时启用自动提交。

  • MANAGED

    • 这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接。

如果你正在使用 Spring + MyBatis，则 没有必要配置事务管理器，因为 Spring 模块会使用自带的管理器来覆盖前面的配置。

dataSource(数据源)

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

有三种内建的数据源类型：

1. UNPOOLED

这个数据源的实现会每次请求时打开和关闭连接。

虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。

性能表现则依赖于使用的数据库，对某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。

UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：

  • driver – 这是 JDBC 驱动的 Java 类全限定名（并不是 JDBC 驱动中可能包含的数据源类）。
  • url – 这是数据库的 JDBC URL 地址。
  • username – 登录数据库的用户名。
  • password – 登录数据库的密码。
  • defaultTransactionIsolationLevel – 默认的 连接事务隔离级别。
  • defaultNetworkTimeout – 等待 数据库操作 完成的 默认网络超时时间（单位：毫秒）。
2. 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 时适用）。
3. JNDI(Java Naming and Directory Interface)

Java命名和目录接口的缩写。它是Java平台提供的一个标准API，用于访问各种命名和目录服务。JNDI可以用于在Java应用程序中查找和访问命名资源，如数据库连接、JMS队列、LDAP目录等。

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

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

你可以通过实现接口 org.apache.ibatis.datasource.DataSourceFactory 来使用第三方数据源实现

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

MyBatis 可以根据不同的数据库厂商执行不同的语句

这种多厂商的支持 是 基于映射语句中的 databaseId 属性。

MyBatis 会加载带有匹配当前数据库 databaseId 属性和所有不带 databaseId 属性的语句。

如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。

9. mappers (映射器)

告诉 MyBatis 到哪里去找到定义的 SQL 映射语句

可以使用

  • 相对于类路径的资源引用
  • 完全限定资源定位符（包括 file:/// 形式的 URL）
  • 类名
  • 包名
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
<!-- 常用 -->
<!-- 使用映射器接口实现类的 完全限定类名 -->
<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>

<!-- 不常用 -->
<!-- 使用相对于类路径的资源引用 -->
<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>