Mybatis 常用动态标签

639 阅读3分钟

前言

动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架,你应该能理解根据不同条件拼接 SQL 语句有多痛苦,例如拼接时要确保不能忘记添加必要的空格,还要注意去掉列表最后一个列名的逗号。利用动态 SQL,可以彻底摆脱这种痛苦。

使用动态 SQL 并非一件易事,但借助可用于任何 SQL 映射语句中的强大的动态 SQL 语言,MyBatis 显著地提升了这一特性的易用性。

如果你之前用过 JSTL 或任何基于类 XML 语言的文本处理器,你对动态 SQL 元素可能会感觉似曾相识。在 MyBatis 之前的版本中,需要花时间了解大量的元素。借助功能强大的基于 OGNL 的表达式,MyBatis 3 替换了之前的大部分元素,大大精简了元素种类,现在要学习的元素种类比原来的一半还要少。

大概分为这四种常用的动态标签

元素作用场景
foreach循环语句批量添加或者批量查询
if判断语句单条件分支判断
choose、when、otherwise相当于 Java 中的 switch case default 语句多条件分支判断
trim、where、set辅助元素用于处理一些条件查询

foreach语句

动态 SQL 的另一个常见使用场景是对集合进行遍历(尤其是在构建 IN 条件语句的时候)。

1. 参数解释

  • collection:collection 属性的值有三个分别是 list、array、map 三种,分别对应的参数类型为:List、数组、map 集合。
  • item:表示在迭代过程中每一个元素的别名
  • open:前缀
  • close:后缀
  • separator:分隔符,表示迭代时每个元素之间以什么分隔
  • index:表示迭代中每次迭代到的下标位置

2. 例子演示

 <select id="queryDataByIds" resultType="com.wang.test.demo.entity.User">
    select * from user where id in
     <foreach collection="list" item="item" open="(" separator="," close=")">
         id=#{item}
     </foreach>
 </select>

if语句

使用动态 SQL 最常见情景是根据条件包含 where 子句的一部分。

1. 参数解释

  • test: 是对要判断的字段来写限制条件

2. 例子演示

 <select id="queryDataBySearch" resultType="com.wang.test.demo.entity.User">
    select * from user
    where stage = 'A'
    <if test="age != null and age != ''">
        and age =#{age}
    </if>
    <if test="name != null and name != ''">
        and name =#{name}
    </if>
 </select>

choose、when、otherwise语句

有时候,我们不想使用所有的条件,而只是想从多个条件中选择一个使用。针对这种情况,MyBatis 提供了 choose 元素,它有点像 Java 中的 switch 语句.一个成立则choose结束

1. 参数解释

  • test: 是对要判断的字段来写限制条件

2. 例子演示

 <select id="queryDataBySearchNew" resultType="com.wang.test.demo.entity.User">
     select * from user
     <where>
         <choose>
             <when test="age != null and age != ''">
                 and age =#{age}
             </when>
             <when test="name != null and name != ''">
                 and name =#{name}
             </when>
             <otherwise>
                 stage = 'A'
             </otherwise>
         </choose>
     </where>
 </select>

trim、where、set语句

1. 参数解释

  • prefix:在trim标签内sql语句加上前缀
  • suffix:在trim标签内sql语句加上后缀
  • prefixOverrides:指定去除多余的前缀内容,如:prefixOverrides=“AND”,去除trim标签内sql语句多余的前缀"AND"。
  • suffixOverrides:指定去除多余的后缀内容,suffixOverrides=“OR”,去除trim标签内sql语句多余的前缀"OR"。

2. 例子演示

 <update id="updateById" parameterType="com.wang.test.demo.entity.User">
    update user
     <set>
         <trim suffixOverrides=",">
             <if test="name != null and age != ''">
                 name=#{name},
             </if>
             <if test="age != null and name != ''">
                 age=#{age},
             </if>
         </trim>
     </set>
     where id=#{id}
 </update>
 <update id="updateById1" parameterType="com.wang.test.demo.entity.User">
     update user
     <trim suffixOverrides="," prefix="set">
         <if test="name != null and age != ''">
             name=#{name},
         </if>
         <if test="age != null and name != ''">
             age=#{age},
         </if>
     </trim>
     where id=#{id}
 </update>