本文共 5946 字，大约阅读时间需要 19 分钟。

---

动态 SQL

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

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

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

• if
• choose (when, otherwise)
• trim (where, set)
• foreach

---

批注：

在真实的项目中，我们的查询往往会根据传入参数的不同，继而返回不同的结果。MyBatis中利用动态SQL来解决这个问题。个人认为动态SQL理解不难，只需要记住对应的语法格式即可，做到灵活运用。

在我们的增删改查SQL中，if最常见，我们经常会使用if来进行一些条件的判断，继而决定是否拼接对应的SQL片段。foreach在批量操作数据时也使用比较频繁，我们往往需要遍历对应的数据，继而达到批量的效果。

---

一、if

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

  SELECT * FROM BLOG  WHERE state = ‘ACTIVE’      AND title like #{title}  

这条语句提供了可选的查找文本功能。如果不传入 “title”，那么所有处于 “ACTIVE” 状态的 BLOG 都会返回；如果传入了 “title” 参数，那么就会对 “title” 一列进行模糊查找并返回对应的 BLOG 结果（细心的读者可能会发现，“title” 的参数值需要包含查找掩码或通配符字符）。

如果希望通过 “title” 和 “author” 两个参数进行可选搜索该怎么办呢？首先，我想先将语句名称修改成更名副其实的名称；接下来，只需要加入另一个条件即可。

  SELECT * FROM BLOG WHERE state = ‘ACTIVE’      AND title like #{title}        AND author_name like #{author.name}  

---

批注：

我认为这是动态SQL中最常见的一个用法，毕竟我们的项目中包含着大量的条件查询。基础格式为 test = “ XXX ”，中间的是对应的条件判断，XXX的最终返回结果为true或false，true则拼接后面的SQL片段，false则跳过。如果test的条件XXX中包含了不止一个条件，则使用and或or进行连接。

自己代码中遇到的坑，如果你在XXX条件中使用到了对字符串的判定，我们应该使用双引号进行包含，并且将最外层的双银行改为单引号。即：

   
    	delete from t_role    // 该方式是错误的    
    
         // 最外层应该使用单引号，内层使用双引号	
       		
      	
     
    
   

当然，如果我们只是进行一个字符串的判空操作，就不需要修改对应的引号。即：

   
    	delete from t_role    // 该方式是错误的    
      		
     	
    
   

---

二、choose、when、otherwise

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

还是上面的例子，但是策略变为：传入了 “title” 就按 “title” 查找，传入了 “author” 就按 “author” 查找的情形。若两者都没有传入，就返回标记为 featured 的 BLOG（这可能是管理员认为，与其返回大量的无意义随机 Blog，还不如返回一些由管理员精选的 Blog）。

  SELECT * FROM BLOG   WHERE state = ‘ACTIVE’            AND title like #{title}              AND author_name like #{author.name}              AND featured = 1      

---

批注：

配合Java中的case-when进行理解，**只要满足其中一个条件就会结束，并且永远只执行其中一个条件。**项目中有用到，但是使用的频率比较少

---

三、trim、where、set

前面几个例子已经方便地解决了一个臭名昭著的动态 SQL 问题。现在回到之前的 “if” 示例，这次我们将 “state = ‘ACTIVE’” 设置成动态条件，看看会发生什么。

  SELECT * FROM BLOG  WHERE      state = #{state}        AND title like #{title}        AND author_name like #{author.name}  

如果没有匹配的条件会怎么样？最终这条 SQL 会变成这样：

SELECT * FROM BLOGWHERE

这会导致查询失败。如果匹配的只是第二个条件又会怎样？这条 SQL 会是这样:

SELECT * FROM BLOGWHEREAND title like ‘someTitle’

这个查询也会失败。这个问题不能简单地用条件元素来解决。这个问题是如此的难以解决，以至于解决过的人不会再想碰到这种问题。

MyBatis 有一个简单且适合大多数场景的解决办法。而在其他场景中，可以对其进行自定义以符合需求。而这，只需要一处简单的改动：

  SELECT * FROM BLOG               state = #{state}                AND title like #{title}                AND author_name like #{author.name}      

where 元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且，若子句的开头为 “AND” 或 “OR”，where 元素也会将它们去除。

如果 where 元素与你期望的不太一样，你也可以通过自定义 trim 元素来定制 where 元素的功能。比如，和 where 元素等价的自定义 trim 元素为：

   
      ...
   

prefixOverrides 属性会忽略通过管道符分隔的文本序列（注意此例中的空格是必要的）。上述例子会移除所有 prefixOverrides 属性中指定的内容，并且插入 prefix 属性中指定的内容。

用于动态更新语句的类似解决方案叫做 set。set 元素可以用于动态包含需要更新的列，忽略其它不更新的列。比如：

   
      update Author    
          
     
      username=#{username},
           
     
      password=#{password},
           
     
      email=#{email},
           
     
      bio=#{bio}
         
      where id=#{id}
   

这个例子中，set 元素会动态地在行首插入 SET 关键字，并会删掉额外的逗号（这些逗号是在使用条件语句给列赋值时引入的）。

来看看与 set 元素等价的自定义 trim 元素吧：

   
      ...
   

注意，我们覆盖了后缀值设置，并且自定义了前缀值。

---

批注：

<where>关键字主要是为了解决怕我们真实项目中where关键字后面没有条件，继而导致语法出错。其实我们也可以在where后面使用 1=1 来避免这个问题。set关键字亦是如此，怕后面的条件中全部没有值时，多出来一个set关键字，导致语法出错。

当然我们也可以使用trim关键字来避免上面所说的这种情况，使用这个关键字prefix来指定对应的前缀（where、set），使用suffixOverrides来去除后缀，prefixOverrides来去除前缀。

---

四、foreach

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

  SELECT *  FROM POST P  WHERE ID in          #{item}  

foreach元素的功能非常强大，它允许你指定一个集合，声明可以在元素体内使用的集合项（item）和索引（index）变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素也不会错误地添加多余的分隔符，看它多智能！

提示 你可以将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时，index 是当前迭代的序号，item 的值是本次迭代获取到的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值。

至此，我们已经完成了与 XML 配置及映射文件相关的讨论。下一章将详细探讨 Java API，以便你能充分利用已经创建的映射配置。

---

批注：

当我们的条件中不止一个数据时，就可以考虑使用该关键字。比如select查询中in关键字后面的条件，在foreach中，我们可以定义对应来源数据的类型，以及数据之间的连接方式，如in中的separator="," 。

当我们在批量插入数据的时候，也可以使用到该关键字。补充一个自己工作中遇到的问题，对于MySQL和Oracle数据库进行批量插入数据时，foreach的语法格式有一定的区别，如Oracle中是separator=“UNION ALL”，MySQL中是separator=","

---

五、script

要在带注解的映射器接口类中使用动态 SQL，可以使用 script 元素。比如:

@Update({
   ""})    void updateAuthorValues(Author author);

六、bind

bind 元素允许你在 OGNL 表达式以外创建一个变量，并将其绑定到当前的上下文。比如：

    SELECT * FROM BLOG  WHERE title LIKE #{pattern}

七、多数据库支持

如果配置了 databaseIdProvider，你就可以在动态代码中使用名为 “_databaseId” 的变量来为不同的数据库构建特定的语句。比如下面的例子：

     
        
     
            select seq_users.nextval from dual    
         
     
            select nextval for seq_users from sysibm.sysdummy1"    
       
      insert into users values (#{id}, #{name})
   

---

批注：

用于支持多种数据库时配置。示例的代码为使用在插入数据时，先使用selectKey获取到对应的序列值，用于当做插入表的主键。在获取序列值时，由于MySQL和Oracle数据库之间的差异，以至于我们获取序列的方式也就存在区别，此时就需要根据不同的数据库id进行配置转换。

我们可以将两种数据库差异化的东西编写为一个sql片段，以后在使用时直接引用这个sql片段就好了。如MySQL和Oracle将数字类型转换为字符类型时的处理。

---

八、动态 SQL 中的插入脚本语言

MyBatis 从 3.2 版本开始支持插入脚本语言，这允许你插入一种语言驱动，并基于这种语言来编写动态 SQL 查询语句。

可以通过实现以下接口来插入一种语言：

public interface LanguageDriver {  ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql);  SqlSource createSqlSource(Configuration configuration, XNode script, Class
    parameterType);  SqlSource createSqlSource(Configuration configuration, String script, Class
    parameterType);}

实现自定义语言驱动后，你就可以在 mybatis-config.xml 文件中将它设置为默认语言：

或者，你也可以使用 lang 属性为特定的语句指定语言：

  SELECT * FROM BLOG

或者，在你的 mapper 接口上添加 @Lang 注解：

public interface Mapper {  @Lang(MyLanguageDriver.class)  @Select("SELECT * FROM BLOG")  List
   
     selectBlog();}
   

提示 可以使用 Apache Velocity 作为动态语言，更多细节请参考 MyBatis-Velocity 项目。

你前面看到的所有 xml 标签都由默认 MyBatis 语言提供，而它由语言驱动 org.apache.ibatis.scripting.xmltags.XmlLanguageDriver（别名为 xml）所提供。

转载地址：http://dsrrz.baihongyu.com/