mybatis foreach标签的使用

我就是我 2022-05-21 11:41 355阅读 0赞

<table> 
 <tbody> 
  <tr> 
   <td><font>mybatis的<strong>foreach</strong>标签经常用于遍历集合，构建in条件语句或者批量操作语句。</font></td> 
  </tr> 
 </tbody> 
</table>

--------------------

下面是foreach标签的各个属性

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>collection</td> 
   <td>表示迭代集合的名称，可以使用@Param注解指定，如下图所示<img src="https://img-blog.csdn.net/20180706202903393?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70" alt="这里写图片描述"> 该参数为必选</td> 
  </tr> 
  <tr> 
   <td>item</td> 
   <td>表示本次迭代获取的元素，若collection为List、Set或者数组，则表示其中的元素；若collection为map，则代表key-value的value，该参数为必选</td> 
  </tr> 
  <tr> 
   <td>open</td> 
   <td>表示该语句以什么开始，最常用的是左括弧’(’，注意:mybatis会将该字符拼接到整体的sql语句之前，并且只拼接一次，该参数为可选项</td> 
  </tr> 
  <tr> 
   <td>close</td> 
   <td>表示该语句以什么结束，最常用的是右括弧’)’，注意:mybatis会将该字符拼接到整体的sql语句之后，该参数为可选项</td> 
  </tr> 
  <tr> 
   <td>separator</td> 
   <td>mybatis会在每次迭代后给sql语句append上separator属性指定的字符，该参数为可选项</td> 
  </tr> 
  <tr> 
   <td>index</td> 
   <td>在list、Set和数组中,index表示当前迭代的位置，在map中，index代指是元素的key，该参数是可选项。</td> 
  </tr> 
 </tbody> 
</table>

--------------------

假设接口中传递的list如下所示：

List<String> list = new ArrayList<>();
    list.add("zhangsan");
    list.add("lisi");
    list.add("wangwu");

其中foreach标签配置如下：

可以看到的是foreach标签指定了逗号作为分隔符，那么mybatis将会解析出foreach标签里面的内容作为一个整体然后再其后面拼接上逗号分隔符，拼接后的过程如下所示：

（'zhangsan'）   			          //第一步，迭代集合，获取对应的item，和外部的()，拼接形成('zhangsan')
    （'zhangsan'）,				          //第二步，在之前的基础上拼接上逗号分隔符
    （'zhangsan'）,（'lisi'）              //第三步，继续迭代
    （'zhangsan'）,（'lisi'）,             //第四步，拼接逗号分隔符
    （'zhangsan'）,（'lisi'）,（'wangwu'）  //第五步，迭代集合并拼接，到此迭代结束

最终的结果为

（'zhangsan'）,（'lisi'）,（'wangwu'）

如果在foreach标签前面加上insert into table values，将会变形成

INSERT INTO user(user_name) VALUES('zhangsan'),('lisi'),('wangwu')

这种形式一般用于数据库的批量增加。

--------------------

如果将foreach配置修改如下，指定open属性为左括弧，close属性为右括弧：

那么拼接的过程如下所示

(                               //第一步，拼接open指定的开始字符
    ('zhangsan'					    //第二步，迭代集合，拼接对应的item
    ('zhangsan',				    //第三步，拼接separator指定的分隔符
    ('zhangsan','lisi'			    //第四步，迭代集合，拼接对应的item
    ('zhangsan','lisi',			    //第五步，拼接separator指定的分隔符
    ('zhangsan','lisi','wangwu'     //第六步，迭代集合，拼接对应的item
    ('zhangsan','lisi','wangwu')    //第七步，拼接close指定的闭合字符

最终结果是：

('zhangsan','lisi','wangwu')

如果在foreach标签前面加上select … from table where … in ，将会变形成

SELECT * FROM user WHERE user_name in ('zhangsan','lisi','wangwu')

这种形式被用来构建in条件语句。

如果collection类型为map，则index代表key，item代表对应的value，可以这样进行批量插入：  
![这里写图片描述][70]  
其中Role实体类如下：  
![这里写图片描述][70 1]

--------------------

如果你想了解更多的关于mybaits标签的使用，请移步[mybatis trim标签的使用][mybatis trim]  
本文参考[mybatis官方文档][mybatis]

[70]: /images/20220521/f4761d8241b64f43b01f216e3e974d03.png
[70 1]: /images/20220521/fd67337826a740728680ccaa86fe05ab.png
[mybatis trim]: https://blog.csdn.net/wt_better/article/details/80992014
[mybatis]: http://www.mybatis.org/mybatis-3/dynamic-sql.html