java ftl如何循环写入

在Java中使用Freemarker模板（ftl）进行循环写入，可以通过遍历集合对象、应用模板指令、动态生成内容。Freemarker是一种广泛用于Java项目的模板引擎，允许开发人员将动态数据注入到静态模板中，生成HTML、XML或其他格式的文档。在实践中，通过Freemarker循环写入数据，可以有效地实现数据的动态展示、批量生成内容、提高代码的可维护性和可读性。以下是详细描述如何在Java中使用Freemarker模板循环写入数据的步骤。

一、准备工作

在开始使用Freemarker进行循环写入之前，需要完成以下准备工作：

引入Freemarker库：确保你的Java项目中包含Freemarker库，可以通过Maven或Gradle添加依赖。
创建模板文件：编写一个.ftl文件，其中包含Freemarker模板语法，用于定义数据展示的格式。

引入Freemarker库

首先，确保你的项目已经包含了Freemarker库。如果你使用Maven作为构建工具，可以在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

如果你使用Gradle作为构建工具，可以在build.gradle文件中添加以下依赖：

implementation 'org.freemarker:freemarker:2.3.31'

创建模板文件

接下来，创建一个Freemarker模板文件（例如template.ftl），定义你想要生成的内容格式。以下是一个简单的模板文件示例：

<!DOCTYPE html>
<html>
<head>
    <title>Freemarker Example</title>
</head>
<body>
    <h1>Item List</h1>
    <ul>
        <#list items as item>
            <li>${item}</li>
        </#list>
    </ul>
</body>
</html>

二、在Java中加载和配置Freemarker

在Java代码中，需要加载和配置Freemarker模板引擎，准备数据模型，并将数据注入模板中生成最终的内容。

加载和配置Freemarker

首先，创建一个Configuration对象并进行配置：

import freemarker.template.Configuration;
import freemarker.template.TemplateExceptionHandler;
Configuration cfg = new Configuration(Configuration.VERSION_2_3_31);
cfg.setClassForTemplateLoading(this.getClass(), "/templates");
cfg.setDefaultEncoding("UTF-8");
cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
cfg.setLogTemplateExceptions(false);
cfg.setWrapUncheckedExceptions(true);

上述代码配置了Freemarker，使其从/templates目录加载模板文件，并设置了编码和异常处理策略。

准备数据模型

接下来，准备一个数据模型，通常是一个Map对象，其中包含模板中需要使用的数据：

import java.util.HashMap;
import java.util.Map;
Map<String, Object> model = new HashMap<>();
model.put("items", Arrays.asList("Item 1", "Item 2", "Item 3"));

生成内容

最后，加载模板文件并生成内容：

import freemarker.template.Template;
Template template = cfg.getTemplate("template.ftl");
Writer out = new StringWriter();
template.process(model, out);
String result = out.toString();
System.out.println(result);

三、模板中的循环指令

在Freemarker模板中，可以使用<#list>指令来遍历集合对象，并动态生成内容。以下是一个详细的示例：

<!DOCTYPE html>
<html>
<head>
    <title>Freemarker Example</title>
</head>
<body>
    <h1>Item List</h1>
    <ul>
        <#list items as item>
            <li>${item}</li>
        </#list>
    </ul>
</body>
</html>

在这个模板中，<#list items as item>指令用于遍历items集合，并为每个元素生成一个<li>标签。

四、实战示例

以下是一个更复杂的示例，展示如何在Java中使用Freemarker模板生成一个包含多个属性的列表项：

模板文件（template.ftl）

<!DOCTYPE html>
<html>
<head>
    <title>Freemarker Example</title>
</head>
<body>
    <h1>Product List</h1>
    <table border="1">
        <tr>
            <th>Product Name</th>
            <th>Price</th>
        </tr>
        <#list products as product>
            <tr>
                <td>${product.name}</td>
                <td>${product.price}</td>
            </tr>
        </#list>
    </table>
</body>
</html>

Java代码

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateExceptionHandler;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class FreemarkerExample {
    public static void main(String[] args) {
        // Step 1: Configure Freemarker
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_31);
        cfg.setClassForTemplateLoading(FreemarkerExample.class, "/templates");
        cfg.setDefaultEncoding("UTF-8");
        cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
        cfg.setLogTemplateExceptions(false);
        cfg.setWrapUncheckedExceptions(true);
        // Step 2: Prepare Data Model
        List<Product> productList = Arrays.asList(
            new Product("Laptop", 799.99),
            new Product("Smartphone", 499.99),
            new Product("Tablet", 299.99)
        );
        Map<String, Object> model = new HashMap<>();
        model.put("products", productList);
        try {
            // Step 3: Load Template
            Template template = cfg.getTemplate("template.ftl");
            // Step 4: Generate Output
            Writer out = new StringWriter();
            template.process(model, out);
            // Step 5: Print Output
            System.out.println(out.toString());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    static class Product {
        private String name;
        private double price;
        public Product(String name, double price) {
            this.name = name;
            this.price = price;
        }
        public String getName() {
            return name;
        }
        public double getPrice() {
            return price;
        }
    }
}

五、更多高级用法

使用条件语句

在Freemarker中，还可以使用条件语句来控制模板的渲染逻辑。例如，以下模板将根据产品价格的高低显示不同的样式：

<!DOCTYPE html>
<html>
<head>
    <title>Freemarker Example</title>
</head>
<body>
    <h1>Product List</h1>
    <table border="1">
        <tr>
            <th>Product Name</th>
            <th>Price</th>
        </tr>
        <#list products as product>
            <tr>
                <td>${product.name}</td>
                <td>
                    <#if product.price > 500>
                        <span style="color:red;">${product.price}</span>
                    <#else>
                        ${product.price}
                    </#if>
                </td>
            </tr>
        </#list>
    </table>
</body>
</html>

嵌套循环

如果需要嵌套循环，可以在Freemarker模板中使用多层<#list>指令。例如，以下模板展示了如何嵌套循环生成多维列表：

<!DOCTYPE html>
<html>
<head>
    <title>Freemarker Example</title>
</head>
<body>
    <h1>Category List</h1>
    <#list categories as category>
        <h2>${category.name}</h2>
        <ul>
            <#list category.items as item>
                <li>${item}</li>
            </#list>
        </ul>
    </#list>
</body>
</html>

六、总结

通过上述步骤，我们详细讨论了如何在Java中使用Freemarker模板进行循环写入。Freemarker模板引擎提供了强大的功能，使得动态数据生成变得更加简单和灵活。通过配置Freemarker、准备数据模型、使用模板指令，我们可以实现各种复杂的数据展示需求。进一步的，条件语句和嵌套循环的使用，使得Freemarker模板在处理复杂逻辑时更加得心应手。希望这些内容对你的项目有所帮助，能够帮助你更好地使用Freemarker进行模板渲染。