Thymeleaf教程：深入理解迭代器(th:each)的使用

前言

在Web开发中，展示列表数据是非常常见的需求。Thymeleaf作为一款优秀的Java模板引擎，提供了强大的迭代功能来简化这类操作。本文将详细介绍Thymeleaf中迭代器的使用方法，帮助开发者高效处理列表数据展示。

基本迭代语法

Thymeleaf通过th:each属性实现迭代功能，其语法类似于Java的foreach循环：

<li th:each="book : ${books}" th:text="${book.title}">默认文本</li>

这段代码会遍历books集合中的每个元素，为每个元素生成一个<li>标签，并将书籍标题作为文本内容。

支持迭代的对象类型

Thymeleaf的th:each支持多种Java对象类型：

1. 实现了java.util.Iterable接口的对象
2. 实现了java.util.Enumeration接口的对象
3. 实现了java.util.Iterator接口的对象（无需缓存所有值）
4. 实现了java.util.Map接口的对象（迭代变量为Map.Entry）
5. 任何数组类型
6. 其他对象会被视为单值列表

迭代状态变量

在实际开发中，我们经常需要获取迭代过程中的状态信息。Thymeleaf提供了丰富的状态变量来满足这一需求。

状态变量属性

状态变量包含以下有用属性：

• index：当前迭代索引（从0开始）
• count：当前迭代计数（从1开始）
• size：迭代元素总数
• current：当前迭代元素
• even/odd：判断当前迭代是偶数还是奇数
• first：判断是否是第一个元素
• last：判断是否是最后一个元素

状态变量使用示例

<table>
  <tr>
    <th>名称</th>
    <th>价格</th>
    <th>库存状态</th>
  </tr>
  <tr th:each="prod,iterStat : ${prods}" th:class="${iterStat.odd}? 'odd'">
    <td th:text="${prod.name}">默认名称</td>
    <td th:text="${prod.price}">0.00</td>
    <td th:text="${prod.inStock}? '有货' : '缺货'">未知</td>
  </tr>
</table>

在这个例子中，我们：

1. 遍历产品列表prods
2. 使用状态变量iterStat判断当前行是否为奇数行
3. 如果是奇数行则添加'odd'类
4. 显示产品名称、价格和库存状态

隐式状态变量

如果不显式声明状态变量，Thymeleaf会自动生成一个，命名规则为"迭代变量名+Stat"：

<tr th:each="prod : ${prods}" th:class="${prodStat.odd}? 'odd'">
  <!-- 表格内容 -->
</tr>

实际应用场景

1. 斑马线表格

使用even/odd状态可以轻松实现表格行的斑马线效果：

<tr th:each="item : ${items}" 
    th:class="${itemStat.odd}? 'odd-row' : 'even-row'">
  <!-- 表格内容 -->
</tr>

2. 首尾行特殊样式

<ul>
  <li th:each="item : ${items}" 
      th:class="${itemStat.first}? 'first-item' : 
                (${itemStat.last}? 'last-item' : '')">
    <span th:text="${item.name}"></span>
  </li>
</ul>

3. 显示序号

<table>
  <tr th:each="user, stat : ${users}">
    <td th:text="${stat.count}">序号</td>
    <td th:text="${user.name}">用户名</td>
  </tr>
</table>

性能考虑

1. 大型集合处理：对于大型数据集，建议使用实现了Iterator接口的对象，避免一次性加载所有数据到内存
2. 状态变量开销：虽然状态变量很方便，但在极高性能要求的场景下，可以考虑减少其使用
3. 缓存策略：合理利用Thymeleaf的模板缓存可以显著提高迭代性能

总结

Thymeleaf的迭代功能非常强大且灵活，通过th:each属性和状态变量，开发者可以轻松处理各种列表展示需求。掌握这些技巧将大大提高开发效率和代码可维护性。在实际项目中，建议根据具体需求选择最合适的迭代方式，并注意性能优化。