Java StAX 解析器 - 解析 XML 文档

上一页
下一页

Java StAX 解析器 API 包含用于以事件形式解析 XML 文档的类、方法和接口。它是一个基于拉取的 API，使客户端程序能够仅在需要时访问事件，从而拥有更多权限。在本章中，我们将详细了解如何使用 StAX 解析器 API 在 Java 中解析 XML 文档。

使用 Java StAX 解析器解析 XML

以下是使用 Java StAX 解析器解析文档时使用的步骤：

  • 步骤 1：创建 XMLInputFactory 实例
  • 步骤 2：读取 XML
  • 步骤 3：解析 XML
  • 步骤 4：检索元素

步骤 1：创建 XMLInputFactory 实例

XMLInputFactory 类是一个抽象类，用于获取输入流。要创建 XMLInputFactory 的新实例，我们使用 newInstance() 方法。如果无法加载此工厂的实例，则会抛出一个名为“FactoryConfigurationError”的错误。

XMLInputFactory factory = XMLInputFactory.newInstance();

步骤 2：读取 XML

FileReader 类用于从输入文件读取字符流。如果找不到文件或由于某些原因无法读取文件，则以下语句将抛出“FileNotFoundException”。

FileReader fileReader = new FileReader("src/input.txt");

除了从文件读取 XML 内容外，我们还可以获取字符串形式的内容并将其转换为字节，如下所示：

StringBuilder xmlBuilder = new StringBuilder();
xmlBuilder.append("<class>xyz</class>");
ByteArrayInputStream input = new ByteArrayInputStream(xmlBuilder.toString().getBytes("UTF-8"));

步骤 3：解析 XML

要解析 XML 事件，我们通过传递 FileReader 对象或输入流对象从 XMLInputFactory 对象创建 XMLEventReader。如果 XMLEventReader 的创建不成功，则会抛出 XMLStreamException。

XMLEventReader eventReader = factory.createXMLEventReader(input);

步骤 4：检索元素

XMLEventReader 的nextEvent() 方法以 XMLEvent 对象的形式返回下一个 XML 事件。XMLEvent 具有将事件作为 startElement、endElement 和 Characters 返回的方法。

XMLEvent event = eventReader.nextEvent();

检索元素名称

要检索元素名称，我们应该首先从 XML 文档中获取元素。当事件类型为 XMLStreamConstants.START_ELEMENT 时，XMLEvent 对象上的asStartElement() 会以 StartElement 对象的形式检索元素。

StartElement 的getName() 方法以字符串形式返回元素的名称。

示例

RetrieveElementName.java 程序将 StringBuilder 对象中的 XML 内容获取并转换为字节。获得的 InputStream 用于创建 XMLEventReader。元素是使用解析器通知的事件访问的。

import java.io.ByteArrayInputStream;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.XMLEvent;

public class RetrieveElementName {
   public static void main(String args[]) {
      try {
    	  
         //Creating XMLInputFactory instance
    	 XMLInputFactory factory = XMLInputFactory.newInstance();
    	  
    	 //Reading the XML
 	     StringBuilder xmlBuilder = new StringBuilder();
 	     xmlBuilder.append("<class>xyz</class>");
 	     ByteArrayInputStream input = new ByteArrayInputStream(xmlBuilder.toString().getBytes("UTF-8"));
 	     
 	     //Parsing the XML
         XMLEventReader eventReader =
         factory.createXMLEventReader(input);
         
         //Retrieving the Elements
         while(eventReader.hasNext()) {
            XMLEvent event = eventReader.nextEvent();
            if(event.getEventType()==XMLStreamConstants.START_ELEMENT) {
            StartElement startElement = event.asStartElement();
            System.out.println("Element Name: " + startElement.getName());
            }
         }  
      } catch(Exception e) {
    	  e.printStackTrace();
      }
   }
}

输出

元素的名称显示在输出屏幕上。

Element Name: class

检索文本内容

要检索元素的文本内容，在 XMLEvent 对象上使用asCharacters() 方法。只有当事件类型为 XMLStreamConstants.CHARACTERS 时，我们才能使用 asCharacters() 方法。此方法以 Characters 对象的形式返回数据。getData() 方法用于以字符串形式获取文本内容。

示例

在前面的示例中，我们将 XML 内容作为输入流获取。现在，让我们通过将以下 XML 内容保存在名为“classData.xml”的文件中来读取文件作为输入。

<class>xyz</class>

在以下RetrievingTextContent.java 程序中，我们使用 FileReader 对象读取了 classData.xml 文件，并将其作为输入传递给 XMLEventReader。使用 XMLEvent 对象，我们获得了元素的文本内容。

import java.io.FileReader;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.events.Characters;
import javax.xml.stream.events.XMLEvent;

public class RetrievingTextContent {
   public static void main(String args[]) {
      try {
    	  
    	 //Creating XMLInputFactory instance
    	 XMLInputFactory factory = XMLInputFactory.newInstance();
    	 
    	 //Reading the XML
    	 FileReader fileReader = new FileReader("classData.xml");
    	 
    	 //Parsing the XML
         XMLEventReader eventReader =
         factory.createXMLEventReader(fileReader);
         
         //Retrieving the Elements
         while(eventReader.hasNext()) {
            XMLEvent event = eventReader.nextEvent();
            if(event.getEventType()==XMLStreamConstants.CHARACTERS) {
            	Characters characters = event.asCharacters();
            	System.out.println("Text Content : "+ characters.getData());
            }
         }  
      } catch(Exception e) {
    	  e.printStackTrace();
      }
   }
}

输出

元素的文本内容显示在输出屏幕上。

Text Content : xyz

检索属性

StartElement 接口的getAttributes() 方法返回在此元素上声明的属性的只读迭代器。如果在此元素上没有声明任何属性，则返回一个空迭代器。

Attribute 接口上的getValue() 函数以字符串形式返回属性的值。

示例

以下classData.xml 包含三个学生的信息以及他们的学号作为属性。让我们使用 Java 中的 StAX API 检索此信息。

<?xml version = "1.0"?>
<class>
   <student rollno = "393">
      <firstname>dinkar</firstname>
      <lastname>kad</lastname>
      <nickname>dinkar</nickname>
      <marks>85</marks>
   </student>
   
   <student rollno = "493">
      <firstname>Vaneet</firstname>
      <lastname>Gupta</lastname>
      <nickname>vinni</nickname>
      <marks>95</marks>
   </student>
   
   <student rollno = "593">
      <firstname>jasvir</firstname>
      <lastname>singn</lastname>
      <nickname>jazz</nickname>
      <marks>90</marks>
   </student>
</class>

在以下RetrieveAttributes.java 程序中，我们使用了 switch case 语句来处理 START_ELEMENT、CHARACTERS 和 END_ELEMENT XMLStreamConstants，以访问所有元素的信息。

import java.io.FileNotFoundException;
import java.io.FileReader;
import java.util.Iterator;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.Attribute;
import javax.xml.stream.events.Characters;
import javax.xml.stream.events.EndElement;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.XMLEvent;

public class RetrievingAttributes {
   public static void main(String[] args) {
      boolean bFirstName = false;
      boolean bLastName = false;
      boolean bNickName = false;
      boolean bMarks = false;
      
      try {
    	  
         //Creating XMLInputFactory instance 
         XMLInputFactory factory = XMLInputFactory.newInstance(); 
         
         //Reading the XML
         FileReader fileReader = new FileReader("classData.xml");
         
         //Parsing the XML
         XMLEventReader eventReader =
         factory.createXMLEventReader(fileReader);
         
         //Retrieving the Elements
         while(eventReader.hasNext()) {
            XMLEvent event = eventReader.nextEvent();
              
            switch(event.getEventType()) {
               
               case XMLStreamConstants.START_ELEMENT:
                  StartElement startElement = event.asStartElement();
                  String qName = startElement.getName().getLocalPart();

               if (qName.equalsIgnoreCase("student")) {
                  System.out.println("Start Element : student");
                  Iterator<Attribute> attributes = startElement.getAttributes();
                  String rollNo = attributes.next().getValue();
                  System.out.println("Roll No : " + rollNo);
               } else if (qName.equalsIgnoreCase("firstname")) {
                  bFirstName = true;
               } else if (qName.equalsIgnoreCase("lastname")) {
                  bLastName = true;
               } else if (qName.equalsIgnoreCase("nickname")) {
                  bNickName = true;
               }
               else if (qName.equalsIgnoreCase("marks")) {
                  bMarks = true;
               }
               break;

               case XMLStreamConstants.CHARACTERS:
                  Characters characters = event.asCharacters();
               if(bFirstName) {
                  System.out.println("First Name: " + characters.getData());
                  bFirstName = false;
               }
               if(bLastName) {
                  System.out.println("Last Name: " + characters.getData());
                  bLastName = false;
               }
               if(bNickName) {
                  System.out.println("Nick Name: " + characters.getData());
                  bNickName = false;
               }
               if(bMarks) {
                  System.out.println("Marks: " + characters.getData());
                  bMarks = false;
               }
               break;

               case XMLStreamConstants.END_ELEMENT:
                  EndElement endElement = event.asEndElement();
                  
               if(endElement.getName().getLocalPart().equalsIgnoreCase("student")) {
                  System.out.println("End Element : student");
                  System.out.println();
               }
               break;
            } 
         }
      } catch (FileNotFoundException e) {
         e.printStackTrace();
      } catch (XMLStreamException e) {
         e.printStackTrace();
      }
   }
}

输出

所有学生的信息以及他们的学号都显示在输出屏幕上。

Start Element : student
Roll No : 393
First Name: dinkar
Last Name: kad
Nick Name: dinkar
Marks: 85
End Element : student

Start Element : student
Roll No : 493
First Name: Vaneet
Last Name: Gupta
Nick Name: vinni
Marks: 95
End Element : student

Start Element : student
Roll No : 593
First Name: jasvir
Last Name: singn
Nick Name: jazz
Marks: 90
End Element : student
打印页面
上一页
下一页
广告