如何在freemarker中转义json字符串

Question

我们正在使用Spring MVC和freemarker作为模板语言来构建一个宁静的api。我们选择在freemarker中构建json响应

示例freemarker.ftl：

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

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

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

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

EDIT： ?js_string将转义该字符串以使其与JavaScript一致。而且，由于JSON基于JavaScript（JavaScript对象表示法），因此可以使用。

EDIT2：如果弹出单引号，?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}"
}

这会避免转义引号，反斜杠等。为了使您的JS开心。

Edit：我刚刚看到他们在Freemarker 2.3.19中引入了?json_string运算符。确切的操作方法请参见here。还有很多欢乐...

Answer 2

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

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

如果要在多个模板中重用该宏，请将其放入其自己的文件和include the file中，而不要复制宏：

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