MyBatis 动态 SQL 常用功能

使用 jdbc 或类似的框架,动态拼接 SQL 是很痛苦的。比如根据当前日期选择数据表、根据传入的参数决定更新哪些字段等,都是比较常用的动态查询。MyBatis 拥有强大的动态 SQL 功能,可以在任何 SQL 语句中使用。MyBatis 的动态 SQL 主要使用以下几个元素来实现:

单一条件:if

多个条件:choose, when, otherwise

自动封装:trim, where, set

遍历集合:foreach


if  

if 用于检测条件,动态包含 SQL 语句。例如下面的语句中,根据输入的 title 是否为空来决定是否在查询条件中增加 title 搜索条件。

<select id="select" resultType="Person">
    SELECT * FROM Person WHERE state = ‘ACTIVE’  
   <if test="title != null">        AND title like #{title}  
   </if>
</select>

choose, when, otherwise   

choose 元素提供了类似于 Java 语言中的 switch 功能,可以从多个选项中选择一个加入 SQL 语句。

例如下面的语句,使用了两个 when 和一个 otherwise,类似于 switch 中的 case 和 default。

<select id="select" resultType="Person">
    SELECT * FROM Person WHERE state = ‘ACTIVE’  
   <choose>        <when test="title != null">          AND title like #{title}    
       </when>        <when test="sex != null">          AND sex = #{sex}    
       </when>        <otherwise>          AND height = 170
       </otherwise>    </choose>
</select>

trim, where, set   

trim 元素可以用于为 SQL 语句增加前缀、后缀,并去除指定的开头和结尾。一共有四个属性:

prefix:语句的前缀;

prefixOverrides:去除开头;

suffix:语句的后缀;

suffixOverrides:去除结尾。

在下面的语句中,trim 会先删除 somesql 的开头和结尾,然后再增加前缀和后缀。

<trim prefix="前缀" prefixOverrides="去除开头" 
    suffix="后缀" suffixOverrides="去除结尾">
  somesql
</trim>

假设使用 if 语句增加两个动态条件,如下所示。如果只满足第二个条件,或者两个条件都不满足,最终得到的 SQL 是一个有 WHERE 但没有条件的非法 SQL。

<select id="select" resultType="Person">
    SELECT * FROM Person WHERE  
   <if test="sex != null">        sex = #{sex}  
   </if>    <if test="title != null">        AND title like #{title}  
   </if>
</select>

使用 where 元素可以避免这一点,如下所示。where 元素可以检测内部的查询条件是否合法,比如为空、多了 AND / OR,并进行处理使 SQL 语句合法。经过 where 元素处理后,无论内部 if 元素是否成立,我们都可以得到合法的 SQL 语句。

<select id="select" resultType="Person">
    SELECT * FROM Person  
   <where>        <if test="sex != null">            sex = #{sex}    
       </if>        <if test="title != null">            AND title like #{title}    
       </if>    </where>
</select>

同样地,update 语句中也可以使用 set 元素来实现类似于 where 元素的功能。在如下的示例中,set 元素确保了 SQL 语句中的 SET 永远是合法的,它能自动处理 SET 为空、结尾多逗号,并自动拼接 SET 字符串。

<update id="update">
    update Person    
   <set>        <if test="title != null">
           title=#{title},
       </if>        <if test="sex != null">
           sex=#{sex},
       </if>    </set>    where id=#{id}
</update>

foreach   

foreach 用于处理集合,比如批量插入、批量查询条件等情况,支持 List、Array、Set、Map 等。在下面的例子中,查询条件是一个 list,使用 in 来查询。

<select id="select" resultType="Person">
    SELECT * FROM Person WHERE id in  
   <foreach item="item" index="index" collection="list"      open="(" separator="," close=")">        #{item}
   </foreach>
</select>

foreach 的属性定义如下:

Item:集合中元素迭代的别名,如果集合为 map 这里是 value;

index:集合中元素迭代的索引,如果集合为 map 这里是 key;

collection:集合的类型;

open:语句的前缀;

separator:语句的分隔符;

close:语句的后缀。

分享学习笔记和技术总结,内容涉及 Java 进阶、架构设计、前沿技术、算法与数据结构、数据库、中间件等多个领域,欢迎关注。本文首发于微信公众号“后端开发那点事儿”。

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

推荐阅读更多精彩内容