Java XMLStreamWriter怎么用 StAX写入XML

Java中用XMLStreamWriter生成XML需通过XMLOutputFactory.newInstance()获取工厂,调用createXMLStreamWriter创建写入器,依次调用writeStartDocument、writeStartElement、writeAttribute、writeCharacters、writeEndElement、writeEndDocument等方法按序写入,嵌套靠start/end成对,空元素用writeEmptyElement,须用try-with-resources确保close以避免截断或泄漏。

Java 中用 XMLStreamWriter(StAX 写入器)生成 XML,核心是获取工厂、创建写入器、按顺序调用方法写标签和内容,最后记得关闭。

获取 XMLStreamWriter 实例

不能直接 new,要通过 XMLOutputFactory 创建:

  • 推荐用 XMLOutputFactory.newInstance() 获取工厂(JDK 自带实现)
  • 调用 createXMLStreamWriter(OutputStream)createXMLStreamWriter(Writer) 得到写入器
  • 可选:设置格式化(如缩进),需启用 setProperty("javax.xml.stream.isRepairingNamespaces", true) 或配合 IndentingXMLStreamWriter(非标准,需自行封装或用第三方)

写入基本结构:声明、元素、属性、文本

按 XML 逻辑顺序调用方法:

  • writeStartDocument() —— 输出
  • writeStartElement("root") —— 输出
  • writeAttribute("id", "123") —— 在当前开始标签内加属性:
  • writeCharacters("Hello") —— 写文本内容(会自动转义特殊字符)
  • writeEndElement() —— 输出对应结束标签
  • writeEndDocument() —— 结束整个文档(可选,但建议显式调用)

处理嵌套与空元素

嵌套靠 start/end 成对调用;空元素可用 writeEmptyElement("tag") 直接输出

  • Alice30,需 start → start → characters → end → start → characters → end → end
  • ,直接 writeEmptyElement("photo") + writeAttribute("href", "a.jpg")

异常与资源管理

XMLStreamWriter 方法抛出 XMLStreamException,必须捕获或声明;务必在 finally 或 try-with-resources 中 close:

  • 推荐用 try-with-resources(XMLStreamWriter 实现 AutoCloseable
  • 不 close 可能导致部分缓冲内容未写出,或资源泄漏
  • 如果底层是 FileOutputStream,也要确保它被正确关闭(通常包装在 try-with-resources 里即可)

不复杂但容易忽略细节,比如忘记写 writeStartDocument、属性写在了错误的元素层级、或没关流导致输出截断。