Java StAX怎么读取和写入XML属性

StAX通过XMLStreamReader和XMLStreamWriter在START_ELEMENT事件中读写XML属性;读取用getAttributeValue(namespaceURI, localName),写入需在writeStartElement()后、writeEndElement()前调用writeAttribute()。

StAX(Streaming API for XML)在Java中读取和写入XML属性非常直接,核心是通过XMLStreamReaderXMLStreamWriter操作属性(attribute),而不是把属性当元素处理。

读取XML元素的属性

使用XMLStreamReader时,属性只存在于START_ELEMENT事件中。调用getAttributeCount()获取数量,再用getAttributeValue(namespaceURI, localName)getAttributeValue(index)读取值。

常见做法:

  • 先判断事件类型是否为XMLStreamConstants.START_ELEMENT
  • getAttributeCount()确认是否有属性(避免越界)
  • 推荐用命名空间+本地名方式读取,更安全;若无命名空间,namespaceURI传空字符串""

例如,对,可这样取值:

if (event == XMLStreamConstants.START_ELEMENT) {
    String id = reader.getAttributeValue("", "id");           // "101"
    String cat = reader.getAttributeValue("", "category");   // "fiction"
}

写入XML元素时添加属性

XMLStreamWriter写元素前,调用writeStartElement()开启标签,然后连续调用writeAttribute()添加属性,最后writeEndElement()闭合。

注意点:

  • writeAttribute(localName, value)最常用,适用于无命名空间场景
  • 如需带命名空间,用writeAttribute(prefix, namespaceURI, localName, value)
  • 属性必须在writeStartElement()之后、内容或子元素之前写入

示例生成

writer.writeStartElement("book");
writer.writeAttribute("id", "101");
writer.writeAttribute("category", "fiction");
writer.writeEndElement();

读写属性的典型误区

容易混淆属性(attribute)和文本内容(character data)或子元素(child element)。StAX中:

  • 属性只能出现在START_ELEMENT里,END_ELEMENT没有属性
  • 不能用getElementText()读属性——它只读起始与结束标签之间的文本
  • 写属性时若在writeStartElement()前或writeEndElement()后调用writeAttribute(),会抛XMLStreamException

完整小例子:读一个带属性的XML并原样写回

输入:
输出相同结构——验证读写一致性:

// 读
XMLInputFactory factory = XMLInputFactory.newInstance();
XMLStreamReader reader = factory.createXMLStreamReader(new StringReader(xml));
while (reader.hasNext()) {
    int event = reader.next();
    if (event == XMLStreamConstants.START_ELEMENT && "person".equals(reader.getLocalName())) {
        String name = reader.getAttributeValue("", "name");
        String age = reader.getAttributeValue("", "age");
        // 写
        XMLOutputFactory outFactory = XMLOutputFactory.newInstance();
        XMLStreamWriter writer = outFactory.createXMLStreamWriter(System.out);
        writer.writeStartElement("person");
        writer.writeAttribute("name", name);
        writer.writeAttribute("age", age);
        writer.writeEndElement();
        writer.flush();
        break;
    }
}

基本上就这些。属性操作不复杂但容易忽略事件时机和命名空间语境,盯住START_ELEMENT和写入顺序就没问题。