MyBatis使用篇（十）—— MyBatis配置文件详解

1、全局配置文件SqlMapConfig

1.1 全局配置文件SqlMapConfig配置项

  在使用MyBatis框架时，最重要的一步就是配置项目工程的全局参数信息，以及数据库连接信息，这些配置信息均在全局配置文件SqlMapConfig.xml中。除此之外，该配置文件中还包含了SQL应神剑的加载路径、全局参数以及类型别名等一系列MyBatis的核心配置信息。SqlMapConfig中的配置信息必须严格按照格式标准进行配置。

  全局配置文件SqlMapConfig.xml中各个配置项的名称、含义及描述如下表：

  按照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>
    <!--1、properties属性引入外部配置文件：注册DB连接四要素的属性文件-->
    <properties resource="jdbc.properties" />

    <!--2、全局参数设置-->
    <settings>
        <!-- 配置LOG信息 -->
        <setting name="logImpl" value="LOG4J" />
        <!-- 延迟加载总开关 -->
        <setting name="lazyLoadingEnabled" value="true"/>
        <!-- 侵入式延迟加载开关 -->
        <setting name="aggressiveLazyLoading" value="true"/>
        <!-- 关闭二级查询缓存 -->
        <!--<setting name="cacheEnabled" value="false" />-->
    </settings>

    <!--3、配置别名-->
    <typeAliases>
        <package name="com.ccff.mybatis.model"/>
    </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="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

    <!--8、配置SQL映射文件的位置-->
    <mappers>
        <mapper resource="sqlmap/UserMapper.xml"/>
        <mapper resource="sqlmap/StudentMapper.xml"/>
        <mapper resource="sqlmap/BasketballPlayerMapper.xml"/>
        <mapper resource="sqlmap/FinacialMapper.xml"/>
        <mapper resource="sqlmap/NewsLabelMapper.xml" />
        <mapper resource="sqlmap/LazyLoadingMapper.xml" />
        <mapper resource="sqlmap/BookMapper.xml" />
        <mapper resource="sqlmap/GoodsMapper.xml" />
    </mappers>
</configuration>

1.2 properties配置分析

  在SqlMapConfig配置文件中，properties标签中的数据可以供整个配置文件中的其他配置使用。properties标签可以引入一个可动态变换的外部配置，如一个传统的Java配置文件，亦或是一个properties参数配置文件。当然，在properties标签内部也可以放置property标签，来配置子元素信息。对于配置文件中的其他配置，可以通过property子标签的name属性来取得相应的value值。

  一个properties标签配置样例如下（引入了一个jdbc.properties文件）

<!-- 注册DB连接四要素的属性文件 -->
<properties resource="jdbc.properties">
	<property name="username" value="root" />
	<property name="password" value="root" />
</properties>

  可以看到，其中引入了一个jdbc.properties属性文件，该配置文件样例如下：

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root

  jdbc.properties配置文件中配置了数据库的详细连接信息，properties标签这样引入它避免了数据库信息的“硬编码”。当需要连接其他数据库时，只需要更改要连接的数据库的配置文件路径即可。

  当然properties标签也可以包含property子标签，该子标签中的值也可以被配置文件中的其他配置使用，属于一种全局参数。可以看到，这里虽引入了jdbc.properties文件，但是其中的username和password还可以重新在property子标签中配置，这个时候取的就是property子标签中的value值。这样配置是因为有时候有些模块的数据库连接的用户可能需要以不同的角色登录，这样可以在property子标签中动态分配数据库连接的用户名username和密码password。

  在properties标签中引入的配置文件信息以及property子标签中配置的信息，在其他标签中可以使用“$ {}”占位符的方式来获取，在“$ {}”中填写引入的配置文件中参数的name或者property子标签的name，样例配置中的数据源信息配置其实就是获取properties标签中的配置信息。

<!-- 数据库连接池-->
<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>

  另外，在MyBatis 3.4.2之后，还可以在“$ {}”占位符中设置一个默认值。当然，首先要在properties标签中设置一个启用占位符默认值的配置，该配置如下：

<!-- 注册DB连接四要素的属性文件 -->
<properties resource="jdbc.properties">
	<property name="org.apache.ibatis.parsing.PropertyParser.enable-defaut-value" value="true" />
</properties>

  然后在其他属性引用properties标签中的参数时，可以这样设置一个默认值

<!-- 数据库连接池-->
<dataSource type="POOLED">
	<property name="driver" value="${jdbc.driver}"/>
	<property name="url" value="${jdbc.url}"/>
	<property name="username" value="${jdbc.username:root}"/>
	<property name="password" value="${jdbc.password}"/>
</dataSource>

  即在所需引入的属性名的后面添加“:”引号，然后紧跟着填写当jdbc.username不存在或为空时的默认值。

1.3 setting配置分析

  setting配置也是MyBatis全局配置文件中比较重要的配置，它影响MyBatis框架在运行时的一些行为。setting配置缓存、延迟加载、结果集控制、执行器、分页设置、命名规则等一系列控制性参数，与MyBatis的运行性能息息相关。所有的setting配置都被包裹在settings标签对中，setting可配置的参数如下表所示。

  一个完整的settings配置元素样例如下：

<settings>
	<setting name="cahceEnabled" value="true" />
	<setting name="lazyLoadingEnabled" value="true" />
	<setting name="multipleResultSetsEnabled" value="true" />
	<setting name="useColumnLabel" value="true" />
	<setting name="useGeneratedKeys" value="false" />
	<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" />
	<setting name="localCacheScope" value="SESSION" />
	<setting name="jdbcTypeForNull" value="OTHER" />
	<</