ORM框架之Mybatis(二):映射文件

上一篇博客写的是Mybatis基础配置文件(ORM框架之Mybatis:基础配置)。这一篇我们来聊一聊Mybatis的映射文件。

Mybatis的mapper映射文件中有很多常用的标签,如insertupdatedeleteselectresultMapsql等,也会有很多属性,如resultTypereusltMapparameterTypeparameterMapuseGeneratedKeyskeyProperty等。相信这些在项目都有使用,但是这里还是要梳理一下(知识体系都是在不断梳理中完善和获得新知)。

下面就直入主题啦!

insert标签

<insert id="batchInsert" parameterType="com.zdydoit.dao.model.User" useGeneratedKeys="true" keyProperty="id">
        insert into t_user
        (
            user_name,
            phone,
            age
        )
        values
        (
            #{userName},
            #{phone},
            #{age}
         )
    </insert>
标签的属性
属性 描述
id 命名空间中的唯一标识符,可被用来代表这条语句。
parameterType 将要传入语句的参数的完全限定类名或别名。这个属性是可选的,因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数,默认值为 unset。
parameterMap 这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
flushCache 将其设置为 true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,默认值:true(对应插入、更新和删除语句)。
timeout 这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为 unset(依赖驱动)。
statementType STATEMENT,PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。
useGeneratedKeys (仅对 insert 和 update 有用)这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键(比如:像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段),默认值:false。
keyProperty (仅对 insert 和 update 有用)唯一标记一个属性,MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值,默认:unset。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。
keyColumn (仅对 insert 和 update 有用)通过生成的键值设置表中的列名,这个设置仅在某些数据库(像 PostgreSQL)是必须的,当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。
databaseId 如果配置了 databaseIdProvider,MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句;如果带或者不带的语句都有,则不带的会被忽略。
主要属性说明

insert标签本身没有什么可说的,这里来主要的说明一下属性。

  • parameterType参数类型,指定传入参数的类型,这里使用的全类名,同样也可以使用别名(需要在配置文件配置别名规则)。
  • useGeneratedKeys使用自动生成主键,这个属性要和keyProperty配合使用,用来将插入数据自动增长的id返回回来,这里还有另一种使用方式。如下:
<selectKey order="AFTER" keyProperty="id" resultType="java.lang.Integer">
    SELECT LAST_INSERT_ID()
</selectKey>

这句话用在insert标签内,insert语句前。作用与useGeneratedKeyskeyProperty配置使用的效果一样。由于使用的数据库不同,对应的selectKey标签属性和内容都是不一样的。上面的是MySQL的获取方式,下面展示一下Oracle的获取方式:

<selectKey order="BEFORE" keyProperty="id" resultType="java.lang.Integer">
    SELECT SEQ_USER_ID.nextval from dual
</selectKey>

变化是在order上和SQL语句上。order字段,当在MySQL数据的时候,是先做数据插入再返回对应的id,当是Oracle时,是先拿到id,再做数据的插入,这是不同数据库执行的一种机制。

insert标签下面还有类似姊妹的属性,parameterMapparameterType的姊妹属性,但是实际使用是有很大差别的。在传入的参数使用Map封装的时候,就使用parameterMap来指定,在获取的时候,直接写Map中的key就可以。但是这种方式已经很少有用的了,原因有很多。第一代码冗余,在正常的开发习惯中,涉及到多参数,业务代码中都是使用实体对象来传递,如果这里再使用Map,还要有一段实体对象转成Map集合的代码;第二维护性差,这种写法存在一定的耦合性,在别人熟悉代码的过程中很痛苦,只看接口完全不懂这个接口传入的参数,还要去看调用这个接口的业务代码,才能了解字段Map集合中到底封装的是什么内容。所以这里只是提一下,知道就好,基本没人用。

insert其他属性,statementType是用来指定sql执行的statement类型,这个如果对原生JDBC代码有了解的可以知道,常用的statement有PreparedStatementStatementCallableStatement,这里就是指定使用哪一个。提供的可选值有三个CALLABLEPREPAREDSTATEMENT。有兴趣的可以研究一下这个字段,这里不多说,采用默认的(PREPARED)就好。其他的后面再总结。

select标签

在SQL语句里面,select标签可以说是占据了半壁江山之多,而且select标签的属性也是最多的。

<select id="11" parameterType="java.lang.Integer" resultType="com.zdydoit.dao.model.User">
    select * from t_user where id = #{id}
</select>
标签的属性
属性 描述
id 在命名空间中唯一的标识符,可以被用来引用这条语句。
parameterType 将会传入这条语句的参数类的完全限定名或别名。这个属性是可选的,因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数,默认值为 unset。
parameterMap 这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
resultType 从这条语句中返回的期望类型的类的完全限定名或别名。注意如果是集合情形,那应该是集合可以包含的类型,而不能是集合本身。使用 resultType 或 resultMap,但不能同时使用。
resultMap 外部 resultMap 的命名引用。结果集的映射是 MyBatis 最强大的特性,对其有一个很好的理解的话,许多复杂映射的情形都能迎刃而解。使用 resultMap 或 resultType,但不能同时使用。
flushCache 将其设置为 true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,默认值:false。
useCache 将其设置为 true,将会导致本条语句的结果被二级缓存,默认值:对 select 元素为 true。
timeout 这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为 unset(依赖驱动)。
fetchSize 这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset(依赖驱动)。
statementType STATEMENT,PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。
resultSetType FORWARD_ONLY,SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个,默认值为 unset (依赖驱动)。
databaseId 如果配置了 databaseIdProvider,MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句;如果带或者不带的语句都有,则不带的会被忽略。
resultOrdered 这个设置仅针对嵌套结果 select 语句适用:如果为 true,就是假设包含了嵌套结果集或是分组了,这样的话当返回一个主结果行的时候,就不会发生有对前面结果集的引用的情况。这就使得在获取嵌套的结果集的时候不至于导致内存不够用。默认值:false
resultSets 这个设置仅对多结果集的情况适用,它将列出语句执行后返回的结果集并每个结果集给一个名称,名称是逗号分隔的。
主要属性说明

parameterTypeparameterMap与在insert标签内使用的方法是相同的。

resultType结果类型,这里使用全类名,也是可以同parameterType一样用别名,需要在配置文件中配置别名规则。这里需要详细说的是其姊妹属性resultMap

resultMap标签

这个标签可以用的很复杂,也可以用的很简单,这篇文章是偏重了解基础,所以只做简单的说明,后期在深入的时候再具体说其复杂的用法。

<resultMap id="base_column_map" type="com.zdydoit.dao.model.User">
    <id column="id" property="id"/>
    <result column="user_name" property="userName"/>
    <result column="phone" property="phone"/>
    <result column="age" property="age"/>
</resultMap>

最简单的写法,用id标签指定主键,用result标签指定各列的对应关系,不论id还是result标签,都有jdbcTypejavaTypetypeHandler,这些字段都是可选字段。jdbcType这个表示JDBC的类型,有的人习惯写,但是不写也没有影响,显然我是懒人。同样javaType也可以不写。不过jdbcTypejavaType这些对应关系可以在TypeHandlerRegistry找到,可以打开这个类看一下,一目了然。

最后typeHandler就是类型处理器,因为有的自定义类型可能在mybatis中没有对应关系,如自定义的枚举,这个时候就要手动写类型转换的处理器,需要在特定的字段上配置此处理器,但是一般用的很少,这个不多做介绍,以后有机会再单独开个博客来说说这个事。

这里再说一个子标签,那就是constructor构造器,一般用在实体类中没有无参构造方法的时候。

<resultMap id="base_column_map" type="com.zdydoit.dao.model.User">
    <constructor>
        <idArg column="id" name="id"/>
        <arg column="user_name" name="userName"/>
    </constructor>
    <result column="phone" property="phone"/>
    <result column="age" property="age"/>
</resultMap>

因为在给实体类参数设值的时候,首先是要创建对象,mybatis默认的是根据无参构造方法创建,但是如果这个实体类中有有参构造方法,且没有手写无参构造,就会导致mybatis创建对象失败。所以这里提供了构造方法的标签,用来指定用那个构造方法创建对象。

sql标签

sql标签很简单,就是做SQL公共片段的抽取,就像java里面的公共代码抽取一样。如下:

<sql id="base_column">
    id,user_name,phone,age
</sql>
<!-- 根据ID查询用户 -->
<select id="selectById" resultType="com.zdydoit.dao.model.User">
    select <include refid="base_column"/> from t_user where id = #{id}
</select>
<!-- 根据手机号码查询用户 -->
<select id="selectByPhone" resultType="com.zdydoit.dao.model.User">
    select <include refid="base_column"/> from t_user where phone = #{phone}
</select>

这样抽取以后就不需要重复的写列名了,是一种优化配置文件一种很好的方式,也很好理解。

udpate、delete标签

这两个标签没有太多的内容可说的,所用到的属性上面也都说过和列出,因为重复的东西就没有多说。

本文作者:程序猿杨鲍
版权归作者所有,转载请注明出处

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容