MyBatis动态SQL

09_2MyBatis动态SQL

MyBatis提供了一些if、choose(when、otherwise)、trim(where、set)、foreach等元素来处理动态SQL，这里首先对这些元素进行说明介绍，接着会结合实际场景需求，来列出常见的一些操作。

用到的表信息

-- ----------------------------
-- Table structure for person
-- ----------------------------
DROP TABLE IF EXISTS `person`;
CREATE TABLE `person` (
  `id` bigint(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) DEFAULT NULL,
  `age` int(11) DEFAULT NULL,
  `gender` varchar(255) DEFAULT NULL,
  `hobby` varchar(255) DEFAULT NULL,
  `c_id` int(11) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of person
-- ----------------------------
BEGIN;
INSERT INTO `person` VALUES (1, '曹操', 32, '1', NULL, 1);
INSERT INTO `person` VALUES (2, '曹丕', 13, '1', NULL, 1);
INSERT INTO `person` VALUES (3, '张飞', 28, '1', NULL, 2);
INSERT INTO `person` VALUES (4, '甄宓', 27, '2', NULL, 1);
INSERT INTO `person` VALUES (5, '星彩', 17, '2', NULL, 2);
COMMIT;

SET FOREIGN_KEY_CHECKS = 1;

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}
  

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
    
  

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 BLOG
WHERE

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

SELECT * FROM BLOG
WHERE
AND 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 元素吧：

  ...

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

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 是值。

实战场景

批量更新用户数据

当前数据内容

select * from person

id	name	age	gender	hobby	c_id
1	曹操	32	1		1
2	曹丕	13	1		1
3	张飞	28	1		2
4	甄宓	27	2		1
5	星彩	17	2		2

需求：按业务数据age和hobby字段如果存在值则更新其内容。

update person 
set 
age= 
	case
		when id=1 then 34
		when id=2 then 15
		else
		age
	end,
hobby=
	case 
		when id=1 then '当丞相'
		when id=2 then '改朝换代'
		else
		hobby
	end
where id in(1,2,3)

    
        update person
        
            
                
                    
                        when id=#{item.id} then #{item.age}
                    
                    
                        when id=#{item.id} then person.age
                    
                
            
            
                
                    
                        
                            when id=#{item.id} then #{item.hobby}
                        
                        
                            when id=#{item.id} then person.hobby
                        
                    
                
            
        
        where
        id in
        
            #{item.id}
        
    

package com.lucky.spring.dao;

import com.lucky.spring.model.Person;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.ArrayList;
import java.util.List;

import static org.junit.Assert.*;

/**
 * Created by zhangdd on 2020/8/8
 */
@SpringBootTest
@RunWith(SpringRunner.class)
public class PersonMapperExtTest {

    @Autowired
    PersonMapperExt mapperExt;

    @Test
    public void batchUpdate() throws Exception {
        List people = new ArrayList<>();
        people.add(new Person());
        if (people.size()<=0){
            return;
        }
        mapperExt.batchUpdate(people);
    }

}

需要保证集合的元素个数大于0。
这里借助了SQL中case ... when ... then ...的语法。拼凑成了批量更新sql的语句。可以在一次数据库连接中更新所有数据，避免了频繁数据库建立和断开连接的开销，可以很大程度的提高更新效率。但是这样的问题是如果这个过程中更新出错，将很难知道具体是哪个数据出错。因此通常的的使用的方案是进行折中，也就是一次批量更新一部分。这样可以分担错误的概率，同时也更容易定位出错的位置。