Java&Xml-Tutorial (5) Verwendung von SAX zum Parsen von XML-Dateien

Der Java-SAX-Parsing-Mechanismus stellt uns eine Reihe von APIs zur Verarbeitung von XML-Dateien zur Verfügung. Das SAX-Parsing unterscheidet sich vom DOM-Parsing. Es lädt nicht den gesamten Inhalt der XML-Datei auf einmal, sondern lädt Teile davon kontinuierlich. Die Klasse

javax.xml.parsers.SAXParser stellt einige Funktionen zum Parsen von XML-Dokumenten mithilfe der Ereignisverarbeitung bereit. Diese Klasse implementiert die XMLReader-Schnittstelle und stellt eine überladene parse()-Methode aus File, InputStream, SAX InputSource und Read XML Document bereit aus URI-String.
Die eigentliche XML-Parsing-Arbeit wird von der Handler-Klasse abgeschlossen. Wir müssen unsere eigene Handler-Klasse erstellen, was die Implementierung der org.xml.sax.ContentHandler-Schnittstelle erfordert. Diese Schnittstelle enthält Rückrufmethoden, die Benachrichtigungen empfangen, wenn Ereignisse auftreten, wie z. B. StartDocument, EndDocument, StartElement, EndElement, CharacterData usw.

org.xml.sax.helpers.DefaultHandler stellt die Standardimplementierung der ContentHandler-Schnittstelle bereit, sodass wir diese Klasse erben können, um unsere eigene Verarbeitungsklasse zu implementieren. Die Vererbung dieser Klasse ist eine kluge Entscheidung, da wir möglicherweise nur wenige Methoden implementieren müssen. Durch die Vererbung dieser Klasse kann die Einfachheit und Wartbarkeit des Codes sichergestellt werden.
Das Folgende ist das XML-Dokument, das wir analysieren möchten:
employees.xml

<?xml version="1.0" encoding="UTF-8"?><Employees>
    <Employee id="1">
        <age>29</age>
        <name>Pankaj</name>
        <gender>Male</gender>
        <role>Java Developer</role>
    </Employee>
    <Employee id="2">
        <age>35</age>
        <name>Lisa</name>
        <gender>Female</gender>
        <role>CEO</role>
    </Employee>
    <Employee id="3">
        <age>40</age>
        <name>Tom</name>
        <gender>Male</gender>
        <role>Manager</role>
    </Employee>
    <Employee id="4">
        <age>25</age>
        <name>Meghna</name>
        <gender>Female</gender>
        <role>Manager</role>
    </Employee></Employees>

Der Inhalt dieser XML-Datei speichert einige Mitarbeiterinformationen. Jeder Mitarbeiter enthält ID-Attribute sowie Alter, Name, Geschlecht, Rollenfeld.
Wir werden den SAX-Parsing-Mechanismus verwenden, um die XML-Datei zu verarbeiten und eine Liste von Mitarbeiterobjekten zu erstellen.
Wir verwenden die Employee-Klasse, um Mitarbeiterinformationen zu abstrahieren: Employee.java

package com.journaldev.xml;public class Employee {
    private int id;    
    private String name;    
    private String gender;    
    private int age;    
    private String role;    
    public int getId() {        
    return id;
    }    public void setId(int id) {        
    this.id = id;
    }    public String getName() {        
    return name;
    }    public void setName(String name) {        
    this.name = name;
    }    public String getGender() {        
    return gender;
    }    public void setGender(String gender) {        
    this.gender = gender;
    }    public int getAge() {        
    return age;
    }    public void setAge(int age) {        
    this.age = age;
    }    public String getRole() {        
    return role;
    }    public void setRole(String role) {        
    this.role = role;
    }    @Override
    public String toString() {        
    return "Employee:: ID="+this.id+" Name=" + this.name + " Age=" + this.age + " Gender=" + this.gender +       
             " Role=" + this.role;
    }

}

Dann erben Sie die DefaultHandler-Klasse und erstellen Sie Ihre eigene Handler-Klasse MyHandler.java

package com.journaldev.xml.sax;
import java.util.ArrayList;
import java.util.List;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import com.journaldev.xml.Employee;
public class MyHandler extends DefaultHandler {

    //List to hold Employees object
    private List<Employee> empList = null;    
    private Employee emp = null;    
    //getter method for employee list
    public List<Employee> getEmpList() {        
    return empList;
    }    
    boolean bAge = false;    
    boolean bName = false;    
    boolean bGender = false;    
    boolean bRole = false;    
    @Override
    public void startElement(String uri, String localName, String qName, Attributes attributes)            
    throws SAXException {        
    if (qName.equalsIgnoreCase("Employee")) {            
    //create a new Employee and put it in Map
            String id = attributes.getValue("id");            
            //initialize Employee object and set id attribute
            emp = new Employee();
            emp.setId(Integer.parseInt(id));            
            //initialize list
            if (empList == null)
                empList = new ArrayList<>();
        } else if (qName.equalsIgnoreCase("name")) {            
        //set boolean values for fields, will be used in setting Employee variables
            bName = true;
        } else if (qName.equalsIgnoreCase("age")) {
            bAge = true;
        } else if (qName.equalsIgnoreCase("gender")) {
            bGender = true;
        } else if (qName.equalsIgnoreCase("role")) {
            bRole = true;
        }
    }    @Override
    public void endElement(String uri, String localName, String qName) throws SAXException {        
    if (qName.equalsIgnoreCase("Employee")) {            
    //add Employee object to list
            empList.add(emp);
        }
    }    @Override
    public void characters(char ch[], int start, int length) throws SAXException {        
    if (bAge) {            
    //age element, set Employee age
            emp.setAge(Integer.parseInt(new String(ch, start, length)));
            bAge = false;
        } else if (bName) {
            emp.setName(new String(ch, start, length));
            bName = false;
        } else if (bRole) {
            emp.setRole(new String(ch, start, length));
            bRole = false;
        } else if (bGender) {
            emp.setGender(new String(ch, start, length));
            bGender = false;
        }
    }
}

Der MyHandler Die Klasse enthält eine Stores the List-Referenz des Employee-Objekts, das nur über eine entsprechende Getter-Methode verfügt. Das Employee-Objekt wird dem List-Objekt in der Ereignisverarbeitungsfunktion hinzugefügt. Die mit dem Employee-Objekt verbundenen Variablen vom Typ „Employee“ und mehrere seiner Felder werden auch in der MyHandler-Klasse definiert, um das Employee-Objekt zu erstellen festgelegt, wird es zur Liste hinzugefügt.
Wir haben mehrere wichtige Methoden startElement(), endElement() und Zeichen() neu geschrieben.
Wenn SAXParser mit dem Parsen des Dokuments beginnt und auf das Start-Tag des Elements stößt, wird die Methode startElement() aufgerufen Verwenden Sie diese Methode und verwenden Sie Variablen vom Typ Boolesch, um Elementkategorien zu unterscheiden. Bei dieser Methode erstellen wir auch das Employee-Objekt, wenn das Employee-Tag startet.
Die Methode „characters()“ wird aufgerufen, wenn SAXParser in einem Element auf Zeichenfolgendaten stößt. Wir verwenden boolesche Felder, um den Eigenschaften des Employee-Objekts Werte zuzuweisen. Die
endElement()-Methode wird aufgerufen, wenn SAXParser auf das XML-End-Tag stößt. Hier fügen wir das Employee-Objekt zum List-Objekt hinzu.
Im folgenden Testprogramm verwenden wir MyHandler, um das XML-Dokument zu analysieren und eine Liste von Mitarbeiterobjekten zu generieren.
XMLParserSAX.java

package com.journaldev.xml.sax;
import java.io.File;
import java.io.IOException;
import java.util.List;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.SAXException;
import com.journaldev.xml.Employee;
public class XMLParserSAX {

    public static void main(String[] args) {
    SAXParserFactory saxParserFactory = SAXParserFactory.newInstance();
    try {
        SAXParser saxParser = saxParserFactory.newSAXParser();
        MyHandler handler = new MyHandler();
        saxParser.parse(new File("/Users/pankaj/employees.xml"), handler);
        //Get Employees list
        List<Employee> empList = handler.getEmpList();
        //print employee information
        for(Employee emp : empList)
            System.out.println(emp);
    } catch (ParserConfigurationException | SAXException | IOException e) {
        e.printStackTrace();
    }
    }

}

Führen Sie die Programmausgabe aus:

Employee:: ID=1 Name=Pankaj Age=29 Gender=Male Role=Java DeveloperEmployee:: ID=2 Name=Lisa Age=35 
Gender=Female Role=CEOEmployee:: ID=3 Name=Tom Age=40 
Gender=Male Role=ManagerEmployee:: ID=4 Name=Meghna Age=25 Gender=Female Role=Manager

Die SAXParserFactory-Klasse stellt eine Factory-Methode bereit, um eine SAXParser-Instanz abzurufen und den Handler beim Aufrufen zu übergeben Parse-Methode des SAXParser-Objekts zur Verarbeitung von Rückrufereignissen. Der Parsing-Mechanismus von SAXParser ist zunächst etwas komplex, aber wenn Sie große XML-Dokumente verarbeiten möchten, bietet er einen effizienteren Parsing-Mechanismus als das DOM-Parsing.
Ursprüngliche Adresse: http://www.php.cn/

Der Java-SAX-Parsing-Mechanismus bietet uns eine Reihe von APIs zum Verarbeiten von XML-Dateien. Der Inhalt der XML-Dateien werden nicht alle auf einmal geladen, sondern kontinuierlich in Teilen. Die Klasse

javax.xml.parsers.SAXParser stellt einige Funktionen zum Parsen von XML-Dokumenten mithilfe der Ereignisverarbeitung bereit. Diese Klasse implementiert die XMLReader-Schnittstelle und stellt eine überladene parse()-Methode zum Lesen von XML bereit dokumentieren.
Die eigentliche XML-Parsing-Arbeit wird von der Handler-Klasse abgeschlossen. Wir müssen unsere eigene Handler-Klasse erstellen, was die Implementierung der org.xml.sax.ContentHandler-Schnittstelle erfordert. Diese Schnittstelle enthält Rückrufmethoden, die Benachrichtigungen empfangen, wenn Ereignisse auftreten, wie z. B. StartDocument, EndDocument, StartElement, EndElement, CharacterData usw.

org.xml.sax.helpers.DefaultHandler stellt die Standardimplementierung der ContentHandler-Schnittstelle bereit, sodass wir diese Klasse erben können, um unsere eigene Verarbeitungsklasse zu implementieren. Die Vererbung dieser Klasse ist eine kluge Entscheidung, da wir möglicherweise nur wenige Methoden implementieren müssen. Durch die Vererbung dieser Klasse kann die Einfachheit und Wartbarkeit des Codes sichergestellt werden.
Das Folgende ist das XML-Dokument, das wir analysieren möchten:
employees.xml

<?xml version="1.0" encoding="UTF-8"?><Employees>
    <Employee id="1">
        <age>29</age>
        <name>Pankaj</name>
        <gender>Male</gender>
        <role>Java Developer</role>
    </Employee>
    <Employee id="2">
        <age>35</age>
        <name>Lisa</name>
        <gender>Female</gender>
        <role>CEO</role>
    </Employee>
    <Employee id="3">
        <age>40</age>
        <name>Tom</name>
        <gender>Male</gender>
        <role>Manager</role>
    </Employee>
    <Employee id="4">
        <age>25</age>
        <name>Meghna</name>
        <gender>Female</gender>
        <role>Manager</role>
    </Employee></Employees>

Der Inhalt dieser XML-Datei speichert einige Mitarbeiterinformationen. Jeder Mitarbeiter enthält ID-Attribute sowie Alter, Name, Geschlecht, Rollenfeld.
Wir werden den SAX-Parsing-Mechanismus verwenden, um die XML-Datei zu verarbeiten und eine Liste von Mitarbeiterobjekten zu erstellen.
Wir verwenden die Employee-Klasse, um Mitarbeiterinformationen zu abstrahieren: Employee.java

package com.journaldev.xml;public class Employee {
    private int id;    
    private String name;    
    private String gender;    
    private int age;    
    private String role;    
    public int getId() {        
    return id;
    }    public void setId(int id) {        
    this.id = id;
    }    public String getName() {        
    return name;
    }    public void setName(String name) {        
    this.name = name;
    }    public String getGender() {        
    return gender;
    }    public void setGender(String gender) {        
    this.gender = gender;
    }    public int getAge() {        
    return age;
    }    public void setAge(int age) {        
    this.age = age;
    }    public String getRole() {        
    return role;
    }    public void setRole(String role) {        
    this.role = role;
    }    @Override
    public String toString() {        
    return "Employee:: ID="+this.id+" Name=" + this.name + " Age=" + this.age + " Gender=" + this.gender +         
           " Role=" + this.role;
    }

}

Dann erben wir die DefaultHandler-Klasse, um unsere eigene Handler-Klasse MyHandler.java zu erstellen

package com.journaldev.xml.sax;
import java.util.ArrayList;
import java.util.List;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import com.journaldev.xml.Employee;
public class MyHandler extends DefaultHandler {

    //List to hold Employees object
    private List<Employee> empList = null;    
    private Employee emp = null;    
    //getter method for employee list
    public List<Employee> getEmpList() {        
    return empList;
    }    
    boolean bAge = false;    
    boolean bName = false;    
    boolean bGender = false;    
    boolean bRole = false;    
    @Override
    public void startElement(String uri, String localName, String qName, Attributes attributes)            
    throws SAXException {        
    if (qName.equalsIgnoreCase("Employee")) {            
    //create a new Employee and put it in Map
            String id = attributes.getValue("id");            
            //initialize Employee object and set id attribute
            emp = new Employee();
            emp.setId(Integer.parseInt(id));            
            //initialize list
            if (empList == null)
                empList = new ArrayList<>();
        } else if (qName.equalsIgnoreCase("name")) {            
        //set boolean values for fields, will be used in setting Employee variables
            bName = true;
        } else if (qName.equalsIgnoreCase("age")) {
            bAge = true;
        } else if (qName.equalsIgnoreCase("gender")) {
            bGender = true;
        } else if (qName.equalsIgnoreCase("role")) {
            bRole = true;
        }
    }    @Override
    public void endElement(String uri, String localName, String qName) throws SAXException {        
    if (qName.equalsIgnoreCase("Employee")) {            
    //add Employee object to list
            empList.add(emp);
        }
    }    @Override
    public void characters(char ch[], int start, int length) throws SAXException {        
    if (bAge) {            
    //age element, set Employee age
            emp.setAge(Integer.parseInt(new String(ch, start, length)));
            bAge = false;
        } else if (bName) {
            emp.setName(new String(ch, start, length));
            bName = false;
        } else if (bRole) {
            emp.setRole(new String(ch, start, length));
            bRole = false;
        } else if (bGender) {
            emp.setGender(new String(ch, start, length));
            bGender = false;
        }
    }
}

MyHandler类持有一个存放Employee对象的List引用，它只有一个对应的getter方法。Employee对象在事件处理函数中被添加到List对象，在MyHandler类中还定义了Employee对象和它的几个字段相关的boolean类型变量用于创建Employee对象，当Employee对象的所有属性都被设置时，它就会被添加到list中。
我们重写了几个重要的方法startElement(), endElement() 和characters().
当SAXParser 开始解析文档时遇到元素的开始标签时，startElement() 方法就会被调用，我们重写了这个方法，使用boolean类型变量来区分元素类别。我们也是在该方法中，当Employee 标签开始时创建Employee 对象。
当SAXParser遇到元素中的字符串数据时characters()方法会被调用，我们使用boolean类型字段为Employee对象的属性进行赋值。
endElement()方法则会在SAXParser 遇到XML结束标签时会被调用，在这里我们將Employee对象添加到List对象中。
在下面的测试程序中，我们使用MyHandler解析XML文档生成存放Employee 对象List。
XMLParserSAX.java

package com.journaldev.xml.sax;
import java.io.File;
import java.io.IOException;
import java.util.List;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.SAXException;
import com.journaldev.xml.Employee;
public class XMLParserSAX {

    public static void main(String[] args) {
    SAXParserFactory saxParserFactory = SAXParserFactory.newInstance();
    try {
        SAXParser saxParser = saxParserFactory.newSAXParser();
        MyHandler handler = new MyHandler();
        saxParser.parse(new File("/Users/pankaj/employees.xml"), handler);
        //Get Employees list
        List<Employee> empList = handler.getEmpList();
        //print employee information
        for(Employee emp : empList)
            System.out.println(emp);
    } catch (ParserConfigurationException | SAXException | IOException e) {
        e.printStackTrace();
    }
    }

}

运行程序输出：

Employee:: ID=1 Name=Pankaj Age=29 Gender=Male Role=Java 
DeveloperEmployee:: ID=2 Name=Lisa Age=35 Gender=Female Role=CEOEmployee:: ID=3 Name=Tom Age=40 
Gender=Male Role=ManagerEmployee:: ID=4 Name=Meghna Age=25 Gender=Female Role=Manager

SAXParserFactory 类提供了工厂方法来获取SAXParser 实例，在调用 SAXParser对象的parse方法时传入Handler对象来处理回调事件。SAXParser解析机制刚开始接触时有点复杂，但是当你致力于处理大型的XML文档时，它比DOM解析提供了更有效的解析机制。

以上就是Java&Xml教程（五）使用SAX方式解析XML文件的内容，更多相关内容请关注PHP中文网（www.php.cn）！