MyBatis学习总结（三）：MyBatis配置文件与常用标签

       MyBatis 配置文件与常见属性如下所示：

<?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 /><!-- 属性 -->
    <settings /><!-- 设置 -->
    <typeAliases /><!-- 类型命名 -->
    <typeHandlers /><!-- 类型处理器 -->
    <objectFactory /><!-- 对象工厂 -->
    <plugins /><!-- 插件 -->
    <environments><!-- 配置环境 -->
        <environment><!-- 环境变量 -->
            <transactionManager /><!-- 事务管理器 -->
            <dataSource /><!-- 数据源 -->
        </environment>
    </environments>
    <databaseIdProvider /><!-- 数据库厂商标识 -->
    <mappers /><!-- 映射器 -->
</configuration>

       在上述的配置项中，properties、settings、typeAliases、typeHandler、plugin、environments、mappers是比较常用的。本文将针对一些常用属性进行介绍。

注意：上述配置项的顺序不能颠倒。

1、properties属性

（1）说明

       properties属性用来引入外部properties配置文件的内容。以数据库基本信息的配置为例，如果将连接数据库的4个基本信息编写在MyBatis的主配置文件中，这种方式属于内部配置，且不需要使用properties属性。同样，也可以选择外部配置的方式，只要我们通过properties标签来引用外部配置文件信息即可。

外部配置有两种方式：

resource：引入类路径下的资源，例如：resource="jdbcConfig.properties"

url：引入网络路径或者磁盘下的路径，例如：url="file:///D:\Java\mybatis\jdbcConfig.properties"

（2）使用方式

       与enviroments结合使用。

       resource下的jdbcConfig.properties文件

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=root

       sqlMapConfig.xml

<?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>
	<!-- 
		mybatis可以使用properties来引入外部properties配置文件的内
	 -->
	<properties resource="jdbcConfig.properties"></properties>
    <!--
        使用url    
    <properties url="file:///D:\Java\mybatis\jdbcConfig.properties"></properties>
    -->

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

</configuration>

2、settings属性

（1）说明

       settings属性会改变 MyBatis 的运行时行为，如：自动映射、驼峰命名映射、级联规则、是否启动缓存、执行器（Executor）类型等。大部分情况下使用默认值便可以运行，所以在大部分情况下不需要大量配置它，只需要修改一些常用的规则即可。settings 配置项说明如下：

配置项	作用	配置选项	默认值
cacheEnabled	该配置影响所有映射器中配置缓存的全局开关	true|false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。在特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态	true|false	false
aggressiveLazyLoading	当启用时，对任意延迟属性的调用会使带有延迟加载属性的对象完整加载；反之，每种属性将会按需加载	true|felse	版本3.4.1 （不包含） 之前 true，之后 false
multipleResultSetsEnabled	是否允许单一语句返回多结果集（需要兼容驱动）	true|false	true
useColumnLabel	使用列标签代替列名。不同的驱动会有不同的表现，具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果	true|false	true
useGeneratedKeys	允许JDBC 支持自动生成主键，需要驱动兼容。如果设置为 true，则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工作（比如 Derby）	true|false	false
autoMappingBehavior	指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射。 PARTIAL 表示只会自动映射，没有定义嵌套结果集和映射结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）	NONE、PARTIAL、FULL	PARTIAL
autoMappingUnkno wnColumnBehavior	指定自动映射当中未知列（或未知属性类型）时的行为。 默认是不处理，只有当日志级别达到 WARN 级别或者以下，才会显示相关日志，如果处理失败会抛出 SqlSessionException 异常	NONE、WARNING、FAILING	NONE
defaultExecutorType	配置默认的执行器。SIMPLE 是普通的执行器；REUSE 会重用预处理语句（prepared statements）；BATCH 执行器将重用语句并执行批量更新	SIMPLE、REUSE、BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定驱动等待数据库响应的秒数	任何正整数	Not Set (null)
defaultFetchSize	设置数据库驱动程序默认返回的条数限制，此参数可以重新设置	任何正整数	Not Set (null)
safeRowBoundsEnabled	允许在嵌套语句中使用分页（RowBounds）。如果允许，设置 false	true|false	false
safeResultHandlerEnabled	允许在嵌套语句中使用分页（ResultHandler）。如果允许，设置false	true|false	true
mapUnderscoreToCamelCase	是否开启自动驼峰命名规则映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射	true|false	false
localCacheScope	MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速联复嵌套査询。 默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlScssion 的不同调用将不会共享数据	SESSION|STATEMENT	SESSION
jdbcTypeForNull	当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER	NULL、VARCHAR、OTHER	OTHER
lazyLoadTriggerMethods	指定哪个对象的方法触发一次延迟加载	—	equals、clone、hashCode、toString
defaultScriptingLanguage	指定动态 SQL 生成的默认语言	—	org.apache.ibatis .script.ing.xmltags .XMLDynamicLanguageDriver
callSettersOnNulls	指定当结果集中值为 null 时，是否调用映射对象的 setter（map 对象时为 put）方法，这对于 Map.kcySet() 依赖或 null 值初始化时是有用的。注意，基本类型（int、boolean 等）不能设置成 null	true|false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀	任何字符串	Not set
loglmpl	指定 MyBatis 所用日志的具体实现，未指定时将自动査找	SLF4J|LOG4J|LOG4J2|JDK_LOGGING |COMMONS_LOGGING |ST DOUT_LOGGING|NO_LOGGING	Not set
proxyFactory	指定 MyBatis 创建具有延迟加栽能力的对象所用到的代理工具	CGLIB|JAVASSIST	JAVASSIST （MyBatis 版本为 3.3 及以上的）
vfsImpl	指定 VFS 的实现类	提供 VFS 类的全限定名，如果存在多个，可以使用逗号分隔	Not set
useActualParamName	允许用方法参数中声明的实际名称引用参数。要使用此功能，项目必须被编译为 Java 8 参数的选择。（从版本 3.4.1 开始可以使用）	true|false	true

（2）示例

    <settings>
        <!--    该配置影响所有映射器中配置缓存的全局开关    -->
        <setting name="cacheEnabled" value="true"/>
        <!--    延迟加载的全局开关    -->
        <setting name="lazyLoadingEnabled" value="true"/>
        <!--    是否允许单一语句返回多结果集    -->
        <setting name="multipleResultSetsEnabled" value="true"/>
        <!--    使用列标签代替列名    -->
        <setting name="useColumnLabel" value="true"/>
        <!--    允许JDBC 支持自动生成主键    -->
        <setting name="useGeneratedKeys" value="false"/>
        <!--    指定 MyBatis 应如何自动映射列到字段或属性    -->
        <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"/>
        <!--    当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。    -->
        <setting name="jdbcTypeForNull" value="OTHER"/>
        <!--    指定哪个对象的方法触发一次延迟加载    -->
        <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
    </settings>

3、typeAliases

（1）说明

       由于类的全限定名称很长，需要大量使用的时候，会显示不方便。在 MyBatis 中允许定义一个简写来代表这个类，这就是别名。

typeAliases有两个属性：

• type：起别名的类的全类名，默认别名是类名的小写，例：Employee —>employee
• alias:指定别名

（2）示例

       通过typeAliases为实体类指定别名，alias指定的别名就可以代替在任何地方使用全限定类名的地方，如下：

<typeAliases>
    <typeAlias alias="Author" type="com.day1.entity.Author"/>
    <typeAlias alias="User" type="com.day1.entity.User"/>
    <typeAlias alias="Book" type="com.day1.entity.Book"/>
    <typeAlias alias="Student" type="com.day1.entity.Student"/>  
</typeAliases>

       同样，也使用Package标签来指定包，自动加载包下的所有实体类，并使用实体类的首字母小写的非限定类名来作为它的别名。

    <!--    定义别名-->
    <typeAliases>
        <typeAlias type="com.day1.entity.User" alias="user"></typeAlias>
    </typeAliases>

       在实体类的类前面可以通过注解方式指定别名，如下：

@Alias("myBook")
public class Book{
    
}

4、enviroments属性

（1）说明

       MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 例如在现实环境中，开发、测试和生产环境需要有不同的配置；或者共享相同 Schema 的多个生产数据库， 想使用相同的 SQL 映射。enviroments可以配置多个环境，每个 SqlSessionFactory 实例只能选择其一。所以，如果要连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个。

       关于enviroment中属性的说明：

• transactionManager属性（事务管理器）：有JDBC和MANAGER两种类型。
  • JDBC直接使用了JDBC的提交和事务回滚设置，依赖JDBC的Connection管理事务；
  • MANAGER通过容器管理事务，默认情况下关闭连接(通过closeConnection=false保持连接)
• dataSource属性（数据源）：有UNPOOLED、POOLED、JNDI三种类型。
  • UNPOOLED在每次被请求时打开和关闭连接；
  • POOLED这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间；
  • JNDI这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用

（2）示例

    <environments default="dev_mysql">
		<!-- mysql环境 -->
		<environment id="dev_mysql">
			<transactionManager type="JDBC" />
			<dataSource type="POOLED">
				<property name="driver" value="${jdbc.driver}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.username}" />
				<property name="password" value="${jdbc.password}" />
			</dataSource>
		</environment>
	
		<!-- oracle环境 -->
		<environment id="dev_oracle">
			<transactionManager type="JDBC" />
			<dataSource type="POOLED">
				<property name="driver" value="${orcl.driver}" />
				<property name="url" value="${orcl.url}" />
				<property name="username" value="${orcl.username}" />
				<property name="password" value="${orcl.password}" />
			</dataSource>
		</environment>
	</environments>
	

5、mapper属性

（1）说明

       mapper属性用来加载映射文件，加载方式有如下几种:

加载方式	用法
使用相对于类的资源引用	mapper resource =“org/mybatis/builder/UserMapper.xml”
使用完全限定资源定位符URL	mapper url = “file:///var/mappers/UserMapper”
使用映射器接口实现类的完全限定名	mapper class = “org.mybatis.builder.UserMapper”
将包内的映射器接口实现全部注册为映射器	package name = “org.mybatis.builder”

（2）示例

<!-- 使用相对于类路径的资源引用 -->
<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>
<!-- 使用映射器接口实现类的完全限定类名 -->
<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>