MyBatis foreach标签

1年前 (2024-04-27)
前面我们学习了如何使用 Mybatis if、where、trim 等动态语句来处理一些简单的查询操作。对于一些 SQL 语句中含有 in 条件,需要迭代条件来生成的情况,可以使用 foreach 来实现 SQL 条件的迭代。 

Mybatis foreach 标签用于循环语句,它很好的支持了数据和 List、set 接口的,并对此提供遍历的功能。语法格式如下。

<foreach item="item" index="index" collection="list|array|map key" open="(" separator="," close=")">

参数值

</foreach>

foreach 标签主要有以下属性,说明如下。

  • item:表示中每一个元素进行迭代时的别名。

  • index:指定一个名字,表示在迭代过程中每次迭代到的位置。

  • open:表示该语句以什么开始(既然是 in 条件语句,所以必然以(开始)。
  • separator:表示在每次进行迭代之间以什么符号作为分隔符(既然是 in 条件语句,所以必然以,作为分隔符)。
  • close:表示该语句以什么结束(既然是 in 条件语句,所以必然以)开始)。


使用 foreach 标签时,最关键、最容易出错的是 collection 属性,该属性是必选的,但在不同情况下该属性的值是不一样的,主要有以下 3 种情况:

  • 如果传入的是单参数且参数类型是一个 List,collection 属性值为 list。

  • 如果传入的是单参数且参数类型是一个 array 数组,collection 的属性值为 array。

  • 如果传入的参数是多个,需要把它们封装成一个 Map,当然单参数也可以封装成 Map。Map 的 key 是参数名,collection 属性值是传入的 List 或 array 对象在自己封装的 Map 中的 key。

示例

本节示例基于《个MyBatis程序》一节的代码实现。

现有 website 表包含以下记录。

+----+----------------+----------------------------+-----+---------+---------------------+

| id | name | url | age | country | createtime |

+----+----------------+----------------------------+-----+---------+---------------------+

| 1 | 编程帮 | https://www.biancheng网站站点" rel="nofollow" />

<select id="selectWebsite"

parameterType="net.biancheng.po.Website"

resultType="net.biancheng.po.Website">

SELECT id,name,url,age,country

FROM website WHERE age in

<foreach item="age" index="index" collection="list" open="("

separator="," close=")">

#{age}

</foreach>

</select>

WebsiteMapper 类中相应方法如下。

public List<Website> selectWebsite(List<Integer> ageList);

测试代码如下。

public class Test {

public static void main(String[] args) throws IOException {

// 读取配置文件mybatis-config.xml

InputStream config = Resources.getResourceAsStream("mybatis-config.xml"); // 根据配置文件构建

SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(config);

// 通过SqlSessionFactory创建SqlSession

SqlSession ss = ssf.openSession();

List<Integer> ageList = new ArrayList<Integer>();

ageList.add(10);

ageList.add(12);

List<Website> siteList = ss.selectList("net.biancheng.mapper.WebsiteMapper.selectWebsite", ageList);

for (Website ws : siteList) {

System.out.println(ws);

}

}

}

输出结果如下。

DEBUG [main] - ==>  Preparing: SELECT id,name,url,age,country FROM website WHERE age in ( ? , ? )
DEBUG [main] - ==> Parameters: 10(Integer), 12(Integer)
DEBUG [main] - <==      Total: 2
Website[id=1,name=编程帮,url=https://www.biancheng网站站点" rel="nofollow" />