如何处理未知实体引用？

Question

我正在解析（很多）包含我事先不知道的实体引用的 XML 文件（无法改变这一事实）。

例如：

xml = "<tag>I'm content with &funny; &entity; &references;.</tag>"

当我尝试使用以下代码解析时：

final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
final DocumentBuilder db = dbf.newDocumentBuilder();
final InputSource is = new InputSource(new StringReader(xml));
final Document d = db.parse(is);

我得到以下异常：

org.xml.sax.SAXParseException: The entity "funny" was referenced, but not declared.

但是，我想要实现的是，解析器将每个未声明的实体（解析器未知）替换为空字符串“”。 或者更好的是，有没有办法将映射传递给解析器，例如：

Map<String,String> entityMapping = ...
entityMapping.put("funny","very");
entityMapping.put("entity","important");
entityMapping.put("references","stuff");

这样我就可以做到以下几点：

final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
final DocumentBuilder db = dbf.newDocumentBuilder();
final InputSource is = new InputSource(new StringReader(xml));

db.setEntityResolver(entityMapping);
final Document d = db.parse(is);

如果我会使用此示例代码从文档中获取文本，我应该会收到：

I'm content with very important stuff.

有什么建议吗？当然，我已经很乐意用空字符串替换未知实体。

谢谢，

Answer 1

StAX API 对此提供支持。看看XMLInputFactory，它有一个runtime property，它指示内部实体是扩展还是保留在原地。如果设置为 false，则 StAX 事件流将包含 EntityReference 的实例以表示未扩展的实体。

如果你仍然想要一个 DOM 作为最终结果，你可以像这样将它链接在一起：

XMLInputFactory inputFactory = XMLInputFactory.newInstance();
inputFactory.setProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, false);
Transformer transformer = TransformerFactory.newInstance().newTransformer();

String xml = "my xml";
StringReader xmlReader = new StringReader(xml);
XMLEventReader eventReader = inputFactory.createXMLEventReader(xmlReader);
StAXSource source = new StAXSource(eventReader);
DOMResult result = new DOMResult();

transformer.transform(source, result);

Node document = result.getNode();

在这种情况下，生成的 DOM 将包含与文本节点混合的 org.w3c.dom.EntityReference 节点。然后，您可以根据需要处理这些内容。

Answer 2

既然你的 XML 输入似乎可以作为字符串使用，你能不能用正则表达式替换做一个简单的预处理？

xml = "...";

/* replace entities before parsing */
for (Map.Entry<String,String> entry : entityMapping.entrySet()) {
   xml = xml.replaceAll("&" + entry.getKey() + ";", entry.getValue());
}

DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
...

这很 hacky，您可能需要花费一些额外的精力来确保正则表达式只匹配它们真正应该匹配的位置（想想<entity name="&don't-match-me;"/>），但至少它是……

当然，有比多次调用replaceAll()更有效的方法来达到同样的效果。

Answer 3

您可以在文件的开头添加实体。更多信息请关注here。

您还可以查看this thread，其中似乎有人实现了 EntityResolver 接口（您也可以实现 EntityResolver2 ！），您可以在其中动态处理实体（例如使用您建议的 Map）。

WARNING: there is a bug! 在 jdk6 中，但你可以用 jdk5 试试