如何在 freemarker 中转义 json 字符串

Question

我们正在使用 Spring MVC 和 freemarker 作为模板语言构建一个 Restful api。我们选择在 freemarker 示例 freemarker.ftl 中构建 json 响应

：

{
"field1" : "${response.value1}",
"field2" : "${response.value2}"
}

当值中的字符串包含引号（或 JSON 语法中的任何其他字符）时，我们会遇到问题。

问题：如何使用 freemarker 转义这些字符串？

我们已经查看了 ?xml 或 ?html 但它们并未涵盖所有相关字符（例如 \）。

编辑： ?js_string 将转义字符串以符合 JavaScript。由于 JSON 基于 JavaScript（JavaScript 对象表示法），因此它可以工作。

编辑2：如果弹出单引号，?js_string 将转义它，这再次导致无效的 JSON。它的修补程序是：

${variable?js_string?replace("\\'", "\'")} 

如果你真的想挑剔：

${variable?js_string?replace("\\'", "\'")?replace("\\>",">")}

或者如果你使用 Spring： http://www.springsurf.org/sites/1.0.0.M3/spring-webscripts/spring-webscripts-documentation/reference/html-single/index.html#js-api-index-org.springframework .extensions.webscripts.json.jsonutils

Answer 1

您正在寻找 ?js_string 运算符。

{
"field1" : "${response.value1?js_string}",
"field2" : "${response.value2?js_string}"
}

这将处理转义引号、反斜杠等。 al为了让你的JS开心。

编辑：我刚刚看到他们在 Freemarker 2.3.19 中引入了 ?json_string 运算符。请参阅此处了解其具体工作原理。而且还有很多庆幸的事...

Answer 2

使用 FreeMarker 宏 组合上述所有答案，同时使模板更具可读性和可维护：

<#macro json_string string>${string?js_string?replace("\\'", "\'")?replace("\\>", ">")}</#macro>
{
"field1" : "<@json_string "${response.value1}"/>",
"field2" : "<@json_string "${response.value2}"/>"
}

如果您想在多个模板中重用该宏，请将其放入自己的文件中并 包含文件而不是复制宏：

<#include "/path/to/macro.ftl">

Answer 3

从 FreeMarker 2.3.32 开始，它变得更加容易，因为 ?c 现在引用字符串：

{
"field1" : ${response.value1?c},
"field2" : ${response.value2?c}
}

请注意，${...} 周围没有引号！这就是重点；如果值是字符串（而不是数字或布尔值，它们的格式不添加引号），则 ?c 将它们放在那里。

在 2.3.32 之前，上述内容会因错误而终止，因为 ?c 不允许输入字符串，只能输入数字和布尔值。

从2.3.32开始，您还可以使用?cn代替?c，它代表“?c nullable”。然后，如果值丢失/null，它将输出null，不带引号。因此，您也不必通过有条件地打印引号来使模板复杂化。

另外，最好将 c_format 设置设置为 “JSON” 或 “JavaScript 或 JSON”。 （或者，如果您将 incomplete_improvements 配置设置设置为 2.3.32 或更高版本，则最后一个将是默认值。）