Tutoriel Java&Xml (5) Utiliser SAX pour analyser des fichiers XML

Le mécanisme d'analyse Java SAX nous fournit une série d'API pour traiter les fichiers XML. L'analyse SAX est différente de l'analyse DOM. Elle ne charge pas tout le contenu du fichier XML en une seule fois, mais en charge des parties en continu. La classe

javax.xml.parsers.SAXParser fournit certaines fonctions pour analyser les documents XML à l'aide du traitement d'événements. Cette classe implémente l'interface XMLReader et fournit une méthode parse() surchargée à partir de File, InputStream, SAX InputSource et Read XML document. à partir de la chaîne URI.
Le travail d'analyse XML proprement dit est effectué par la classe Handler. Nous devons créer notre propre classe Handler, ce qui nous oblige à implémenter l'interface org.xml.sax.ContentHandler. Cette interface contient des méthodes de rappel qui reçoivent des notifications lorsque des événements se produisent, telles que StartDocument, EndDocument, StartElement, EndElement, CharacterData, etc.

org.xml.sax.helpers.DefaultHandler fournit l'implémentation par défaut de l'interface ContentHandler, nous pouvons donc hériter de cette classe pour implémenter notre propre classe de traitement. Hériter de cette classe est un choix judicieux car nous n’aurons peut-être besoin que d’implémenter quelques méthodes. L'héritage de cette classe peut garantir la simplicité et la maintenabilité du code.
Voici le document XML que nous souhaitons analyser :
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>

Le contenu de ce fichier XML stocke certaines informations sur l'employé. Chaque employé contient les attributs d'identification et l'âge, le nom, genre, champ de rôle.
Nous utiliserons le mécanisme d'analyse SAX pour traiter le fichier XML et créer une liste d'objets employés.
Nous utilisons la classe Employee pour extraire les informations sur les employés : 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;
    }

}

Puis héritez de la classe DefaultHandler et créez votre propre classe Handler 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;
        }
    }
}

Le MyHandler La classe contient une référence Stocke la liste de l'objet Employee, qui n'a qu'une seule méthode getter correspondante. L'objet Employee est ajouté à l'objet List dans la fonction de gestion des événements. Les variables de type booléen liées à l'objet Employee et plusieurs de ses champs sont également définies dans la classe MyHandler pour créer l'objet Employee lorsque toutes les propriétés de l'objet Employee sont. défini, il sera ajouté à la liste.
Nous avons réécrit plusieurs méthodes importantes startElement(), endElement() et caractères()
Lorsque SAXParser commence à analyser le document et rencontre la balise de début de l'élément, la méthode startElement() sera appelée. cette méthode et utiliser des variables de type booléen pour distinguer les catégories d'éléments. C'est également dans cette méthode que l'on crée l'objet Employee au démarrage de la balise Employee.
La méthode caractères() sera appelée lorsque SAXParser rencontre des données de chaîne dans un élément. Nous utilisons des champs de type booléen pour attribuer des valeurs aux propriétés de l'objet Employee. La méthode
endElement() sera appelée lorsque SAXParser rencontre la balise de fin XML. Ici, nous ajoutons l'objet Employee à l'objet List.
Dans le programme de test suivant, nous utilisons MyHandler pour analyser le document XML afin de générer une liste d'objets Employee.
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();
    }
    }

}

Exécutez le résultat du programme :

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

La classe SAXParserFactory fournit une méthode d'usine pour obtenir une instance de SAXParser et transmet le gestionnaire lors de l'appel du méthode d'analyse de l'objet SAXParser pour gérer les événements de rappel. Le mécanisme d'analyse SAXParser est un peu complexe au début, mais lorsque vous vous engagez à traiter des documents XML volumineux, il fournit un mécanisme d'analyse plus efficace que l'analyse DOM.
Adresse originale : http://www.php.cn/

Le mécanisme d'analyse Java SAX nous fournit une série d'API pour traiter les fichiers XML. Le contenu de l'analyse SAX est différent. Les fichiers XML ne sont pas chargés en une seule fois, mais sont chargés en plusieurs parties en continu. La classe

javax.xml.parsers.SAXParser fournit certaines fonctions pour analyser les documents XML à l'aide du traitement d'événements. Cette classe implémente l'interface XMLReader et fournit une méthode parse() surchargée à partir des chaînes File, InputStream, SAX InputSource et URI. document.
Le travail d'analyse XML proprement dit est effectué par la classe Handler. Nous devons créer notre propre classe Handler, ce qui nous oblige à implémenter l'interface org.xml.sax.ContentHandler. Cette interface contient des méthodes de rappel qui reçoivent des notifications lorsque des événements se produisent, telles que StartDocument, EndDocument, StartElement, EndElement, CharacterData, etc.

org.xml.sax.helpers.DefaultHandler fournit l'implémentation par défaut de l'interface ContentHandler, nous pouvons donc hériter de cette classe pour implémenter notre propre classe de traitement. Hériter de cette classe est un choix judicieux car nous n’aurons peut-être besoin que d’implémenter quelques méthodes. L'héritage de cette classe peut garantir la simplicité et la maintenabilité du code.
Voici le document XML que nous souhaitons analyser :
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>

Le contenu de ce fichier XML stocke certaines informations sur l'employé. Chaque employé contient les attributs d'identification et l'âge, le nom, genre, champ de rôle.
Nous utiliserons le mécanisme d'analyse SAX pour traiter le fichier XML et créer une liste d'objets employés.
Nous utilisons la classe Employee pour extraire les informations sur les employés : 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;
    }

}

Ensuite, héritons de la classe DefaultHandler pour créer notre propre classe Handler 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;
        }
    }
}

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）！