java ftl 换行

在Java应用中，使用FreeMarker（FTL）模板处理换行时，需注意模板语法与Java数据的配合，直接在FTL中输入换行符可能被解析为空格，可通过或指令保留原始换行，或在Java中预置换行符（如\n），结合${}输出时通过escape指令避免转义，若需HTML换行，可在模板中使用标签，或通过Java传递包含\n的字符串，配置FreeMarker的output_format为HTML后自动处理，在循环或复杂结构中，可用包裹需保留换行的文本块，确保最终输出格式符合预期。

Java中使用FreeMarker（FTL）模板实现换行的实践指南

在Java开发中,FreeMarker（FTL）作为一款成熟的模板引擎，广泛应用于动态生成文本文件、HTML页面、配置文件等多种场景，在实际应用中，换行处理是一个常见且重要的需求——无论是生成日志、报告，还是渲染前端页面，合理的换行都能显著提升文本的可读性和格式规范性，本文将结合具体场景，详细介绍在Java与FTL协作中实现换行的多种方法、注意事项及最佳实践。

为什么需要关注FTL中的换行？

在使用FTL模板时,换行问题通常源于两个层面：

1. 模板本身的换行：模板文件中的换行符（如\n）是否会被保留到最终输出？
2. 数据的换行：Java代码传递给FTL的数据中包含换行符（如用户输入的多行文本、数据库中的换行字段），如何在FTL中正确显示？

若处理不当,可能出现输出内容"挤在一行"、格式错乱，或在HTML页面中换行符被忽略等问题，掌握换行处理方法对保证输出质量至关重要，特别是在跨平台应用中，不同操作系统使用不同的换行符（Windows使用\r\n，Linux/macOS使用\n），这更增加了处理的复杂性。

FTL换行的核心方法

方法1：直接在FTL模板中使用换行符（\n）

原理：FTL模板中的普通文本（非指令部分）会直接输出到最终结果，其中的换行符（\n）会被保留。

适用场景：生成纯文本文件（如日志、CSV）、命令行输出，或需要固定换行格式的文本内容。

示例：

FTL模板（template.ftl）：

用户信息：
姓名：${user.name}
年龄：${user.age}
地址：${user.address}

Java代码：

import freemarker.template.Configuration;
import freemarker.template.Template;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Map;
public class FtlDemo {
    public static void main(String[] args) throws Exception {
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_32);
        cfg.setClassForTemplateLoading(FtlDemo.class, "/templates");
        Map<String, Object> data = new HashMap<>();
        data.put("user", new User("张三", 25, "北京市朝阳区"));
        Template template = cfg.getTemplate("template.ftl");
        StringWriter writer = new StringWriter();
        template.process(data, writer);
        System.out.println(writer.toString());
    }
}
class User {
    private String name;
    private int age;
    private String address;
    public User(String name, int age, String address) {
        this.name = name;
        this.age = age;
        this.address = address;
    }
    // 构造方法、getter/setter省略
}

输出结果：

用户信息：
姓名：张三
年龄：25
地址：北京市朝阳区

说明：模板中的换行符被直接保留，输出为多行文本，若需强制换行，也可显式写入\n（如${user.name}\n），需要注意的是，在Windows系统中，可能需要使用\r\n以确保换行符正确显示。

方法2：通过Java代码预处理换行符

原理：若换行符来自Java逻辑（如数据库读取、文件解析），可在Java中构造数据时包含换行符，FTL直接输出即可。

适用场景：数据源本身包含换行（如用户输入的多行备注、日志内容）。

示例：

Java代码：

// 假设从数据库获取用户备注，包含换行符
String userNote = "第一行备注\n第二行备注\n第三行备注";
data.put("userNote", userNote);

FTL模板：

${userNote}

输出结果：

第一行备注
第二行备注
第三行备注

注意事项：

• 若数据来自用户输入,需注意XSS防护（如HTML场景下需转义换行符）
• 跨平台开发时,建议使用System.lineSeparator()来获取当前系统的换行符
• 对于大量数据,预处理换行符可能影响性能，需权衡利弊

方法3：使用FreeMarker内置函数处理换行

原理：FreeMarker提供了一些内置函数，可以方便地处理字符串中的换行问题。

适用场景：需要动态控制换行格式或处理复杂换行逻辑的情况。

示例：

Java代码：

// 准备包含换行符的数据
String text = "第一行\n第二行\n第三行";
data.put("text", text);

FTL模板：

<!-- 原样输出 -->
原文本：${text}
<!-- 替换换行符为HTML换行标签 -->
HTML换行：${text?replace("\n", "<br>")}

输出结果：

原文本：第一行
第二行
第三行
HTML换行：第一行<br>第二行<br>第三行

说明：

• ?replace函数可以替换字符串中的特定内容
• 对于HTML输出,通常需要将\n替换为<br>
• 还可以使用?trim()函数去除首尾空白，?capitalize()函数首字母大写等

<#-- 使用<#t>去除指令周围的空白 -->
<#list users as user>
<#t>姓名：${user.name}<#t>
<#t>年龄：${user.age}<#t>
</#list>

<pre>${userNote}</pre>

<div style="white-space: pre-line;">${userNote}</div>

<textarea id="note">${userNote?js_string}</textarea>
<script>
    document.getElementById('note').value = document.getElementById('note').value.replace(/\n/g, '<br>');
</script>