如何用OWASP Java HTML Sanitizer为H2标签添加持久唯一ID？

要实现类似JavaScript中基于索引的递增ID，核心是在HTML sanitize过程中维护一个可变计数器——因为OWASP的回调函数每次处理单个h2元素时，需要追踪当前是第几个h2。由于Java Lambda要求引用的变量为final或等效final，我们可以用AtomicInteger实现可变计数，同时保证线程安全。

实现步骤 #

1. 为每个待处理的HTML文档初始化独立计数器，起始值可自定义（比如从1开始）。
2. 在allowElements的回调中，每次处理h2元素时，获取当前计数器值生成ID，随后自增计数器。
3. 同步添加所需的class属性。

修改后的代码示例 #

// 处理单个HTML文档时，初始化独立计数器
AtomicInteger h2Counter = new AtomicInteger(1);

public PolicyFactory createHtmlPolicy(AtomicInteger counter) {
    return new HtmlPolicyBuilder()
        .allowElements("h3", "h4", "h5", "h6", "p", "span", "br", "b", "strong", "i", "em", "u", "hr", "ol", "ul", "li",
                       "img", "table", "tr", "th", "td", "thead", "tbody", "tfoot", "caption", "colgroup", "col", "blockquote", "figure", "figcaption", "object", "iframe")
        .allowElements(
            (String elementName, List<String> attrs) -> {
                // 生成递增格式的ID
                String uniqueId = "headline-2-" + counter.getAndIncrement();
                attrs.add("id");
                attrs.add(uniqueId);
                attrs.add("class");
                attrs.add("scrollspy");
                return elementName;
            }, "h2")
        .toFactory();
}

// 使用示例：每次处理新页面时重置计数器
AtomicInteger pageH2Counter = new AtomicInteger(1);
PolicyFactory policy = createHtmlPolicy(pageH2Counter);
String sanitizedHtml = policy.sanitize(yourRawHtml);

关键说明 #

• 持久性保障：只要原始HTML中h2的顺序和数量不变，每次加载同一页面时，计数器会按相同顺序生成一致的ID，满足持久化要求。
• 页面内唯一性：每个文档的计数器独立维护，同一页面内的h2会按顺序获得唯一索引ID。
• 线程安全：AtomicInteger确保多线程处理多个HTML文档时，计数不会混乱——多线程场景下，每个线程需持有自己的计数器实例。

进阶：基于内容的持久化（可选） #

如果需要h2位置变化但内容不变时ID仍保持一致，可以基于h2文本内容生成哈希值作为ID的一部分（需额外实现文本提取逻辑）：

(String elementName, List<String> attrs) -> {
    // 自行实现h2文本内容提取逻辑
    String h2Text = extractH2Text(elementName, attrs, ...);
    // 生成基于内容的哈希ID
    String hash = Integer.toHexString(h2Text.hashCode());
    String uniqueId = "headline-" + hash;
    attrs.add("id");
    attrs.add(uniqueId);
    attrs.add("class");
    attrs.add("scrollspy");
    return elementName;
}

这种方式ID完全绑定内容，位置变化不影响ID；若存在文本重复的情况，可结合索引后缀避免冲突。

内容的提问来源于stack exchange，提问作者Nixen85