辽宁吴奇隆
辽宁吴奇隆

详解mybatis动态SQL

什么是动态SQL？

  • 动态 SQL 是 MyBatis 的强大特性之一。顾名思义，就是会动的SQL，即是能够灵活的根据某种条件拼接出完整的SQL语句。这种类似于MySQL中的 case when then else then end.... 这种语法，能够根据某种条件动态的拼接出需要的SQL。
  • 至于Mybatis如何实现动态SQL呢，Mybatis提供了非常多的标签，能够让我们在XML文件中灵活的运用这些标签达到拼接SQL的目的。

常用的标签

  • Mybatis为了能够让开发者灵活的写SQL也是费了一番功夫，定义了很多的标签和语法，下面将会一一介绍。

if

  • 虽然英文不太好，但是在这么简单的不会不知道是 如果 的意思吧，Java语法中也有，只有判断条件为 true 才会执行其中的SQL语句。
  • 举个栗子：HIS系统中医护人员需要根据特定条件筛选患者，比如住院号，床位，性别等。当然这些条件并不是必填的，具体的功能截图如下:

    1025×60

  • 以上截图中的条件筛选并不是必填的，因此我们不能在SQL中固定，要根据前端是否传值来判断是否需要加上这个条件。那么此时查询语句如何写呢？如下：
  •  标签中的属性 test 用来指定判断条件，那么问题来了，上面的例子中的 test 中判断条件都是一个条件，如果此时变成两个或者多个条件呢？和SQL的语法类似， and 连接即可，如下：
  
      and bed_num=#{bedNum}

choose、when、otherwise

  • 有时候，我们不想使用所有的条件，而只是想从多个条件中选择一个使用。针对这种情况，MyBatis 提供了 choose 元素，它有点像 Java 中的 switch 语句。
  • 还是上面的例子改变一下：此时只能满足一个筛选条件，如果前端传来住院号就只按照住院号查找，如果传来床位号就只按照床位号筛选，如果什么都没传，就筛选所有在院的。此时的查询如下：
  • MyBatis 提供了 choose 元素，按顺序判断 when 中的条件出否成立，如果有一个成立，则 choose 结束。当 choose 中所有 when 的条件都不满则时，则执行 otherwise 中的 sql。类似于 Java 的 switch 语句， choose 为 switch ， when 为 case ， otherwise 则为 default 。

where

  • 举个栗子：对于 choose 标签的例子中的查询，如果去掉 where 后的 1=1 此时的SQL语句会变成什么样子，有三种可能的SQL，如下：
select * from patient_info where AND ipt_num=#{iptNum};

select * from patient_info where AND bed_num = #{bedNum};

select * from patient_info where AND status=1;
  • 发生了什么，以上三条SQL语句对吗？很显然是不对的，显然 where 后面多了个 AND 。如何解决呢？此时就要用到 where 这个标签了。
  • where 元素只会在子元素返回任何内容的情况下才插入 WHERE 子句。而且，若子句的开头为 AND 或 OR ， where 元素也会将它们去除。
  • 此时的查询改造如下：

foreach

  • foreach 是用来对集合的遍历，这个和Java中的功能很类似。通常处理SQL中的 in 语句。
  • foreach 元素的功能非常强大，它允许你指定一个集合，声明可以在元素体内使用的集合项（ item ）和索引（ index ）变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素也不会错误地添加多余的分隔符
  • 你可以将任何可迭代对象（如 List 、 Set 等）、 Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时， index 是当前迭代的序号， item 的值是本次迭代获取到的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时， index 是键， item 是值。
  • 例子如下：
  • 改标签中的各个属性的含义如下：
属性 含义
item 表示在迭代过程中每一个元素的别名
index 表示在迭代过程中每次迭代到的位置（下标）
open 前缀
close 后缀
separator 分隔符，表示迭代时每个元素之间以什么分隔

set

  • 讲这个标签之前，先看下面这个例子：

    UPDATE STUDENT
    SET NAME = #{name},
    MAJOR = #{major},
    HOBBY = #{hobby}
    WHERE ID = #{id};



    UPDATE STUDENT SET
    
        NAME = #{name},
    
    
        MAJOR = #{major},
    
    
        HOBBY = #{hobby}
    
    WHERE ID = #{id};
  • 上面的例子中没有使用 if 标签时，如果有一个参数为 null ，都会导致错误。当在 update 语句中使用 if 标签时，如果最后的 if 没有执行，则或导致逗号多余错误。使用 set 标签可以将动态的配置 set 关键字，和剔除追加到条件末尾的任何不相关的逗号。
  • 使用 set+if 标签修改后，如果某项为 null 则不进行更新，而是保持数据库原值。此时的查询如下：

    UPDATE STUDENT
    
        
            NAME = #{name},
        
        
            MAJOR = #{major},
        
        
            HOBBY = #{hobby}
        
    
    WHERE ID = #{id};

sql

  • 在实际开发中会遇到许多相同的SQL，比如根据某个条件筛选，这个筛选很多地方都能用到，我们可以将其抽取出来成为一个公用的部分，这样修改也方便，一旦出现了错误，只需要改这一处便能处处生效了，此时就用到了  这个标签了。
  • 当多种类型的查询语句的查询字段或者查询条件相同时，可以将其定义为常量，方便调用。为求  SELECT FROM student
    • refid 这个属性就是指定  标签中的 id 值（唯一标识）。

    总结

    • 至此，Mybatis动态SQL中常用的标签就已经介绍完了，这部分的内容在实际工作中是必须会用到的，除非你们公司不用Mybatis。

    拓展一下

    • 前面介绍了动态SQL的一些标签以及属性，相信看完之后应该能够灵活的应用了，但是在实际开发中还是有一些奇技淫巧的，陈某今天简单的讲几个。

    Mybatis中如何避免魔数

    • 开过阿里巴巴开发手册的大概都知道代码中是不允许出现 魔数 的，何为 魔数 ？简单的说就是一个数字，一个只有你知道，别人不知道这个代表什么意思的数字。通常我们在Java代码中都会定义一个常量类专门定义这些数字。
    • 比如获取医生和护士的权限，但是医生和护士的权限都不相同，在这条SQL中肯定需要根据登录的类型 type 来区分，比如 type=1 是医生， type=2 是护士，估计一般人会这样写：
    
    -- ....获取医生的权限



    -- ....获取护士的权限
    • 这样写也没什么错，但是一旦这个 type 代表的含义变了，那你是不是涉及到的SQL都要改一遍。
    • 开发中通常定义一个常量类，如下：
    package com.xxx.core.Constants;
public class CommonConstants{
  //医生
  public final static int DOC_TYPE=1;
  
  //护士
  public final static int NUR_TYPE=2;
  
}
    • 那么此时的SQL应该如何写呢？如下：
    
    -- ....获取医生的权限



    -- ....获取护士的权限
    • 就是这么简单，就是 @ + 全类名 + @ + 常量 。
    • 除了调用常量类中的常量，还可以类中的方法，很少用到，不再介绍了，感兴趣的可以问下度娘。

    如何引用其他XML中的SQL片段

    • 实际开发中你可能遇到一个问题，比如这个 resultMap 或者这个  片段已经在另外一个 xxxMapper.xml 中已经定义过了，此时当前的xml还需要用到，难不成我复制一份？小白什么也不问上来就复制了，好吧，后期修改来了，每个地方都需要修改了。难受不？
    • 其实Mybatis中也是支持引用其他Mapper文件中的SQL片段的。其实很简单，比如你在 com.xxx.dao.xxMapper 这个Mapper的XML中定义了一个SQL片段如下：
    
    ID,MAJOR,BIRTHDAY,AGE,NAME,HOBBY
    • 此时我在 com.xxx.dao.PatinetMapper 中的XML文件中需要引用，如下：
    • 如此简单，类似于Java中的全类名。