【MyBatis源码分析】mappers解析属性配置元素详述

原创 于 2018-01-17 16:33:59 发布 · 605 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#mybatis #框架 #源码 #数据访问 #java

本文深入解析MyBatis的Mapper配置，包括insert、update、delete元素及<select>、resultType、resultMap的配置。通过分析源码，理解mapper文件的namespace、<sql>、<resultMap>等元素的作用，以及如何加载和解析mapper配置。

mapper加载

config.xml中两个最重要的标签，一个是<environment>（JDBC环境信息），另一个就是mapper（sql文件映射）了。

Mapper映射文件是一个xml格式文件，必须遵循相应的dtd文件规范，如ibatis-3-mapper.dtd。我们先大体上看看支持哪些配置？如下所示，从Eclipse里截了个屏：


从上图可以看出，映射文件是以<mapper>作为根节点，在根节点中支持9个元素，分别为insert、update、delete、select（增删改查）;cache、cache-ref、resultMap、parameterMap、sql。

下文中，我们将首先对增删改进行描述，然后对查进行详细说明，最后对其他五个元素进行简单说明。

（1）insert、update、delete

我们先从配置文件看起：

<!DOCTYPE mapper     
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"    
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">   
  
<!-- mapper 为根元素节点， 一个namespace对应一个dao -->  
<mapper namespace="MailMapper">  
  
    <insert  
      <!-- 1. id （必须配置）  
        id是命名空间中的唯一标识符，可被用来代表这条语句。   
        一个命名空间（namespace） 对应一个dao接口,   
        这个id也应该对应dao里面的某个方法（相当于方法的实现），因此id 应该与方法名一致 -->  
        
      id="addMail"  
        
      <!-- 2. parameterType （可选配置, 默认为mybatis自动选择处理）  
        将要传入语句的参数的完全限定类名或别名， 如果不配置，mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理  
        parameterType 主要指定参数类型，可以是int, short, long, string等类型，也可以是复杂类型（如对象） -->  
        
      parameterType="mail"  
        
      <!-- 3. flushCache （可选配置，默认配置为true）  
        将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：true（对应插入、更新和删除语句） -->  
        
      flushCache="true"  
        
      <!-- 4. statementType （可选配置，默认配置为PREPARED）  
        STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。 -->  
        
      statementType="PREPARED"  
        
      <!-- 5. keyProperty (可选配置， 默认为unset)  
        （仅对 insert 和 update 有用）唯一标记一个属性，MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值，默认：unset。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->  
        
      keyProperty=""  
        
      <!-- 6. keyColumn     (可选配置)  
        （仅对 insert 和 update 有用）通过生成的键值设置表中的列名，这个设置仅在某些数据库（像 PostgreSQL）是必须的，当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->  
        
      keyColumn=""  
        
      <!-- 7. useGeneratedKeys (可选配置， 默认为false)  
        （仅对 insert 和 update 有用）这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段），默认值：false。  -->  
        
      useGeneratedKeys="false"  
        
      <!-- 8. timeout  (可选配置， 默认为unset, 依赖驱动)  
        这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。 -->  
      timeout="20">  
  
    <update  
      id="updateMail"  
      parameterType="user"  
      flushCache="true"  
      statementType="PREPARED"  
      timeout="20">  
  
    <delete  
      id="deleteMail"
      parameterType="user"  
      flushCache="true"  
      statementType="PREPARED"  
      timeout="20">  
</mapper>
上面给出了一个比较全面的配置说明，但是在实际使用过程中并不需要都进行配置，可根据自己的需要删除部分配置项。
这里的parameterType设置成mail是因为如果不设置的情况下，会自动将类名首字母小写后的名称，原来的类名为mail。不过，建议大家还是使用typeAlias进行配置吧。唯一需要说明的就是<insert>元素里面的useGeneratedKeys和keyProperties属性，这两个属性是用来获取数据库中的主键的。

在数据库里面经常性的会给数据库表设置一个自增长的列作为主键，如果我们操作数据库后希望能够获取这个主键该怎么弄呢？正如上面所述，如果是支持自增长的数据库，如mysql数据库，那么只需要设置useGeneratedKeys和keyProperties属性便可以了，但是对于不支持自增长的数据库（如oracle）该怎么办呢？

mybatis里面在<insert>元素下面提供了<selectKey>子元素用于帮助解决这个问题。来看下配置：

<selectKey  
        <!-- selectKey 语句结果应该被设置的目标属性。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->  
        keyProperty="id"  
        <!-- 结果的类型。MyBatis 通常可以推算出来，但是为了更加确定写上也不会有什么问题。MyBatis 允许任何简单类型用作主键的类型，包括字符串。如果希望作用于多个生成的列，则可以使用一个包含期望属性的 Object 或一个 Map。 -->  
        resultType="int"  
        <!-- 这可以被设置为 BEFORE 或 AFTER。如果设置为 BEFORE，那么它会首先选择主键，设置 keyProperty 然后执行插入语句。如果设置为 AFTER，那么先执行插入语句，然后是 selectKey 元素 - 这和像 Oracle 的数据库相似，在插入语句内部可能有嵌入索引调用。 -->  
        order="BEFORE"  
        <!-- 与前面相同，MyBatis 支持 STATEMENT，PREPARED 和 CALLABLE 语句的映射类型，分别代表 PreparedStatement 和 CallableStatement 类型。 -->  
        statementType="PREPARED">  
</selectKey>
讲完了insert、update、delete，接下来我们看看用的比较多的select。

（2）select、resultType、resultMap

我们先来看看select元素都有哪些配置可以设置：

<select  
        <!--  1. id （必须配置）  
        id是命名空间中的唯一标识符，可被用来代表这条语句。   
        一个命名空间（namespace） 对应一个dao接口,   
        这个id也应该对应dao里面的某个方法（相当于方法的实现），因此id 应该与方法名一致  -->  
       
     id="findMailById"  
       
     <!-- 2. parameterType （可选配置, 默认为mybatis自动选择处理）  
        将要传入语句的参数的完全限定类名或别名， 如果不配置，mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理  
        parameterType 主要指定参数类型，可以是int, short, long, string等类型，也可以是复杂类型（如对象） -->  
     parameterType="int"  
       
     <!-- 3. resultType (resultType 与 resultMap 二选一配置)  
         resultType用以指定返回类型，指定的类型可以是基本类型，可以是java容器，也可以是javabean -->  
     resultType="Mail"  
       
     <!-- 4. resultMap (resultType 与 resultMap 二选一配置)  
         resultMap用于引用我们通过 resultMap标签定义的映射类型，这也是mybatis组件高级复杂映射的关键 -->  
     resultMap="userResultMap"  
       
     <!-- 5. flushCache (可选配置)  
         将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：false -->  
     flushCache="false"  
       
     <!-- 6. useCache (可选配置)  
         将其设置为 true，将会导致本条语句的结果被二级缓存，默认值：对 select 元素为 true -->  
     useCache="true"  
       
     <!-- 7. timeout (可选配置)   
         这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）-->  
     timeout="10000"  
       
     <!-- 8. fetchSize (可选配置)   
         这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset（依赖驱动)-->  
     fetchSize="256"  
       
     <!-- 9. statementType (可选配置)   
         STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED-->  
     statementType="PREPARED"  
       
     <!-- 10. resultSetType (可选配置)   
         FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个，默认值为 unset （依赖驱动）-->  
     resultSetType="FORWARD_ONLY">

在配置查询的返回结果时，resultType和resultMap是二选一的操作。对于比较复杂的查询结果，一般都会设置成resultMap。

resultMap该怎么配置呢？又支持哪些配置呢？我们看看下面：

<resultMap type="" id="">  
      
        <!-- id, 唯一性，注意啦，这个id用于标示这个javabean对象的唯一性， 不一定会是数据库的主键（不要把它理解为数据库对应表的主键）   
            property属性对应javabean的属性名，column对应数据库表的列名  
            （这样，当javabean的属性与数据库对应表的列名不一致的时候，就能通过指定这个保持正常映射了）  
        -->  
        <id property="" column=""/>  
          
        <!-- result与id相比， 对应普通属性 -->      
        <result property="" column=""/>  
          
        <!--  
            constructor对应javabean中的构造方法 
         -->  
        <constructor>  
            <!-- idArg 对应构造方法中的id参数 -->  
            <idArg column=""/>  
            <!-- arg 对应构造方法中的普通参数 -->  
            <arg column=""/>  
        </constructor>  
          
        <!--   
            collection，对应javabean中容器类型, 是实现一对多的关键   
            property 为javabean中容器对应字段名  
            column 为体现在数据库中列名   id
            select 指定关联的sql
        -->  
        <collection property="" column="" ofType="" fetchType=""></collection>  
        <discriminator javaType="" column = "" fetchType=""> //鉴别器级联  javaype为指定类型 column为指定字段  fetchType为指定延迟加载策略
        <!--   
            association 为关联关系，是实现1对1的关键。  
            property 为javabean中容器对应字段名  
            column 为体现在数据库中列名  id
            select 指定关联的sql
         -->  
        <association property="" column="" select="" fetchType=""></association>  
</resultMap>

看完配置我们来看mapper的加载"mapperElement(root.evalNode("mappers"))"这句代码，看一下实现：

private void mapperElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        if ("package".equals(child.getName())) {
          String mapperPackage = child.getStringAttribute("name");
          configuration.addMappers(mapperPackage);
        } else {
          String resource = child.getStringAttribute("resource");
          String url = child.getStringAttribute("url");
          String mapperClass = child.getStringAttribute("class");
          if (resource != null && url == null && mapperClass == null) {
            ErrorContext.instance().resource(resource);
            InputStream inputStream = Resources.getResourceAsStream(resource);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url != null && mapperClass == null) {
            ErrorContext.instance().resource(url);
            InputStream inputStream = Resources.getUrlAsStream(url);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url == null && mapperClass != null) {
            Class<?> mapperInterface = Resources.classForName(mapperClass);
            configuration.addMapper(mapperInterface);
          } else {
            throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
          }
        }
      }
    }
  }

看到<mappers>下可以定义<mapper>和<package>两种子标签，它们同样是二选一的关系，即只能定义其中一种，这里先看package分支的内容即根据类路径加载Mapper就不看了，基本不用的，就看else分支里面的内容，即根据<mapper>标签解析sql映射。

接着第8行~第10行分别获取每一个<mapper>中的resource、url、mapperClass，接着下面的判断很有意思：

  • resource != null && url == null && mapperClass == null
  • resource == null && url != null && mapperClass == null
  • resource == null && url == null && mapperClass != null

这告诉我们了resource、url、mapperClass三个属性只能定义其中的一个，else分支中抛出的异常同样也印证了这一说法。本系列文章的例子定义的是resource且定义resource的方式最常用，因此进入第一个if判断。

第12行的代码上下文设置一下resource，不是很重要。

第13行的代码根据mapper文件路径获取InputStream，InputStream在之后将会被转为InputSource用来解析mapper文件。

第14行的代码获取一个XMLMapperBuilder，它的流程和上文分析的XMLConfigBuilder是一样的，里面也使用的是XPathParser将mapper文件解析为Document。

第15行的代码跟进去看一下实现，因为XMLMapperBuilder的parse方法和XMLConfigBuilder的parse方法有区别，毕竟解析的是两种MyBatis配置文件：

public void parse() {
    if (!configuration.isResourceLoaded(resource)) {
      configurationElement(parser.evalNode("/mapper"));
      configuration.addLoadedResource(resource);
      bindMapperForNamespace();
    }

    parsePendingResultMaps();
    parsePendingChacheRefs();
    parsePendingStatements();
  }

第2行的代码判断了当前资源是否被加载过，如果没有被加载过则会执行第3行~第5行的代码。

首先是第3行的代码configurationElement：

private void configurationElement(XNode context) {
    try {
      String namespace = context.getStringAttribute("namespace");
      if (namespace == null || namespace.equals("")) {
        throw new BuilderException("Mapper's namespace cannot be empty");
      }
      builderAssistant.setCurrentNamespace(namespace);
      cacheRefElement(context.evalNode("cache-ref"));
      cacheElement(context.evalNode("cache"));
      parameterMapElement(context.evalNodes("/mapper/parameterMap"));
      resultMapElements(context.evalNodes("/mapper/resultMap"));
      sqlElement(context.evalNodes("/mapper/sql"));
      buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing Mapper XML. Cause: " + e, e);
    }
  }

第3行的代码获取当前mapper文件的namespace，namespace是一个很重要的属性，所有的<sql>、<resultMap>、<insert>、<delete>、<update>、<select>标签，它们的id都是和namespace绑定的，从而确保全局的唯一性，当namespace未定义或者为空字符串的时候，第5行就会抛出异常，因此每个mapper文件的namespace都是一个必填内容。

第7行的代码在MapperBuilderAssistant中设置了一下namespace，这样后文可以通过MapperBuilderAssistant拿namespace而不需要每次传一个String类型的参数。

第8行~第13行的代码分别用于解析<cache-ref>、<cache>、<parameterMap>、<resultMap>、<sql>、<select>、<insert>、<update>、<delete>这几个标签，逐个看一下：

  • cacheRefElement方法用于解析<cache-ref>标签，总结如下：
  1. 解析完的CacheRef放在cacheRefMap中
  2. cacheRefMap是一个HashMap
  3. 位于Configuration对象中
  4. Key为mapper文件的namespace，Value为<cache-ref>中配置的namespace
  • cacheElement方法用于解析<cache>标签，总结如下：
  1. 会根据<cache>中配置的属性new出一个org.apache.ibatis.cache.Cache
  2. 使用此Cache作为MyBatis缓存
  • parameterMapElement方法用于解析<parameterMap>标签，总结如下：
  1. 解析完的ParameterMap放在parameterMaps中
  2. parameterMaps是一个StrictMap
  3. 位于Configuration对象中，StrictMap是HashMap的子类
  4. Key为当前mapper的namespace+"."+<parameterMap>标签中的id属性，Value为ParameterMap对象
  • resultMapElements方法用于解析<resultMap>标签在，总结如下：
  1. 解析完的ResultMap放在resultMaps中
  2. resultMaps是一个StrictMap，
  3. 位于Configuration对象中
  4. Key为当前mapper的namespace+"."+<resultMap>标签中的id属性，Value为ResultMap对象
  • sqlElement方法用于解析<sql>标签，总结如下：
  1. 解析完的内容放在sqlFragments中
  2. sqlFragments是一个StrictMap
  3. 位于XMLMapperBuilder对象中
  4. Key为当前mapper的namespace+"."+<sql>标签中的id属性，Value为sql这个XNode本身
  • buildStatementFromContext用于解析<select>、<insert>、<update>、<delete>这四个标签，总结如下：
  1. 解析完的内容放在mappedStatements中
  2. mappedStatements是一个StrictMap
  3. 位于Configuration对象中
  4. Key为当前mapper的namespace+"."+<select>|<insert>|<update>|<delete>标签中的id属性，Value为MappedStatement对象

构建SqlSessionFactory

最后一步，构建SqlSessionFactory，回看前面SqlSessionFactoryBuilder的build方法：

public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        reader.close();
      } catch (IOException e) {
        // Intentionally ignore. Prefer previous error.
      }
    }
  }

第4行方法的parser.parse()这句之前一直在分析，将配置文件转换为了MyBatis中定义的各种对象且绝大部分配置存储在Configuration中，少部分配置存储在XMLConfigBuilder的父类BaseBuilder中。

接着就是外层的build方法了，看下实现：

 public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
  }
最终构建出来的SqlSessionFactory是DefaultSqlSessionFactory，以Configuration对象为形参。






评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值