MyBatis 中 SqlMapConfig 配置文件详解

0x00：文件介绍

在 WEB 工程中，对于 MyBatis 最核心的全局配置文件是 SqlMapConfig.xml 文件，其中包含了数据库的连接配置信息、Mapper 映射文件的加载路径、全局参数、类型别名等。

0x01：配置项详解

configuration：包裹所有配置标签，是整个配置文件的顶级标签。

properties：属性，该标签可以引入外部配置的属性，也可以自己配置。该配置标签所在的同一个配置文件中的其他配置均可引用此配置中的属性。

setting：全局配置参数，用来配置一些改变运行时行为的信息，例如是否使用缓存机制，是否使用延迟加载，是否使用错误处理机制等。并且可以设置最大并发请求数量、最大并发事务数量，以及是否启用命令空间等。

typeAliases：类型别名，用来设置一些别名来代替 Java 的长类型声明，如 java.lang.int 变为 int，减少配置编码的冗余。

typeHandlers：类型处理器，将 sql 中返回的数据库类型转换为相应 Java 类型的处理器配置。

objectFactory：对象工厂，实例化目标类的工厂类配置。

plugins：插件，可以通过插件修改 MyBatis 的核心行为，例如对语句执行的某一点进行拦截调用。

environments：环境集合属性对象，数据库环境信息的集合。在一个配置文件中，可以有多种数据库环境集合，这样使 MyBatis 将 sql 同时映射至多个数据库。

environment：环境子属性对象，数据库环境配置的详细配置。

transactionManager：事务管理，指定 MyBatis 的事务管理器。

dataSource：数据源，使其中的 type 指定数据源的连接类型，在标签对中可以使用 property 属性指定数据库连接池的其他信息。

mappers：映射器，配置 sql 映射文件的位置，告知 MyBatis 去哪里加载 sql 映射配置。

0x02：代码示例

<?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> 
  <!-- 1.properties属性引入外部配置文件 -->
  <properties resource="org/mybatis/example/config.properties">
    <!-- property里面的属性全局均可使用 -->
    <property name="username" value="root"/>
    <property name="password" value="root"/>
  </properties>
  <!-- 2.全局配置参数 -->
  <settings>
    <!-- 设置是否启用缓存 -->
    <setting name="cacheEnabled" value="true"/>
    <!-- 设置是否启用懒加载 -->
    <setting name="lazyLoadingEnabled" value="true"/>  
  </settings>
  <!-- 3.别名设置 -->
  <typeAliases>
    <typeAlias alias="student" type="cn.com.mybatis.student"/>
    <typeAlias alias="teacher" type="cn.com.mybatis.teacher"/>
    <typeAlias alias="integer" type="java.lang.Integer"/>
  </typeAliases>
  <!-- 4.类型转换器 -->
  <typeHandlers>
    <!-- 一个简单类型转换器 -->
    <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
  </typeHandlers>
  <!-- 5.对象工厂 -->
  <objectFactory type="org.mybatis.example.ExampleObjectFactory">
    <!-- 对象工厂注入的参数 -->
    <property name="someProperty" value="100"/>
  </objectFactory>
  <!-- 6.插件 -->
  <plugins>
    <plugin interceptor="org.mybatis.example.ExamplePlugin">
      <property name="someProperty" value="100"/>
    </plugin>
  </plugins>
  <!-- 7.environments数据库环境配置 -->
  <!-- 和Spring整合后environments配置将被废除 -->
  <environments default="development"> 
    <environment id="development"> 
      <!-- 使用JDBC事务管理 -->
      <transactionManager type="JDBC" /> 
      <!-- 数据库连接池 -->
      <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>
  <!-- 加载映射文件 -->
  <mappers> 
    <mapper resource="sqlmap/UserMapper.xml"/>
    <mapper resource="sqlmap/OtherMapper，.xml"/>
  </mappers> 
</configuration>

0x03：总结

对于 MyBatis 的核心配置文件，有些不常用的标签也可以不用死记硬背，了解常用的即可，不常用的需要用时可查看帮助文档。