如何在freemarker中转义json字符串

时间:2011-06-17 08:59:30

标签: java json spring escaping freemarker

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

示例freemarker.ftl:

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

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

问题:如何使用freemarker转义这些字符串?

我们查看了?xml?html,但未涵盖所有相关字符(例如\)。

编辑: ?js_string将转义字符串以与JavaScript协作。由于JSON基于JavaScript(JavaScript Object Notation),因此可以使用。

EDIT2:如果弹出单引号,?js_script将转义它,这又会导致无效的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

2 个答案:

答案 0 :(得分:27)

您正在寻找?js_string运营商。

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

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

修改:我刚看到他们在Freemarker 2.3.19中引入了?json_string运算符。有关其工作原理,请参阅here。并且有很多欢欣鼓舞......

答案 1 :(得分: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">