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

Question

假设下面的字符串模板被赋予了Java Bean对象的列表：

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

即人员列表中可能包含Person您可能无法或无法增强/扩展的对象：

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

该getName()和getEmail()方法不返回消毒（编码的HTML实体）。您如何解决这个问题？

Answer 1

您可以使用自定义渲染器，例如：

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>", "[e-mail]"),
                new Person("<b>Nick</b>", "[e-mail]")
        ));

        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; [e-mail]</li><li>&lt;b&gt;Nick&lt;/b&gt; [e-mail]</li></ul>