确保在StringTemplate中转义HTML实体的最佳方法是什么

时间:2013-01-15 04:15:59

标签: java stringtemplate stringtemplate-4

假设以下字符串模板,正在给出一个Java Bean对象列表:

<ul>$people:{p|<li>$p.name$ $p.email</li>}$</ul>

即人员列表可能包含Person个对象,您可能会或可能无法增强/扩展这些对象:

class Person {
    ....
    public getName() { ... }
    public getEmail() { ... }
}

getName()getEmail()方法不会返回已清理的(转义的html实体)。你怎么解决这个问题?

2 个答案:

答案 0 :(得分:4)

您可以使用自定义渲染器,例如:

public static class HtmlEscapeStringRenderer implements AttributeRenderer {
    public String toString(Object o, String s, Locale locale) {
        return (String) (s == null ? o : StringEscapeUtils.escapeHtml((String) o));
    }
}

然后在模板中表明您希望将其转义:

$p.name;format="html"$

也就是说,您可能更喜欢在输入上清理数据,在发送到模板之前进行转换,将装饰人员发送到模板等等。


public class App {
    public static void main(String[] args) {
        STGroupDir group = new STGroupDir("src/main/resource", '$', '$');
        group.registerRenderer(String.class, new HtmlEscapeStringRenderer());

        ST st = group.getInstanceOf("people");
        st.add("people", Arrays.asList(
                new Person("<b>Dave</b>", "dave@ohai.com"),
                new Person("<b>Nick</b>", "nick@kthxbai.com")
        ));

        System.out.println(st.render());
    }

    public static class HtmlEscapeStringRenderer implements AttributeRenderer {
        public String toString(Object o, String s, Locale locale) {
            return (String) (s == null ? o : StringEscapeUtils.escapeHtml((String) o));
        }
    }
}

输出:

<ul><li>&lt;b&gt;Dave&lt;/b&gt; dave@ohai.com</li><li>&lt;b&gt;Nick&lt;/b&gt; nick@kthxbai.com</li></ul>

答案 1 :(得分:2)

没有必要为此编写自己的渲染器。 您可以使用内置渲染器org.stringtemplate.v4.StringRenderer

group.registerRenderer(String.class, new StringRenderer());

并添加模板:

<ul>$people:{p|<li>$p.name;format="xml-encode"$ $p.email;format="xml-encode"$</li>}$</ul>