Java怎么用StAX的XMLEventReader和XMLStreamReader

StAX提供XMLEventReader(事件迭代器)和XMLStreamReader(游标式)两种拉模式API:前者返回事件对象需instanceof判断类型,后者直接调用getLocalName()等方法获取信息,性能更高、代码更简洁,推荐优先使用。

StAX(Streaming API for XML)是Java中处理XML的流式解析方式,比DOM轻量、比SAX更灵活。它提供两种主要API:基于事件的XMLEventReader(拉模式,类似迭代器)和基于指针的XMLStreamReader(也是拉模式,但更底层、性能略高)。两者都适合读取大文件,不加载整个文档到内存。

用XMLEventReader逐个读取XML事件

XMLEventReader把XML看作一系列事件(如START_ELEMENT、CHARACTERS、END_ELEMENT),你主动调用nextEvent()peek()来获取下一个事件,适合逻辑清晰、需按顺序处理各类事件的场景。

  • 创建方式:用XMLInputFactory.newInstance().createXMLEventReader(InputStream)
  • 常用方法:hasNext()判断是否有下个事件,nextEvent()取并移进,peek()只看不移进,remove()一般不用
  • 拿到事件后,用instanceof判断类型,再强转成具体子类(如StartElementCharacters)获取属性或文本内容

例如读取Alice:遇到START_ELEMENT时检查localName是否为"name",接着调nextEvent()拿到CHARACTERS事件,再用((Characters)event).getData()取值。

用XMLStreamReader按游标方式遍历节点

XMLStreamReader不返回事件对象,而是通过当前位置(cursor)提供方法直接查询当前节点信息,比如getLocalName()getAttributeValue()getText(),更适合需要频繁访问属性和文本、且对性能较敏感的场景。

  • 创建方式:用XMLInputFactory.newInstance().createXMLStreamReader(InputStream)
  • 核心流程:循环调next()nextTag()跳过空白/注释,用getEventType()判断当前类型(如XMLStreamConstants.START_ELEMENT
  • 在START_ELEMENT时用getAttributeCount()getAttributeValue(i)取属性;在CHARACTERS时用getTextTrim()安全取文本(自动去首尾空格)

相比XMLEventReader,它不产生临时事件对象,内存开销略小,代码也更紧凑——比如判断元素名直接用if ("user".equals(getLocalName())),不用先转型。

共通注意事项和实用建议

两者都依赖XMLInputFactory,可调用setProperty(XMLInputFactory.IS_COALESCING, true)让连续字符事件自动合并(避免CDATA或换行被拆成多个CHARACTERS)。

  • 务必在使用完后关闭reader(close()),否则可能泄露资源;推荐用try-with-resources
  • 遇到XML声明(如)时,XMLEventReader会生成XmlDeclaration事件,XMLStreamReader对应XML_DECLARATION类型,通常可跳过
  • 如果XML含命名空间,记得启用支持:factory.setProperty(XMLInputFactory.IS_NAMESPACE_AWARE, true)
  • 异常处理重点捕获XMLStreamException,它涵盖格式错误、IO中断等

选哪个?简单对比

如果偏好面向对象风格、想显式操作事件对象(比如把事件缓存或转发),选XMLEventReader;如果追求简洁高效、多数逻辑围绕元素名/属性/文本展开,XMLStreamReader更顺手。实际项目中后者更常用。

基本上就这些。两者API设计不同,但目标一致:用可控的“拉”方式高效读XML,避开DOM的内存压力和SAX的回调复杂性。