文件结构

示例

<?xml version="1.0" encoding="UTF-8" ?>
<!--DTD约束-->
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!--
        1.environments配置数据库的环境，环境可以有多个
        2.default属性指定使用的环境
    -->
    <environments default="development">
        <!--
            1.environment配置具体某个数据库的环境
            2.id属性唯一标识这个环境
        -->
        <environment id="development">
            <!--
                1.transactionManager设置事务管理方式
                2.type属性取值有“JDBC|MANAGED”
                3.JDBC指当前环境中使用的是JDBC中原生的事务管理方式，事务的提交或回滚需要手动处理
                4.MANAGED指被管理，例如Spring中
            -->
            <transactionManager type="JDBC"/>
            <!--
                1.dataSource配置数据源
                2.取值有"POOLED|UNPOOLED|JNDI"
                3.POOLED表示使用数据库连接池缓存数据库连接
                4.UNPOOLED：表示不使用数据库连接池
                5.JNDI表示使用上下文中的数据源
            -->
            <dataSource type="POOLED">
                <!--设置链接数据库的驱动-->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <!--设置连接数据库的地址-->
                <property name="url" value="jdbc:mysql://localhost:3306/ssm"/>
                <!--设置连接数据库的用户名-->
                <property name="username" value="root"/>
                <!--设置连接数据库的密码-->
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <!--mappers用于引入映射的配置文件-->
    <mappers>
        <!--mapper用于指定某个映射文件，resource属性指定文件路径-->
        <mapper resource="mappers/UserMapper.xml"/>
    </mappers>
</configuration>

配置结构

configuration（配置）
- properties（属性）
- settings（设置）
- typeAliases（类型别名）
- typeHandlers（类型处理器）
- objectFactory（对象工厂）
- plugins（插件）
- environments（环境配置）
  - environment（环境变量）
    - transactionManager（事务管理器）
    - dataSource（数据源）
- databaseIdProvider（数据库厂商标识）
- mappers（映射器）

标签详解

属性（properties）

用于引入某个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>

这个例子中的 username 和 password 将会由 properties 元素中设置的相应值来替换。 driver 和 url 属性将会由 config.properties 文件中对应的值来替换。这样就为配置提供了诸多灵活选择。

也可以在 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 元素中指定的属性。

设置（settings）

官方文档

类型别名（typeAliases）

用于为某个类的全类名设置别名，子标签是<typeAlias>
一个子标签对应设置一个类的别名
子标签下有type和alias两个属性，type指定需要设置别名的类的全类名，alias指定别名
如果只设置了type属性，那么默认的别名就是它的类名（不是全类名）而且不区分大小写

1
2
3

<typeAliases>
    <typeAlias type="com.cyan.pojo.User" alias="User"/>
</typeAliases>

如果想要设置某个包下所有类的别名，可以使用<package>标签，用name属性指定包名 (扫描实体类的包，它的默认名为该类的类名，首字母小写)

1
2
3

<typeAliases>
    <package name="com.cyan.pojo"/>
</typeAliases>

MyBatis中内建了一些类型的别名

Java类型	别名
int	_int 或 _integer
Integer	int或integer
String	string
List	list
Map	map

<property>标签

用于配置连接数据库时用到的各种属性,是一个单标签
该标签有两个属性，一个是name指定属性名，另一个是value指定属性值
如果不使用<properties>标签引入相关配置文件时，使用方式如下
1
<property name="driver" value="com.mysql.jdbc.Driver" />
如果使用<properties>标签引入相关的配置文件时，value属性可以写成如下形式
1
<property name="driver" value="${jdbc.driver}" />
其中配置文件的内容是
1
jdbc.driver=com.mysql.jdbc.Driver
注意：这里使用jdbc.driver来给键命名是因为核心配置文件中可能会引入其他的配置文件，如果使用driver来命名键的话有可能会跟其他配置文件中的键同名而产生冲突

映射器（mappers）

该标签用于引入映射文件，每个映射文件使用子标签<mapper>来表示，该子标签是一个单标签，可以使用相对于类路径的资源引用，或完全限定资源定位符（包括 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）

<!-- 使用完全限定资源定位符（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>

环境配置

尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。 如果你想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，总之每个数据库对应一个SqlSesstionFactory

为了指定创建哪种环境，只要将它作为可选的参数传递给 SqlSessionFactoryBuilder 即可。可以接受环境配置的两个方法签名是：

1 2	SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

如果忽略了环境参数，那么将会加载默认环境，如下所示：

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

<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”）。

事务管理器（transactionManager）

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

事务管理器	说明
JDBC	直接使用了 JDBC 的提交和回滚功能，它依赖从数据源获得的连接来管理事务作用域。
MANAGED	它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。

JDBC : 默认情况下，为了与某些驱动程序兼容，它在关闭连接时启用自动提交。可以通过将 “skipSetAutoCommitOnClose” 属性设置为 “true” 来跳过这个步骤

1
2
3

<transactionManager type="JDBC">
  <property name="skipSetAutoCommitOnClose" value="true"/>
</transactionManager>

MANAGED

默认情况下它会关闭连接。然而一些容器并不希望连接被关闭，因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为

1
2
3

<transactionManager type="MANAGED">
  <property name="closeConnection" value="false"/>
</transactionManager>

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

数据源（dataSource）

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源，有三种内建的数据源类型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）：

UNPOOLED

这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。

属性	说明
`driver`	JDBC 驱动的 Java 类全限定名
`url`	数据库的 JDBC URL 地址
`username`	登录数据库的用户名
`password`	登录数据库的密码
`defaultTransactionIsolationLevel`	默认的连接事务隔离级别
`defaultNetworkTimeout`	等待数据库操作完成的默认网络超时时间
`driver.encoding=UTF8`	通过 DriverManager.getConnection(url, driverProperties) 方法传递值为 `UTF8` 的 `encoding` 属性给数据库驱动。

POOLED

数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。这种处理方式很流行，能使并发 Web 应用快速响应请求。

属性	说明
`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 中查找。

属性

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
username=xxx
password=xxx
driver=com.mysql.jdbc.Driverurl=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8username=rootpassword=root

1 2	<!--引入外部配置文件--> <properties resource="db.properties"/>

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>