mybatis学习笔记(2):conf文件配置项

在配置文件中配置项必须按一定的顺序配置，否则会报错，顺序如下:

properties
settings
typeAliases
typeHandlers
objectFactory
objectWrapperFactory
plugins
environments
databaseIdProvider
mappers

properties

<properties>元素是最先被解析的，设置的属性值将会被其他元素所使用。所以需要在配置文件中的最前面配置。
我们可以在这个标签下直接定义一些属性供下面配置项使用，也可以引入外部属性文件，下面介绍引入外部属性文件的方式：

    <!-- 引入数据库配置文件 -->
    <properties resource="db.properties"></properties>
    <!-- 可以配置多个数据库环境，这里设置使用dev(开发)环境 -->
    <environments default="dev">
        <!-- 开发环境 -->
        <environment id="dev">
            <!-- 设置使用的事务管理器为JDBC -->
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="${dev_driver}" />
                <property name="url" value="${dev_url}" />
                <property name="username" value="${dev_username}" />
                <property name="password" value="${dev_password}" />
            </dataSource>
        </environment>
    </environments>

外部属性文件db.properties：
这里写图片描述

settings

settings是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。比较常用的如设置驼峰命名规则（camel case）映射:

<setting name="mapUnderscoreToCamelCase" value="true"/>

设置为true即可以将数据库列名 A_COLUMN 映射为 Java 属性名 aColumn 。
下面是所有的settings：

<settings>
    <!-- 该配置影响的所有映射器中配置的缓存的全局开关。默认值true -->
  <setting name="cacheEnabled" value="true"/>
  <!--延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置fetchType属性来覆盖该项的开关状态。默认值false  -->
  <setting name="lazyLoadingEnabled" value="true"/>
    <!-- 是否允许单一语句返回多结果集（需要兼容驱动）。 默认值true -->
  <setting name="multipleResultSetsEnabled" value="true"/>
  <!-- 使用列标签代替列名。不同的驱动在这方面会有不同的表现， 具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。默认值true -->
  <setting name="useColumnLabel" value="true"/>
  <!-- 允许 JDBC 支持自动生成主键，需要驱动兼容。 如果设置为 true 则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工作（比如 Derby）。 默认值false  -->
  <setting name="useGeneratedKeys" value="false"/>
 <!--  指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）。 --> 
 <!-- 默认值PARTIAL -->
  <setting name="autoMappingBehavior" value="PARTIAL"/>

  <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
 <!--  配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）； BATCH 执行器将重用语句并执行批量更新。默认SIMPLE  -->
  <setting name="defaultExecutorType" value="SIMPLE"/>
  <!-- 设置超时时间，它决定驱动等待数据库响应的秒数。 -->
  <setting name="defaultStatementTimeout" value="25"/>

  <setting name="defaultFetchSize" value="100"/>
  <!-- 允许在嵌套语句中使用分页（RowBounds）默认值False -->
  <setting name="safeRowBoundsEnabled" value="false"/>
  <!-- 是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。  默认false -->
  <setting name="mapUnderscoreToCamelCase" value="false"/>
  <!-- MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。
         默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。
        若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据。  -->
  <setting name="localCacheScope" value="SESSION"/>
  <!-- 当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。  -->
  <setting name="jdbcTypeForNull" value="OTHER"/>
<!--   指定哪个对象的方法触发一次延迟加载。  -->
  <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>

typeAliases

这个元素主要是用于对类型进行别名控制，可以给Mapper XML文件中使用的实体类取个别名，以达到简化操作的目的。
看看之前配置的Mapper XML的配置：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- namespace命名空间，唯一标识。一般指定为自定义的接口文件，下面相当于这个接口的实现类 -->
<mapper namespace="com.mybatis.mapper.EmployeeMapper">
    <!-- 相当于接口的getEmpById方法实现 -->
    <select id="getEmpById" resultType="com.mybatis.domian.Employee">
        select * from tbl_employee where id = #{id}
    </select>

    <insert id="addEmp" parameterType="com.mybatis.domian.Employee">
        insert into tbl_employee(last_name,gender,email) values(#{lastName},#{gender},#{email})
    </insert>

    <update id="updateEmp" parameterType="com.mybatis.domian.Employee">
        update tbl_employee set last_name = #{lastName} where id=#{id}
    </update>

    <delete id="deleteEmp" parameterType="Integer">
        delete from tbl_employee where id=#{id}
    </delete>
    <!-- 返回值类型为泛型Employee的List,这里resultType指定为 Employee-->
    <select id="getAll" resultType="com.mybatis.domian.Employee">
        select * from tbl_employee
    </select>
</mapper>

可以看到里面使用的parameterType和resultType使用的Employee类用的都是全类名，如果要改这个类名的话，我们需要在多个地方进行修改，感觉很繁琐。很明显，这样配置的话很容易造成修改上的遗漏，同时也书写上也比较麻烦。因此，MyBatis为我们提供了一个简单方便的配置方法，那就是使用<typeAliases>标签元素，给实体类设置一个别名。

<typeAliases>
    <typeAlias type="com.mybatis.domain.Employee" alias="emp"/>
</typeAliases>

这样在Mapper XML文件中就可以使用 emp代替Employee全类名，方便统一管理。
备注：这里需要注意的是，typeAliases配置需要放置在settings之后，否则会出异常！

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- namespace命名空间，唯一标识。一般指定为自定义的接口文件，下面相当于这个接口的实现类 -->
<mapper namespace="com.mybatis.mapper.EmployeeMapper">
    <!-- 相当于接口的getEmpById方法实现 -->
    <select id="getEmpById" resultType="emp">
        select * from tbl_employee where id = #{id}
    </select>

    <insert id="addEmp" parameterType="emp">
        insert into tbl_employee(last_name,gender,email) values(#{lastName},#{gender},#{email})
    </insert>

    <update id="updateEmp" parameterType="emp">
        update tbl_employee set last_name = #{lastName} where id=#{id}
    </update>

    <delete id="deleteEmp" parameterType="Integer">
        delete from tbl_employee where id=#{id}
    </delete>
    <!-- 返回值类型为泛型Employee的List,这里resultType指定为 Employee-->
    <select id="getAll" resultType="emp">
        select * from tbl_employee
    </select>
</mapper>

然而如果实体类比较多，还是要配置很多实体类和别名，还是会很繁琐。所以上面这种方式在实际应用中并常用，下面介绍一个常用的方式:

<typeAliases>
    <!-- 扫描包下的所有类，并为之创建别名 -->
    <package name="com.mybatis.domain"/>
</typeAliases>

这种方式可以扫描指定的包内的所有类，并为之创建别名。默认别名为类名首字母小写，如com.mybatis.domain.Employee会自动取别名为employee.
这种方式可以配合@Alias注解使用：
@Alias注解在实体类上可以为之指定别名，配合包扫描的方式使用起来更灵活。如：

@Alias("emp") //指定别名为emp
public class Employee {
...
}

上面指定Employee 类别名为emp，这样在Mapper XML文件中就可以使用这个别名代替Employee 全类名。