MyBatis 入门到精通（二）

上一篇博客的传送门：MyBatis 入门到精通（一）

在这篇博客中，我们讲解 MyBatis 的相关配置文件，这里主要围绕 config.xml 和 XxxMapper.xml 来讲解。

config.xml

MyBatis 的 config.xml 配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。 配置文档的顶层结构如下：

<configuration>
    <!--属性-->
    <properties resource="Xxx.properties">
      <property name="username" value="guanwei"/>
      <property name="password" value="abcdefg"/>
    </properties>
    <!--设置-->
    <settings>
          <setting name="cacheEnabled" 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"/>
          <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
    </settings>
    <!--插件-->
    <plugins>
          <plugin interceptor="com.dailyblue.java.GuanWeiInterceptor">
            <property name="someProperty" value="100"/>
          </plugin>
    </plugins>
    <!--配置环境-->
    <environments default="development">
        <!--配置Mysql的环境-->
        <environment id="development">
            <!--配置事务的类型-->
            <transactionManager type="JDBC"></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>

    <mappers>
        <mapper resource="Mapper.xml" />
    </mappers>

</configuration>

属性（properties） 

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。

<!--引入外部文件 外部文件中定义了Key-Value结构数据-->
<properties resource="Xxx.properties">
  <!--如果外部文件中有相同的name 这里会覆盖原有值，否则新增-->
  <property name="username" value="guanwei"/>
  <property name="password" value="abcdefg"/>
</properties>

设置好的属性可以在整个配置文件中用来替换需要动态配置的属性值。替换方式是：

<!--${Key}-->
<property name="driver" value="${driver}" />
<property name="url" value="${url}" />
<property name="username" value="${username}" />
<property name="password" value="${password}" />

设置（settings）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。 

类型别名（typeAliases）

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。

<typeAliases>
  <typeAlias alias="Emp" type="com.dailyblue.java.bean.Emp"/>
  <typeAlias alias="GuanWei" type="com.dailyblue.java.bean.GuanWei"/>
</typeAliases>

当这样配置时，GuanWei 可以用在任何使用 com.dailyblue.java.bean.GuanWei 的地方。也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean：

<typeAliases>
  <package name="com.dailyblue.java.bean"/>
</typeAliases>

注解的写法： 

@Alias("guanwei")
public class GuanWei {
    ...
}

下面是一些为常见的 Java 类型内建的类型别名。它们都是不区分大小写的，注意，为了应对原始类型的命名重复，采取了特殊的命名风格。

类型处理器（typeHandlers）

MyBatis 在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时， 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器。

对象工厂（objectFactory）

每次 MyBatis 创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成实例化工作。 默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认无参构造方法，要么通过存在的参数映射来调用带有参数的构造方法。 如果想覆盖对象工厂的默认行为，可以通过创建自己的对象工厂来实现。比如： 

// 自定义对象工厂
public class GuanWeiObjectFactory extends DefaultObjectFactory {
  public Object create(Class type) {
    return super.create(type);
  }
  public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs) {
    return super.create(type, constructorArgTypes, constructorArgs);
  }
  public void setProperties(Properties properties) {
    super.setProperties(properties);
  }
  public <T> boolean isCollection(Class<T> type) {
    return Collection.class.isAssignableFrom(type);
  }
}

config.xml 中使用自定义的对象工厂。 

<objectFactory type="com.dailyblue.java.config.GuanWeiObjectFactory">
  <property name="someProperty" value="100"/>
</objectFactory>

ObjectFactory 接口很简单，它包含两个创建实例用的方法，一个是处理默认无参构造方法的，另外一个是处理带参数的构造方法的。 另外，setProperties 方法可以被用来配置 ObjectFactory，在初始化你的 ObjectFactory 实例后， objectFactory 元素体中定义的属性会被传递给 setProperties 方法。 

插件（plugins）

MyBatis 允许你在映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

• Executor：拦截内部执行器，它负责调用 StatementHandler 操作数据库，并把结果集通过 ResultSetHandler 进行自动映射，另外它还处理了二级缓存的操作。
• StatementHandler：拦截 SQL 语法构建的处理，它是 MyBatis 直接和数据库执行 SQL 脚本的对象，另外它也实现了 MyBatis 的一级缓存。
• ParameterHandler：拦截参数的处理。
• ResultSetHandler：拦截结果集的处理。

这些类中方法的细节可以通过查看每个方法的签名来发现，或者直接查看 MyBatis 发行包中的源代码。 如果你想做的不仅仅是监控方法的调用，那么你最好相当了解要重写的方法的行为。 因为在试图修改或重写已有方法的行为时，很可能会破坏 MyBatis 的核心模块。 这些都是更底层的类和方法，所以使用插件的时候要特别当心。

通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。

public interface Interceptor {  
   // intercept 方法就是要进行拦截的时候要执行的方法。
   Object intercept(Invocation invocation) throws Throwable;      
   // plugin 方法是插件用于封装目标对象的，通过该方法我们可以返回目标对象本身，也可以返回一个它的代理，可以决定是否要进行拦截进而决定要返回一个什么样的目标对象，官方提供了示例：return Plugin. wrap(target, this)；
   Object plugin(Object target);   
   // setProperties 方法是在 MyBatis 进行配置插件的时候可以配置自定义相关属性，即：接口实现对象的参数配置；
   void setProperties(Properties properties);

}

@Intercepts({@Signature(type = Executor. class, method = "query",

        args = {MappedStatement. class, Object. class, RowBounds. class, ResultHandler. class})})

public class TestInterceptor implements Interceptor {

   public Object intercept(Invocation invocation) throws Throwable {

     Object target = invocation. getTarget(); //被代理对象

     Method method = invocation. getMethod(); //代理方法

     Object[] args = invocation. getArgs(); //方法参数

     // do something . . . . . .  方法拦截前执行代码块

     Object result = invocation. proceed();

     // do something . . . . . . . 方法拦截后执行代码块

     return result;

   }

   public Object plugin(Object target) {

     return Plugin. wrap(target, this);

   }

}

<plugins>
  <plugin interceptor="org.mybatis.example.TestInterceptor">
    <property name="someProperty" value="100"/>
  </plugin>
</plugins>

环境配置（environments）

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。

environments 元素定义了如何配置环境。

<!--配置环境 引用那个配置环境-->
<environments default="development">
     <!--配置Mysql的环境 这里可以配置多个 ID是当前的唯一名字-->
     <environment id="development">
         <!--配置事务的类型-->
         <transactionManager type="JDBC"></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=”development” 的 envuronment。
• 每个 environment 元素定义的环境 ID（比如：id=”development”）。
• 事务管理器的配置（比如：type=”JDBC”）。
• 数据源的配置（比如：type=”POOLED”）。

默认环境和环境 ID 顾名思义。 环境可以随意命名，但务必保证默认的环境 ID 要匹配其中一个环境 ID。

事务管理器（transactionManager）

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

• JDBC：这个配置直接使用了 JDBC 的提交和回滚设施，它依赖从数据源获得的连接来管理事务作用域。
• MANAGED：这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接。然而一些容器并不希望连接被关闭，因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为。

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

数据源（dataSource）

我们在实际开发中都会使用连接池，因为它可以减少我们获取连接所消耗的时间，dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。大多数 MyBatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源。在mybatis中连接池提供了3种方式的配置：

• UNPOOLED：这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。 性能表现则依赖于使用的数据库，对某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。
• POOLED：这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行，能使并发 Web 应用快速响应请求。
• JNDI：这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的数据源引用。

数据库厂商标识（databaseIdProvider）

MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。 MyBatis 会加载带有匹配当前数据库 databaseId 属性和所有不带 databaseId 属性的语句。 如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。

<databaseIdProvider type="DB_VENDOR">
  <property name="SQL Server" value="sqlserver"/>
  <property name="DB2" value="db2"/>
  <property name="Oracle" value="oracle" />
</databaseIdProvider>

映射器（mappers）

既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要来定义 SQL 映射语句了。 但首先，我们需要告诉 MyBatis 到哪里去找到这些语句。 在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件。 你可以使用相对于类路径的资源引用，或完全限定资源定位符（包括 file:/// 形式的 URL），或类名和包名等。

使用相对于类路径的资源引用（XML写法）：

<mappers>
  <mapper resource="com/dailyblue/java/mybatis/mapper/EmpMapper.xml"/>
  <mapper resource="com/dailyblue/java/mybatis/mapper/DeptMapper.xml"/>
</mappers>

使用映射器接口实现类的完全限定类名（注解写法）：

<mappers>
  <mapper class="com.dailyblue.java.mapper.EmpMapper"/>
  <mapper class="com.dailyblue.java.mapper.DeptMapper"/>
</mappers>

将包内的映射器接口实现全部注册为映射器：

<mappers>
  <package name="com.dailyblue.java.mapper"/>
</mappers>

一个加载时的常见错误

这是因为 Idea 中默认只搜索 resources 中的配置文件信息，我们为了便于书写将 EmpMapper 接口和 EmpMapper.xml 存放到一个包中，这个包在 java 文件夹，是不会进行检索的，故会报搜索不到的错误。

我们只需在项目的 pom.xml 文件中标识搜索 java 文件夹下的配置文件即可。

<!--强制Idea搜索xml文件在java文件夹下-->
<resources>
    <resource>
        <directory>src/main/java</directory>
        <includes>
            <include>**/*.xml</include>
        </includes>
        <filtering>true</filtering>
    </resource>
</resources>

这些配置会告诉 MyBatis 去哪里找映射文件，剩下的细节就应该是每个 SQL 映射文件了，也就是接下来我们要讨论的。 

Mapper.xml

MyBatis 的真正强大在于它的语句映射，这是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 致力于减少使用成本，让用户能更专注于 SQL 代码。

我们在本章中，以 xml 的方式来详细讲解映射器，在后续的课程中，也会引入注解的方式来进行讲解。

XML 映射文件只有很少的几个顶级元素：

• cache：该命名空间的缓存配置。
• cache-ref：引用其它命名空间的缓存配置。
• resultMap：描述如何从数据库结果集中加载对象，是最复杂也是最强大的元素。
• parameterMap：老式风格的参数映射。此元素已被废弃，并可能在将来被移除！请使用行内参数映射。文档中不会介绍此元素。
• sql：可被其它语句引用的可重用语句块。
• insert：映射插入语句。
• update：映射更新语句。
• delete：映射删除语句。
• select：映射查询语句。

select 标签

查询语句是 MyBatis 中最常用的元素之一。 

<select id="findAllEmp" resultType="com.dailyblue.java.bean.Emp">
      select * from emp where empState = 1
</select>

select 标签的相关属性： 

insert、update 和 delete 标签

数据变更语句 insert，update 和 delete 的实现非常接近，之间也可以相互替代。

<insert id="saveEmp" parameterType="com.dailyblue.java.mybatis.bean.Emp">
        insert into emp
        values (null, #{ename}, #{job}, #{mgr}, now(), #{sal}, #{comm}, #{deptNo}, 1)
</insert>
<update id="updateEmp" parameterType="com.dailyblue.java.mybatis.bean.Emp">
        update emp
        set ename=#{ename},
            job=#{job},
            mgr=#{mgr},
            sal=#{sal}
        where empNo = #{empNo}
</update>
<delete id="deleteEmp" parameterType="_int">
        update emp
        set empstate=0
        where empno = #{empNo}
</delete>

insert、update 和 delete 标签的相关属性：

sql 标签

这个元素可以用来定义可重用的 SQL 代码片段，以便在其它语句中使用。 参数可以静态地（在加载的时候）确定下来，并且可以在不同的 include 元素中定义不同的参数值。 

<sql id="guanwei01"> ${obj}.empno,${obj}.ename,${obj}.job</sql>

<select id="findAllEmp" resultType="emp">
  select
    <include refid="guanwei01"><property name="obj" value="emp"/></include>
  from emp
</select>

在这里我们主要讲解这六个标签，其他标签在以后的章节中会逐步引入，例如：二级缓存、手动映射等。 

下来我们来通过 Mapper 接口的方式实现对 Emp 表的CRUD操作—MyBatis 入门到精通（三）