`
blue2048
  • 浏览: 183077 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

深入浅出MyBatis-MapperBuilder

阅读更多

转自 http://blog.csdn.net/hupanfeng/article/details/9098453

 

上一章节说道,解析mybatis的配置文件的最后一步是解析mapper元素。每个mapper元素对应一个mapper配置文件,这一章节就来讲讲这个mapper配置文件是如何解析的。

Mapper文件里有什么

mapper配置文件是配置sql映射的地方,它看起来就像下面这个样子:

 

[html] view plaincopy
 
  1. <?xml version="1.0" encoding="UTF-8" ?>  
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">  
  3. <mapper namespace="org.iMybatis.abc.dao.UserDao">  
  4.     <cache type="PERPETUAL" eviction="LRU" flushInterval="60000"  
  5.         size="512" readOnly="true" />  
  6.     <resultMap id="userResultMap" type="UserDto">  
  7.         <id property="userid" column="userid" />  
  8.         <result property="username" column="username" />  
  9.         <result property="password" column="password" />  
  10.     </resultMap>  
  11.     <sql id="userColumns"> userid,username,password </sql>  
  12.     <select id="queryUsers" parameterType="UserDto" resultType="UserDto"  
  13.         useCache="false">  
  14.         select <include refid="userColumns" />  
  15.         from t_user t where t.username = #{username}  
  16.     </select>  
  17.     <insert id="insertUser" parameterType="UserDto"  
  18.         useGeneratedKeys="true" keyProperty="userid">  
  19.         insert into t_user (userid,username,password)  
  20.         values (#{userid},#{username},#{password})  
  21.     </insert>  
  22.     <update id="updateUser" parameterType="UserDto">  
  23.         update t_user set  
  24.         username= #{username},  
  25.         password = #{password},  
  26.         where userid = #{userid}  
  27.     </update>  
  28.     <delete id="deleteUser" parameterType="UserDto">  
  29.         delete from t_user where userid = #{userid}  
  30.     </delete>  
  31. </mapper>  

 

 

Mapper元素只有一个属性namespace,它有两个作用:一是用于区分不同的mapper(在不同的mapper文件里,子元素的id可以相同,mybatis通过namespace和子元素的id联合区分),二是与接口关联(应用程序通过接口访问mybatis时,mybatis通过接口的完整名称查找对应的mapper配置,因此namespace的命名务必小心一定要某接口同名)。此外,mapper配置文件还有几个顶级子元素(它们须按照顺序定义):

cache -配置本定命名空间的缓存。

cache-ref –从其他命名空间引用缓存配置。

resultMap –结果映射,用来描述如何从数据库结果集映射到你想要的对象。

parameterMap –已经被废弃了!建议不要使用,本章也不会对它进行讲解。

sql –可以重用的SQL块,可以被其他数据库操作语句引用。

insert|update|delete|select–数据库操作语句

Mapper的解析在XMLMapperBuilder里完成,主要通过configurationElement方法完成解析,在configurationElement内部调用各个元素的子解析方法完成解析。

下面分别介绍这些子元素。

子元素之cache

1.       配置示例

 

[html] view plaincopy
 
  1. <cache type="PERPETUAL" eviction="LRU"flushInterval="60000" size="512"readOnly="true" />  

 

l        type-cache实现类,默认为PERPETUAL可以使用自定义的cache实现类(别名或完整类名皆可)

l        eviction-回收算法,默认为LRU可选的算法有:

                  LRU– 最近最少使用的:移除最长时间不被使用的对象。

                 FIFO– 先进先出:按对象进入缓存的顺序来移除它们。

                 SOFT– 软引用:移除基于垃圾回收器状态和软引用规则的对象。

                 WEAK– 弱引用:更积极地移除基于垃圾收集器状态和弱引用规则的对象。

l        flushInterval-刷新间隔,默认为1个小时,单位毫秒

l        size-缓存大小,默认大小1024,单位为引用数

l        readOnly-只读

2.        解析

cacheElement方法负责解析cache元素,它通过调用CacheBuilder的相应方法完成cache的创建。每个cache内部都有一个唯一的ID,这个id的值就是namespace。创建好的cache对象存入configuration的cache缓存中(该缓存以cache的ID属性即namespace为key,这里再次体现了mybatis的namespace的强大用处)

子元素之cache-ref

1.       配置示例

 

[html] view plaincopy
 
  1. <cache-ref namespace="com.someone.application.data.SomeMapper"/>  

 

如果你不想定义自己的cache,可以使用cache-ref引用别的cache。因为每个cache都以namespace为id,所以cache-ref只需要配置一个namespace属性就可以了。需要注意的是,如果cache-refcache都配置了,以cache为准。

2.        解析

cacheRefElement方法负责解析cache-ref元素,它通过调用CacheRefResolver的相应方法完成cache的引用。创建好的cache-ref引用关系存入configuration的cacheRefMap缓存中。

子元素之resultMap

1.       配置示例

[html] view plaincopy
 
  1. <resultMap id="userResultMap" type="User">  
  2.     <id property=" userid " column="userid" />  
  3.     <result property="username" column="username" />  
  4.     <result property="password" column="password" />  
  5.       </resultMap>  

resultMap提供了从数据库表列名到java对象属性的映射管理,示例只是提供了最简单的情况,resultMap能做的不仅仅是示例中这么点(作者不喜欢使用resultMap完成结果的复杂映射,相反更喜欢结果和对象的直接映射)。在mapper配置文件中可以配置多个resultMap,不同的resultMap用id加以区分。type属性标记java类型(别名)。子元素中的property指带java中的属性,column指带数据库表的列名。

2.        解析

resultMapElement方法负责解析resultMap元素,它通过调用ResultMapResolver的相应方法完成resultMap的解析。创建好的resultMap存入configuration的resultMaps缓存中(该缓存以namespace+resultMap的id为key,这里再次体现了mybatis的namespace的强大用处)。

子元素之sql

1.       配置示例

 

[html] view plaincopy
 
  1. <sql id="userColumns"> userid,username,password</sql>  

 

这个元素可以被用来定义可重用的SQL代码段,可以包含在其他语句中。例如:

[html] view plaincopy
 
  1. <select id="queryUsers" parameterType="UserDto" resultType="UserDto" useCache="false">  
  2.     select <include refid="userColumns"/> from t_user t where t.username = #{username}  
  3.        </select>  

2.        解析

sqlElement方法负责解析sql元素。id属性用于区分不同的sql元素,在同一个mapper配置文件中可以配置多个sql元素。

子元素之statement

1.       配置示例

作为数据库访问的statement元素包含4种类型:insert、update、delete、query。其中前3者可以归为一类,query单独为一类,下面分开讲解。

1)       select

[html] view plaincopy
 
  1. <select id="queryUsers" parameterType="UserDto" resultType="UserDto" useCache="false">  
  2.     select <include refid="userColumns"/> from t_user t where t.username = #{username}  
  3.       </select>  

select元素有很多属性允许配置,来决定每条语句的作用细节,如下:

属性

描述

id

在命名空间中唯一的标识符,可以被用来引用这条语句。同样,id+namespace既作为configuration中缓存的key又与namespace对应的接口中的方法关联。

parameterType

将会传入这条语句的参数类的完全限定名或别名。

parameterMap

已废弃。

resultType

从这条语句中返回的期望类型的类的完全限定名或别名。注意集合情形,那应该是集合可以包含的类型,而不能是集合本身(是否使用集合由id对应的方法的返回类型决定)。使用resultType或resultMap,但不能同时使用。

resultMap

引用外部的resultMap。使用resultMap或resultType,但不能同时使用。

flushCache

将其设置为true,不论语句什么时候被调用,都会导致缓存被清空。默认值:false。

useCache

将其设置为true,将会导致本条语句的结果被缓存。默认值:true。

timeout

这个设置驱动程序等待数据库返回请求结果,并抛出异常时间的最大等待值。默认不设置(驱动自行处理)。

fetchSize

这是暗示驱动程序每次批量返回的结果行数。默认不设置(驱动自行处理)。

statementType

STATEMENT,PREPARED或CALLABLE的一种。这会让MyBatis使用选择使用Statement,PreparedStatement或CallableStatement。默认值:PREPARED。

resultSetType

FORWARD_ONLY|SCROLL_SENSITIVE|SCROLL_INSENSITIVE中的一种。默认是不设置(驱动自行处理)。

 

2)       insertudpatedelete

[html] view plaincopy
 
  1. <insert id="insertUser" parameterType="UserDto" useGeneratedKeys="true" keyProperty="userid">  
  2.     insert into t_user (userid,username,password)  
  3.     values (#{userid},#{username},#{password})  
  4. </insert>  
  5. <update id="updateUser" parameterType="UserDto">  
  6.     update t_user set  
  7.     username = #{username},  
  8.     password = #{password},  
  9.     where userid = #{userid}  
  10. </update>  
  11. <delete id="deleteUser" parameterType="UserDto">  
  12.     delete from t_user where userid = #{userid}  
  13.       </delete>  

属性说明如下:

属性

描述

id

在命名空间中唯一的标识符,可以被用来引用这条语句。同样,id+namespace既作为configuration中缓存的key又与namespace对应的接口中的方法关联。

parameterType

将会传入这条语句的参数类的完全限定名或别名。

parameterMap

已废弃。

flushCache

将其设置为true,不论语句什么时候被调用,都会导致缓存被清空。默认值:false。

timeout

这个设置驱动程序等待数据库返回请求结果,并抛出异常时间的最大等待值。默认不设置(驱动自行处理)。

statementType

STATEMENT,PREPARED或CALLABLE的一种。这会让MyBatis使用选择使用Statement,PreparedStatement或CallableStatement。默认值:PREPARED。

useGeneratedKeys

(仅对insert有用)这会告诉MyBatis使用JDBC的getGeneratedKeys方法来取出由数据(比如:像MySQL和SQL Server这样的数据库管理系统的自动递增字段)内部生成的主键。默认值:false。

keyProperty

(仅对insert有用)标记一个属性,MyBatis会通过getGeneratedKeys或者通过insert语句的selectKey子元素设置它的值。默认:不设置。

 

3)       selectKey

[html] view plaincopy
 
  1. <selectKey keyProperty="userid" resultType="int" order="BEFORE">  
  2.      select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1  
  3. </selectKey>  

selectKey给了你一个简单的行为在你的数据库中来处理自动生成的主键,而不需要使你的Java代码变得复杂。在上面的示例中,selectKey元素将会首先运行,userid会被设置,然后插入语句会被调用。另外,selectKey节点生成的KeyGenerator优先级高于statement节点的useGeneratedKeys属性生成的KeyGenerator对象,也就是说配置了SelectKey子节点就不需要再配置useGeneratedKeys属性了。属性说明如下:

属性

描述

keyProperty

selectKey语句结果设置的目标属性。

resultType

结果的类型。MyBatis允许任何简单类型用作主键的类型,包括字符串。

order

这可以被设置为BEFORE或AFTER。如果设置为BEFORE,那么它会首先选择主键,设置keyProperty然后执行插入语句。如果设置为AFTER,那么先执行插入语句,然后是selectKey元素-这和如Oracle数据库相似,可以在插入语句中嵌入序列调用。

statementType

和前面的相同,MyBatis支持STATEMENT,PREPARED和CALLABLE语句的映射类型,分别代表PreparedStatement和CallableStatement类型。

 

2.        解析

buildStatementFromContext方法负责解析statement元素。id属性用于区分不同的statement元素,在同一个配置文件中可以配置多个statement元素。通过调用XMLStatementBuilder的parseStatementNode方法完成解析。在这个方法内有几个重要的步骤,理解他们对正确的配置statement元素很有帮助。

1)       动态解析子元素

statement节点可以配置各种子元素,比如前面提到的include子元素和selectKey子元素等(在动态sql里还有更多的子元素,具体参考mybatis的官方文档)。动态解析子元素通过parseDynamicTags方法完成。该方法根据子元素的类型递归的解析成一个个的SqlNode,这些SqlNode对象提供了apply方法,供后续调用时生成sql语句所需。需要注意的是SelectKey没有对应的SqlNode对象,因为它的功能是用来生成KeyGenerator对象的(具体来说是SelectKeyGenerator对象)。另外,SelectKey节点生成的KeyGenerator优先级高于statement节点的useGeneratedKeys属性生成的KeyGenerator对象,也就是说配置了SelectKey子节点就不需要再配置useGeneratedKeys属性了。

2)       生成SqlSource

SqlSource用于后续调用时根据SqlNode和参数对象生成sql语句。它接收一个叫做rootsqlNode的对象作为构造参数。

3)       生成KeyGenerator

如果配置了selectKey子元素,KeyGenerator直接使用selectKey子元素里生成的KeyGenerator对象(具体来说是SelectKeyGenerator对象)。若没配置,则如果useGeneratedKeys属性的值为"true"且配置了 keyProperty属性,则生成默认的Jdbc3KeyGenerator对象,该对象调用JDBC驱动的getGeneratedKeys方法返回insert语句执行后生成的自增长主键。

4)       创建MappedStatement

MappedStatement对象封装了statement元素的所有属性以及子节点值,MappedStatement对象有一个id属性用于唯一标记它,这个id由namespace加statement元素的id属性值构成。创建好的MappedStatement对象存入Configuration对象的mappedStatements缓存中,key为MappedStatement对象的id值。

注册mapper类型

我们知道每个mapper配置文件的namespace属性对应于某个接口,应用程序通过接口访问mybatis时,mybatis会为这个接口生成一个代理对象,这个对象就叫mapper对象,在生成代理对象前mybatis会校验接口是否已注册,未注册的接口会产生一个异常。为了避免这种异常,就需要注册mapper类型。这个步骤是在XMLMapperBuilder的bindMapperForNamespace方法中完成的。它通过调用Configuration对象的addMapper方法完成,而Configuration对象的addMapper方法是通过MapperRegistry的addMapper方法完成的,它只是简单的将namespace属性对应的接口类型存入本地缓存中。

Configuration对象提供了一个重载的addMappers(StringpackageName)方法,该方法以包路径名为参数,它的功能是自动扫描包路径下的接口并注册到MapperRegistry的缓存中,同时扫描包路径下的mapper配置文件并解析之。解析配置文件是在MapperAnnotationBuilder类的parse方法里完成的,该方法先解析配置文件,然后再解析接口里的注解配置,且注解里的配置会覆盖配置文件里的配置,也就是说注解的优先级高于配置文件,这点需要注意。采用自动扫描会大大简化配置,只不过需要应用程序自己调用,mybatis默认是不会调用这个方法的(后续将会讲解的spring集成mybatis就用到了自动扫描,敬请期待)。

分享到:
评论

相关推荐

    mybatis-plus最新代码生成器项目源码 :mybatis-plus-generator.zip

    mybatis-plus最新代码生成器项目源码 :mybatis-plus-generator.zip mybatis-plus最新代码生成器项目源码 :mybatis-plus-generator.zip mybatis-plus最新代码生成器项目源码 :mybatis-plus-generator.zip ...

    MyBatis-Plus 的官方示例(mybatis-plus-samples-master.zip)

    本工程为 MyBatis-Plus 的官方示例,项目结构如下: mybatis-plus-sample-quickstart: 快速开始示例 mybatis-plus-sample-quickstart-springmvc: 快速开始示例(Spring MVC版本) mybatis-plus-sample-reduce-...

    MyBatis-Plus入门+MyBatis-Plus文档手册 中文pdf高清版.rar

    mybatis在持久层框架中还是比较火的,一般项目都是基于ssm。虽然mybatis可以直接在xml中...《MyBatis-Plus入门文档》主要介绍了MyBatis-Plus入门使用,以及关于mybatis-plus的更多介绍及特性,感兴趣的可以下载学习一下

    mybatis-3-config.dtd mybatis-3-mapper.dtd

    首先,让我们深入了解一下`mybatis-3-config.dtd`。这个文件是MyBatis配置文件的DTD,它规定了`mybatis-config.xml`文件中的元素和属性。`mybatis-config.xml`是MyBatis的核心配置文件,它包含了全局设置,如数据源...

    开发工具 mybatis-3.4.2

    开发工具 mybatis-3.4.2开发工具 mybatis-3.4.2开发工具 mybatis-3.4.2开发工具 mybatis-3.4.2开发工具 mybatis-3.4.2开发工具 mybatis-3.4.2开发工具 mybatis-3.4.2开发工具 mybatis-3.4.2开发工具 mybatis-3.4.2...

    mybatis-plus-boot-starter-3.5.1-API文档-中文版.zip

    赠送jar包:mybatis-plus-boot-starter-3.5.1.jar; 赠送原API文档:mybatis-plus-boot-starter-3.5.1-javadoc.jar; 赠送源代码:mybatis-plus-boot-starter-3.5.1-sources.jar; 赠送Maven依赖信息文件:mybatis-...

    mybatis-generator-config_1_0.dtd

    mybatis-generator-config_1_0.dtd文件存在于mybatis-generator-core-1.3.2.jar包中,路径如下org/mybatis/generator/config/xml/mybatis-generator-config_1_0.dtd 可以设置开发工具的dtd配置,配置...

    mybatis-spring-1.3.1.jar下载

    MyBatis-Spring 1.3.1 是一个重要的Java库,它为MyBatis持久层框架和Spring框架提供了一座桥梁,使得两个强大的库能够无缝集成。这个版本的jar文件是开发者在使用MyBatis与Spring进行项目开发时必不可少的组件。下面...

    mybatis-plus3.5.2 jar包

    mybatis-plus3.5.2常用jar包,mybatis-plus-3.5.2.jar、mybatis-plus-annotation-3.5.2.jar、mybatis-plus-core-3.5.2.jar、mybatis-plus-extension-3.5.2.jar、mybatis-plus-generator-3.5.2.jar和源码包mybatis-...

    mybatis-plus-extension-3.5.1-API文档-中英对照版.zip

    赠送jar包:mybatis-plus-extension-3.5.1.jar; 赠送原API文档:mybatis-plus-extension-3.5.1-javadoc.jar; 赠送源代码:mybatis-plus-extension-3.5.1-sources.jar; 赠送Maven依赖信息文件:mybatis-plus-...

    mybatis-spring-2.0.0-API文档-中文版.zip

    赠送jar包:mybatis-spring-2.0.0.jar; 赠送原API文档:mybatis-spring-2.0.0-javadoc.jar; 赠送源代码:mybatis-spring-2.0.0-sources.jar; 赠送Maven依赖信息文件:mybatis-spring-2.0.0.pom; 包含翻译后的API...

    mybatis-plus-annotation-3.5.1-API文档-中文版.zip

    赠送jar包:mybatis-plus-annotation-3.5.1.jar; 赠送原API文档:mybatis-plus-annotation-3.5.1-javadoc.jar; 赠送源代码:mybatis-plus-annotation-3.5.1-sources.jar; 赠送Maven依赖信息文件:mybatis-plus-...

    mybatis-plus 实践及架构原理

    Mybatis-Plus是一款在Mybatis基础上进行增强的优秀工具,它简化了单表的CRUD操作,提高了开发效率,且对原有的SQL操作不做改变。Mybatis-Plus的实践及架构原理主要包含以下几个方面的知识点: 1. Mybatis-Plus的...

    mybatis-plus源码(mybatis-plus-3.5.1.zip)

    此源码包`mybatis-plus-3.5.1.zip`包含了MyBatis-Plus 3.5.1版本的全部源代码,有助于我们深入理解其内部实现机制和工作原理。 MyBatis-Plus的主要功能包括: 1. **CRUD操作**:MyBatis-Plus提供了简化版的CRUD...

    mybatis-spring-2.0.6-API文档-中文版.zip

    赠送jar包:mybatis-spring-2.0.6.jar; 赠送原API文档:mybatis-spring-2.0.6-javadoc.jar; 赠送源代码:mybatis-spring-2.0.6-sources.jar; 赠送Maven依赖信息文件:mybatis-spring-2.0.6.pom; 包含翻译后的API...

    mybatis-plug.jar和 mybatis-plug的安装说明

    MyBatis-Plus是一个强大的扩展库,它是MyBatis框架的增强工具,旨在简化开发,减少常规 CRUD(创建、读取、更新、删除)操作的代码量。在本指南中,我们将详细介绍如何安装和使用mybatis-plus.jar以及相关的mybatis-...

Global site tag (gtag.js) - Google Analytics