Java如何使用SAX(Simple API for XML)解析XML呢?

转自:

Java如何使用SAX(Simple API for XML)解析XML呢?

下文讲述使用SAX解析xml文档的方法分享，如下所示

SAX简介

SAX用于加载文档到内存中,它是采用事件驱动的API(Observer模式)
他按照xml文件的顺序一步一步的来解析，用户只需要注册自己感兴趣的事件即可
SAX提供EntityResolver, DTDHandler, ContentHandler, ErrorHandler接口,
分别用于监听解析实体事件、DTD处理事件、正文处理事件和处理出错事件，与AWT类似,
SAX还提供了一个对这4个接口默认的类DefaultHandler(这里的默认实现，其实就是一个空方法),
一般只要继承DefaultHandler，重写自己感兴趣的事件即可

SAX解析xml的原理:
   Sax采用事件驱动的方式解析文档
      类似于io读取的向下读取操作
 在Sax的解析过程中，读取到文档开头、结尾，元素的开头和结尾都会触发一些回调方法
 我们可以在这些回调方法中进行相应事件处理
 如:startDocument()
    endDocument()
    startElement()
    endElement

SAX XML解析步骤

Java Sax在解析xml文件之前
需先了解xml文件的节点的种类
一种是ElementNode，一种是TextNode
例:user.xml

<?xml version="1.0" encoding="UTF-8"?>  
<users>  
    <user id="12">  
        <name>maomao</name>  
        <age>18</age>  
    </user>  
    <user id="15">  
        <name>xiaoxiao</name>  
        <age>20</age>  
    </user>  
</users> 

<users>、<user>这种节点就属于ElementNode
maomao这种就属于TextNode
下面结合一张图来详细讲解Sax解析

Java SAX XML解析

将xml载入SAX，然后解析
//TestClass.java

public class SaxParseService extends DefaultHandler{  
    private List<User> users = null;  
    private User user = null;  
    private String preTag = null;//作用是记录解析时的上一个节点名称  
      
    public List<User> getUsers(InputStream xmlStream) throws Exception{  
        SAXParserFactory factory = SAXParserFactory.newInstance();  
        SAXParser parser = factory.newSAXParser();  
        SaxParseService handler = new SaxParseService();  
        parser.parse(xmlStream, handler);  
        return handler.getUsers();  
    }  
      
    public List<User> getUsers(){  
        return users;  
    }  
      
    @Override  
    public void startDocument() throws SAXException {  
        users = new ArrayList<User>();  
    }  
  
    @Override  
    public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {  
        if("user".equals(qName)){  
            user = new User();  
            user.setId(Integer.parseInt(attributes.getValue(0)));  
        }  
        preTag = qName;//将正在解析的节点名称赋给preTag  
    }  
  
    @Override  
    public void endElement(String uri, String localName, String qName)  
            throws SAXException {  
        if("user".equals(qName)){  
            users.add(user);  
            user = null;  
        }  
        preTag = null;/**当解析结束时置为空。这里很重要，例如，当图中画3的位置结束后，会调用这个方法 
        ，如果这里不把preTag置为null，根据startElement(....)方法，preTag的值还是user，当文档顺序读到图 
        中标记4的位置时，会执行characters(char[] ch, int start, int length)这个方法，而characters(....)方 
        法判断preTag!=null，会执行if判断的代码，这样就会把空值赋值给user，这不是我们想要的。*/  
    }  
      
    @Override  
    public void characters(char[] ch, int start, int length) throws SAXException {  
        if(preTag!=null){  
            String content = new String(ch,start,length);  
            if("name".equals(preTag)){  
                user.setName(content);  
            }else if("age".equals(preTag)){  
                user.setAge(Int.parseInt(content));  
            }  
        }  
    }  
}  

//User.java 主要是用来组装数据
public class User {  
    private int id;  
    private String name;  
    private int age;  
    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 int getAge() {  
        return age;  
    }  
    public void setAge(int age) {  
        this.age = age;  
    }  
    @Override  
    public String toString(){  
        return this.id+":"+this.name+":"+this.age;  
    }  
} 

 
//ParseTest
public class ParseTest extends TestCase{  
    public void testSAX() throws Throwable{  
        SaxParseService sax = new SaxParseService();  
        InputStream input = this.getClass().getClassLoader().getResourceAsStream("user.xml");  
        List<User> users = sax.getUsers(input);  
        for(User user : users){  
            System.out.println(user.toString());  
        }  
    }  
}

xml文件被Sax解析器载入
由于Sax解析是按照xml文件的顺序来解析
当读入<?xml.....>时，会调用startDocument()方法
当读入<users>的时候，由于它是个ElementNode，
所以会调用startElement(String uri, String localName, String qName, Attributes attributes) 方法，
其中第二个参数就是节点的名称
------------------------------------
注意事项:
   由于有些环境不一样，有时候第二个参数有可能为空，所以可以使用第三个参数
    因此在解析前，先调用一下看哪个参数能用，第4个参数是这个节点的属性。
	这里我们不需要这个节点，所以从<book>这个节点开始，也就是图中1的位置，
	当读入时，调用startElement(....)方法，
	由于只有一个属性id，可以通过attributes.getValue(0)来得到，然后在图中标明2的地方会调用characters(char[] ch, int start, int length)方法，不要以为那里是空白，
	Sax解析器可不那么认为，Sax解析器会把它认为是一个TextNode
	但是这个空白不是我们想要的数据，我们是想要<name>节点下的文本信息。这就要定义一个记录当上一节点的名称的TAG，在characters(.....)方法中，
	判断当前节点是不是name，是再取值，才能取到maomao

总结：  
   使用SAX解析XML采用的是从上而下的基于事件驱动的解析方式
   解析过程中会视情况自动调用startDocument()、startElement()、characters()、endElement()、endDocument()等相关的方法
1. startDocument()方法只会在文档开始解析的时候被调用，每次解析只会调用一次。
2. startElement()方法每次在开始解析一个元素，即遇到元素标签开始的时候都会调用。
3. characters()方法也是在每次解析到元素标签携带的内容时都会调用，即使该元素标签的内容为空或换行。而且如果元素内嵌套元素，在父元素结束标签前， characters()方法会再次被调用，此处需要注意。
4. endElement()方法每次在结束解析一个元素，即遇到元素标签结束的时候都会调用。
5. endDocument() startDocument()方法只会在文档解析结束的时候被调用，每次解析只会调用一次