使用 StAX 读取 XML 字符串

Question

我第一次使用 stax 来解析 XML 字符串。我找到了一些例子，但无法让我的代码工作。这是我的代码的最新版本：

public class AddressResponseParser
{
    private static final String STATUS = "status";
    private static final String ADDRESS_ID = "address_id";
    private static final String CIVIC_ADDRESS = "civic_address";

    String status = null;
    String addressId = null;
    String civicAddress = null;

    public static AddressResponse parseAddressResponse(String response)
    {

        try
        {
            byte[] byteArray = response.getBytes("UTF-8");
            ByteArrayInputStream inputStream = new ByteArrayInputStream(byteArray);
            XMLInputFactory inputFactory = XMLInputFactory.newInstance();
            XMLStreamReader reader = inputFactory.createXMLStreamReader(inputStream);

            while (reader.hasNext())
            {
                int event = reader.next();

                if (event == XMLStreamConstants.START_ELEMENT)
                {
                    String element = reader.getLocalName();

                    if (element.equals(STATUS))
                    {
                        status = reader.getElementText();
                        continue;
                    }

                    if (element.equals(ADDRESS_ID))
                    {
                        addressId = reader.getText();
                        continue;
                    }

                    if (element.equals(CIVIC_ADDRESS))
                    {
                        civicAddress = reader.getText();
                        continue;
                    }
                }
            }
        }
        catch (Exception e)
        {
            log.error("Couldn't parse AddressResponse", e);
        }
    }
}

我已将监视放在“event”和“reader.getElementText()”上。当代码在“reader.getElementText()”上停止时，

String element = reader.getLocalName();

会显示值，但一旦它离开该行，就无法对其进行求值。当代码停止于：

status = reader.getElementText();

“元素”手表显示正确的值。最后，当我将代码再执行一行时，我捕获了此异常：

(com.ctc.wstx.exc.WstxParsingException) com.ctc.wstx.exc.WstxParsingException: Current state not START_ELEMENT
 at [row,col {unknown-source}]: [1,29]

我尝试使用 status = reader.getText(); 代替，但随后我得到了此异常：

(java.lang.IllegalStateException) java.lang.IllegalStateException: Not a textual event (END_ELEMENT)

有人能指出什么吗我做错了？？

编辑：

添加用于测试的 JUnit 代码：

public class AddressResponseParserTest
{
    private String status = "OK";
    private String address_id = "123456";
    private String civic_address = "727";

    @Test
    public void testAddressResponseParser() throws UnsupportedEncodingException, XMLStreamException
    {
        AddressResponse parsedResponse = AddressResponseParser.parseAddressResponse(this.responseXML());

        assertEquals(this.status, parsedResponse.getStatus());

        assertEquals(this.address_id, parsedResponse.getAddress()
                .getAddressId());
        assertEquals(this.civic_address, parsedResponse.getAddress()
                .getCivicAddress());
    }

    private String responseXML()
    {
        StringBuffer buffer = new StringBuffer();

        buffer.append("<response>");
        buffer.append("<status>OK</status>");
        buffer.append("<address>");
        buffer.append("<address_id>123456</address_id>");
        buffer.append("<civic_address>727</civic_address>");
        buffer.append("</address>");
        buffer.append("</response>");

        return buffer.toString();
    }
}

Answer 1

我找到了一个使用 XMLEventReader 而不是 XMLStreamReader 的解决方案：

public MyObject parseXML(String xml)
    throws XMLStreamException, UnsupportedEncodingException
{
    byte[] byteArray = xml.getBytes("UTF-8");
    ByteArrayInputStream inputStream = new ByteArrayInputStream(byteArray);
    XMLInputFactory inputFactory = XMLInputFactory.newInstance();
    XMLEventReader reader = inputFactory.createXMLEventReader(inputStream);

    MyObject object = new MyObject();

    while (reader.hasNext())
    {
        XMLEvent event = (XMLEvent) reader.next();

        if (event.isStartElement())
        {
            StartElement element = event.asStartElement();

            if (element.getName().getLocalPart().equals("ElementOne"))
            {
                event = (XMLEvent) reader.next();

                if (event.isCharacters())
                {
                     String elementOne = event.asCharacters().getData();
                     object.setElementOne(elementOne);
                }
                continue;
            }
            if (element.getName().getLocalPart().equals("ElementTwo"))
            {
                event = (XMLEvent) reader.next();
                if (event.isCharacters())
                {
                     String elementTwo = event.asCharacters().getData();
                     object.setElementTwo(elementTwo);
                }
                continue;
            }
        }
    }

    return object;
}

我仍然有兴趣查看使用 XMLStreamReader 的解决方案。

Answer 2

请务必阅读 Stax 的 javadocs：由于它是完全流式解析模式，因此只有当前事件包含的信息可用。但也有一些例外；例如，getElementText() 必须从 START_ELEMENT 开始，但随后会尝试组合当前元素内的所有文本标记；返回时，它将指向匹配的END_ELEMENT。

相反，START_ELEMENT 上的 getText() 将不会返回任何有用的内容（因为 START_ELEMENT 引用标签，而不是“开始/结束元素对”内部的子文本标记/节点）。如果您想使用它，则必须通过调用streamReader.next();在流中显式移动光标。而 getElementText() 会为您完成此操作。

那么是什么原因导致了这个错误呢？消耗完所有开始/结束元素对后，下一个标记将是 END_ELEMENT （与父标记匹配）。因此，您必须检查是否获得了 END_ELEMENT，而不是另一个 START_ELEMENT。

Answer 3

当我收到“IllegalStateException：不是文本事件”消息时，我遇到了类似的问题
当我查看你的代码时，我发现如果你有一个条件：（

if (event == XMLStreamConstants.START_ELEMENT){
....
addressId = reader.getText(); // it throws exception here
....
}

请注意：StaXMan 确实在他的答案中指出了这一点！）

这种情况发生是因为要获取文本，XMLStreamReader 实例必须遇到“XMLStreamConstants.CHARACTERS”事件！

也许有更好的方法来做到这一点......但这是一个快速而肮脏的修复（我只显示了可能感兴趣的代码行）
现在要实现这一点，请稍微修改您的代码：

// this will tell the XMLStreamReader that it is appropriate to read the text
boolean pickupText = false

while(reader.hasNext()){

if (event == XMLStreamConstants.START_ELEMENT){
   if( (reader.getLocalName().equals(STATUS) )
   || ( (reader.getLocalName().equals(STATUS) )
   || ((reader.getLocalName().equals(STATUS) ))
         // indicate the reader that it has to pick text soon!
     pickupText = true;
   }
}else if (event == XMLStreamConstants.CHARACTERS){
  String textFromXML = reader.getText();
  // process textFromXML ...

  //...

  //set pickUpText false
  pickupText = false;

 }    

}

希望有帮助！

Answer 4

以下是 XMLStreamReader 的示例：

   XMLInputFactory inputFactory = XMLInputFactory.newInstance();
   Map<String, String> elements = new HashMap<>();

try {
   XMLStreamReader xmlReader = inputFactory.createXMLStreamReader(file);
   String elementValue = "";
   
   while (xmlReader.hasNext()) {
      int xmlEventType = xmlReader.next();
      
      switch (xmlEventType) {  
          // Check for Start Elements
          case XMLStreamConstants.START_ELEMENT:
              
              //Get current Element Name
              String elementName = xmlReader.getLocalName();
              
              if(elementName.equals("td")) {
              //Get Elements Value
              elementValue = xmlReader.getElementText();
              }
              
              //Add the new Start Element to the Map
              elements.put(elementName, elementValue);                
              break;
          default:
             break;
          }    
   }
   //Close Session
   xmlReader.close();        
} catch (Exception e) {
    log.error(e.getMessage(), e);
}