FreeMarker模板引擎怎么生成XML

FreeMarker是Java生态中广泛使用的模板引擎，通过预定义的模板和数据模型的结合，可以快速生成各类文本格式内容，其中生成XML是常见应用场景之一，适用于接口数据返回、配置文件生成、数据导出等场景。

FreeMarker生成XML的核心原理

FreeMarker生成XML的过程本质是模板解析+数据填充的过程：开发者先编写符合XML语法规范的ftl模板文件，在模板中预留数据占位符，之后在Java代码中准备对应的数据模型，调用FreeMarker的模板处理API，将数据和模板结合后输出最终的XML内容。

环境准备

首先需要在项目中引入FreeMarker的依赖，如果是Maven项目，在pom.xml中添加如下依赖：

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

编写XML模板文件

模板文件需要遵循XML的语法规范，同时用FreeMarker的语法标记动态数据部分。以下是一个简单的用户列表XML模板示例，文件后缀为user_list.ftl：

<?xml version="1.0" encoding="UTF-8"?>
<userList>
    <#list userList as user>
    <user>
        <id>${user.id}</id>
        <name>${user.name}</name>
        <age>${user.age}</age>
        <email>${user.email}</email>
    </user>
    </#list>
</userList>

模板中<#list>是FreeMarker的循环指令，用于遍历用户列表，${}是变量占位符，对应数据模型中的属性值。

Java代码实现生成逻辑

接下来编写Java代码，完成配置初始化、数据准备、模板渲染和XML输出的全流程：

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class FreeMarkerXmlGenerator {
    public static void main(String[] args) {
        // 1. 初始化FreeMarker配置
        Configuration configuration = new Configuration(Configuration.VERSION_2_3_32);
        try {
            // 设置模板文件所在的目录，这里指定为当前项目的templates文件夹
            configuration.setDirectoryForTemplateLoading(new File("src/main/resources/templates"));
            // 设置编码，避免中文乱码
            configuration.setDefaultEncoding("UTF-8");

            // 2. 准备数据模型
            List<Map<String, Object>> userList = new ArrayList<>();
            Map<String, Object> user1 = new HashMap<>();
            user1.put("id", 1);
            user1.put("name", "张三");
            user1.put("age", 25);
            user1.put("email", "zhangsan@ipipp.com");
            userList.add(user1);

            Map<String, Object> user2 = new HashMap<>();
            user2.put("id", 2);
            user2.put("name", "李四");
            user2.put("age", 28);
            user2.put("email", "lisi@ipipp.com");
            userList.add(user2);

            Map<String, Object> dataModel = new HashMap<>();
            dataModel.put("userList", userList);

            // 3. 获取模板
            Template template = configuration.getTemplate("user_list.ftl");

            // 4. 渲染模板并输出XML文件
            File outputFile = new File("output/user_list.xml");
            // 确保输出目录存在
            if (!outputFile.getParentFile().exists()) {
                outputFile.getParentFile().mkdirs();
            }
            try (FileWriter writer = new FileWriter(outputFile)) {
                template.process(dataModel, writer);
                System.out.println("XML文件生成成功，路径：" + outputFile.getAbsolutePath());
            }
        } catch (IOException | TemplateException e) {
            e.printStackTrace();
        }
    }
}

生成XML的注意事项

• 编码统一：XML声明中的编码、FreeMarker配置的编码、输出流的编码三者需要保持一致，通常都使用UTF-8，避免出现中文乱码问题。
• 特殊字符转义：如果数据中包含XML的特殊字符，比如<、>、&等，需要在模板中做转义处理，可以使用FreeMarker内置的?xml指令，例如${user.desc?xml}，会自动将特殊字符转义为对应的XML实体。
• XML语法合规：模板本身需要符合XML的语法规范，比如标签必须闭合、属性值需要加引号等，否则生成的XML文件可能无法被正常解析。
• 空值处理：如果数据模型中可能存在空值，需要在模板中做非空判断，比如使用<#if user.email??>${user.email}</#if>，避免渲染时出现空值异常。

生成的XML结果示例

运行上述代码后，生成的user_list.xml内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<userList>
    <user>
        <id>1</id>
        <name>张三</name>
        <age>25</age>
        <email>zhangsan@ipipp.com</email>
    </user>
    <user>
        <id>2</id>
        <name>李四</name>
        <age>28</age>
        <email>lisi@ipipp.com</email>
    </user>
</userList>

FreeMarkerXML模板引擎ftl模板修改时间：2026-07-06 02:00:12