关于MyBatis的动态SQL详解

MyBatis通过 OGNL 来进行动态 SQL 的使用的。目前，动态 SQL 支持以下几种标签：

1 if 标签

if 标签是我们最常使用的。在查询、删除、更新的时候很可能会使用到。必须结合 test 属性联合使用。

1.1 在 WHERE 条件中使用 if 标签

这是常见的一种现象，我们在进行按条件查询的时候，可能会有多种情况。

1.1.1 查询条件

根据输入的学生信息进行条件检索

当只输入用户名时，使用用户名进行模糊检索；

当只输入性别时，使用性别进行完全匹配

当用户名和性别都存在时，用这两个条件进行查询匹配查询

1.1.2 动态 SQL

1.2 在 UPDATE 更新列中使用 if 标签

有时候我们不希望更新所有的字段，只更新有变化的字段。

1.2.1 更新条件

只更新有变化的字段，空值不更新。

1.2.1 动态 SQL


    update student
    
      
        `name` = #{name,jdbcType=VARCHAR},
      
      
        phone = #{phone,jdbcType=VARCHAR},
      
      
        email = #{email,jdbcType=VARCHAR},
      
      
        sex = #{sex,jdbcType=TINYINT},
      
      
        locked = #{locked,jdbcType=TINYINT},
      
      
        gmt_created = #{gmtCreated,jdbcType=TIMESTAMP},
      
      
        gmt_modified = #{gmtModified,jdbcType=TIMESTAMP},
      
    
    where student_id = #{studentId,jdbcType=INTEGER}

1.3 在 INSERT 动态插入中使用 if 标签

我们插入数据库中的一条记录，不是每一个字段都有值的，而是动态变化的。在这时候使用 if 标签，可帮我们解决这个问题。

1.3.1 插入条件

只有非空属性才插入。

1.3.2 动态SQL


    insert into student
    
      
        student_id,
      
      
        `name`,
      
      
        phone,
      
      
        email,
      
      
        sex,
      
      
        locked,
      
      
        gmt_created,
      
      
        gmt_modified,
      
    
    
      
        #{studentId,jdbcType=INTEGER},
      
      
        #{name,jdbcType=VARCHAR},
      
      
        #{phone,jdbcType=VARCHAR},
      
      
        #{email,jdbcType=VARCHAR},
      
      
        #{sex,jdbcType=TINYINT},
      
      
        #{locked,jdbcType=TINYINT},
      
      
        #{gmtCreated,jdbcType=TIMESTAMP},
      
      
        #{gmtModified,jdbcType=TIMESTAMP},

2 choose 标签

choose when otherwise 标签可以帮我们实现 if else 的逻辑。一个 choose 标签至少有一个 when, 最多一个otherwise。

下面是一个查询的例子。

2.1 查询条件

假设 name 具有唯一性，查询一个学生

当 studen_id 有值时，使用 studen_id 进行查询；

当 studen_id 没有值时，使用 name 进行查询；

否则返回空

2.2 动态SQL

3 trim(set、where)

这三个其实解决的是类似的问题。如我们在写前面的[在 WHERE 条件中使用 if 标签] SQL 的时候， where 1=1 这个条件我们是不希望存在的。

3.1 where

3.1.1 查询条件

根据输入的学生信息进行条件检索。

当只输入用户名时，使用用户名进行模糊检索；

当只输入性别时，使用性别进行完全匹配

当用户名和性别都存在时，用这两个条件进行查询匹配查询

不使用 where 1=1。

3.1.2 动态 SQL

很显然，我们要解决这几个问题

当条件都不满足时：此时 SQL 中应该要不能有 where ，否则导致出错
当 if 有条件满足时： SQL 中需要有 where，且第一个成立的 if 标签下的 and | or 等要去掉
这时候，我们可以使用 where 标签。

3.2 set

set 标签也类似，在 [2.2 在 UPDATE 更新列中使用 if 标签] 中，如果我们的方法 updateByPrimaryKeySelective 没有使用

3.3 trim

set 和 where 其实都是 trim 标签的一种类型，该两种功能都可以使用 trim 标签进行实现。

3.3.1 trim 来表示 where

如以上的 where 标签，我们也可以写成

表示当 trim 中含有内容时，添加 where，且第一个为 and 或 or 时，会将其去掉。而如果没有内容，则不添加 where。

3.3.2 trim 来表示 set

相应的， set 标签可以如下表示

表示当 trim 中含有内容时，添加 set，且最后的内容为 , 时，会将其去掉。而没有内容，不添加 set

3.3.3 trim 的几个属性

prefix: 当 trim 元素包含有内容时，增加 prefix 所指定的前缀

prefixOverrides: 当 trim 元素包含有内容时，去除 prefixOverrides 指定的前缀

suffix: 当 trim 元素包含有内容时，增加 suffix 所指定的后缀

suffixOverrides：当 trim 元素包含有内容时，去除 suffixOverrides 指定的后缀

4 foreach 标签

foreach 标签可以对数组， Map 或实现 Iterable 接口。

foreach 中有以下几个属性：

collection: 必填，集合/数组/Map的名称.

item: 变量名。即从迭代的对象中取出的每一个值

index: 索引的属性名。当迭代的对象为 Map 时，该值为 Map 中的 Key.

open: 循环开头的字符串

close: 循环结束的字符串

separator: 每次循环的分隔符

其他的比较好理解， collection 中的值应该怎么设定呢？

跟接口方法中的参数相关。

1. 只有一个数组参数或集合参数

默认情况：集合collection=list，数组是collection=array

推荐：使用 @Param 来指定参数的名称，如我们在参数前@Param("ids")，则就填写 collection=ids

2. 多参数

多参数请使用 @Param 来指定，否则SQL中会很不方便

3. 参数是Map

指定为 Map 中的对应的 Key 即可。其实上面的 @Param 最后也是转化为 Map 的。

4. 参数是对象

使用属性.属性即可。

4.1 在 where 中使用 foreach

在 where条件中使用，如按id集合查询，按id集合删除等。

4.1.1 查询条件

我们希望查询用户 id 集合中的所有用户信息。

4.1.2 动态 SQL

4.2 foreach 实现批量插入

可以通过foreach来实现批量插入。

4.2.1 动态SQL

 
    insert into student(name, phone, email, sex, locked)
    values
    
      (
      #{student.name}, #{student.phone},#{student.email},
      #{student.sex},#{student.locked}
      )

5 bind 标签

bind 标签是通过 OGNL 表达式去定义一个上下文的变量，这样方便我们使用。

如在 selectByStudentSelective 方法中，有如下


      and name like concat('%', #{name}, '%')

在 MySQL 中，该函数支持多参数，但在 Oracle 中只支持两个参数。那么我们可以使用 bind 来让该 SQL 达到支持两个数据库的作用


     
     and name like #{nameLike}