Java Sax解析xml文件

1.   Java Sax解析是按照xml文件的顺序一步一步的来解析，在解析xml文件之前，我们要先了解xml文件的节点的种类，一种是ElementNode，一种是TextNode。如下面的这段book.xml

Xml代码

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <books> 
3.     <book id="12"> 
4.         <name>thinking in java</name> 
5.         <price>85.5</price> 
6.     </book> 
7.     <book id="15"> 
8.         <name>Spring in Action</name> 
9.         <price>39.0</price> 
10.     </book> 
11. </books> 

<?xml version="1.0" encoding="UTF-8"?>
<books>
	<book id="12">
		<name>thinking in java</name>
		<price>85.5</price>
	</book>
	<book id="15">
		<name>Spring in Action</name>
		<price>39.0</price>
	</book>
</books>

其中，像<books>、<book>这种节点就属于ElementNode,而thinking in java、85.5这种就属于TextNode。

下面结合一张图来详细讲解Sax解析。

xml文件被Sax解析器载入，由于Sax解析是按照xml文件的顺序来解析，当读入<?xml.....>时，会调用startDocument()方法，当读入<books>的时候，由于它是个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，是再取值，才能取到thinking in java。具体见代码：SaxParseService.java

Java代码

1. import java.io.InputStream; 
2. import java.util.ArrayList; 
3. import java.util.List; 
4.  
5. import javax.xml.parsers.SAXParser; 
6. import javax.xml.parsers.SAXParserFactory; 
7.  
8. import org.xml.sax.Attributes; 
9. import org.xml.sax.SAXException; 
10. import org.xml.sax.helpers.DefaultHandler; 
11.  
12. import com.xtlh.cn.entity.Book; 
13.  
14. public class SaxParseService extends DefaultHandler{ 
15.     private List<Book> books = null; 
16.     private Book book = null; 
17.     private String preTag = null;//作用是记录解析时的上一个节点名称 
18.      
19.     public List<Book> getBooks(InputStream xmlStream) throws Exception{ 
20.         SAXParserFactory factory = SAXParserFactory.newInstance(); 
21.         SAXParser parser = factory.newSAXParser(); 
22.         SaxParseService handler = new SaxParseService(); 
23.         parser.parse(xmlStream, handler); 
24.         return handler.getBooks(); 
25.     } 
26.      
27.     public List<Book> getBooks(){ 
28.         return books; 
29.     } 
30.      
31.     @Override 
32.     public void startDocument() throws SAXException { 
33.         books = new ArrayList<Book>(); 
34.     } 
35.  
36.     @Override 
37.     public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { 
38.         if("book".equals(qName)){ 
39.             book = new Book(); 
40.             book.setId(Integer.parseInt(attributes.getValue(0))); 
41.         } 
42.         preTag = qName;//将正在解析的节点名称赋给preTag 
43.     } 
44.  
45.     @Override 
46.     public void endElement(String uri, String localName, String qName) 
47.             throws SAXException { 
48.         if("book".equals(qName)){ 
49.             books.add(book); 
50.             book = null; 
51.         } 
52.         preTag = null;/**当解析结束时置为空。这里很重要，例如，当图中画3的位置结束后，会调用这个方法
53.         ，如果这里不把preTag置为null，根据startElement(....)方法，preTag的值还是book，当文档顺序读到图
54.         中标记4的位置时，会执行characters(char[] ch, int start, int length)这个方法，而characters(....)方
55.         法判断preTag!=null，会执行if判断的代码，这样就会把空值赋值给book，这不是我们想要的。*/ 
56.     } 
57.      
58.     @Override 
59.     public void characters(char[] ch, int start, int length) throws SAXException { 
60.         if(preTag!=null){ 
61.             String content = new String(ch,start,length); 
62.             if("name".equals(preTag)){ 
63.                 book.setName(content); 
64.             }else if("price".equals(preTag)){ 
65.                 book.setPrice(Float.parseFloat(content)); 
66.             } 
67.         } 
68.     } 
69.      
70. } 

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

import com.xtlh.cn.entity.Book;

public class SaxParseService extends DefaultHandler{
	private List<Book> books = null;
	private Book book = null;
	private String preTag = null;//作用是记录解析时的上一个节点名称
	
	public List<Book> getBooks(InputStream xmlStream) throws Exception{
		SAXParserFactory factory = SAXParserFactory.newInstance();
		SAXParser parser = factory.newSAXParser();
		SaxParseService handler = new SaxParseService();
		parser.parse(xmlStream, handler);
		return handler.getBooks();
	}
	
	public List<Book> getBooks(){
		return books;
	}
	
	@Override
	public void startDocument() throws SAXException {
		books = new ArrayList<Book>();
	}

	@Override
	public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
		if("book".equals(qName)){
			book = new Book();
			book.setId(Integer.parseInt(attributes.getValue(0)));
		}
		preTag = qName;//将正在解析的节点名称赋给preTag
	}

	@Override
	public void endElement(String uri, String localName, String qName)
			throws SAXException {
		if("book".equals(qName)){
			books.add(book);
			book = null;
		}
		preTag = null;/**当解析结束时置为空。这里很重要，例如，当图中画3的位置结束后，会调用这个方法
		，如果这里不把preTag置为null，根据startElement(....)方法，preTag的值还是book，当文档顺序读到图
		中标记4的位置时，会执行characters(char[] ch, int start, int length)这个方法，而characters(....)方
		法判断preTag!=null，会执行if判断的代码，这样就会把空值赋值给book，这不是我们想要的。*/
	}
	
	@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)){
				book.setName(content);
			}else if("price".equals(preTag)){
				book.setPrice(Float.parseFloat(content));
			}
		}
	}
	
}

  Book.java如下：主要是用来组装数据

Java代码

1. public class Book { 
2.     private int id; 
3.     private String name; 
4.     private float price; 
5.     public int getId() { 
6.         return id; 
7.     } 
8.     public void setId(int id) { 
9.         this.id = id; 
10.     } 
11.     public String getName() { 
12.         return name; 
13.     } 
14.     public void setName(String name) { 
15.         this.name = name; 
16.     } 
17.     public float getPrice() { 
18.         return price; 
19.     } 
20.     public void setPrice(float price) { 
21.         this.price = price; 
22.     } 
23.     @Override 
24.     public String toString(){ 
25.         return this.id+":"+this.name+":"+this.price; 
26.     } 
27. } 

public class Book {
	private int id;
	private String name;
	private float price;
	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 float getPrice() {
		return price;
	}
	public void setPrice(float price) {
		this.price = price;
	}
	@Override
	public String toString(){
		return this.id+":"+this.name+":"+this.price;
	}
}

测试是用的单元测试，测试代码如下：ParseTest

Java代码

1. import java.io.InputStream; 
2. import java.util.List; 
3.  
4. import junit.framework.TestCase; 
5.  
6. import com.xtlh.cn.demo.DomParseService; 
7. import com.xtlh.cn.demo.SaxParseService; 
8. import com.xtlh.cn.entity.Book; 
9.  
10. public class ParseTest extends TestCase{ 
11.  
12.     public void testSAX() throws Throwable{ 
13.         SaxParseService sax = new SaxParseService(); 
14.         InputStream input = this.getClass().getClassLoader().getResourceAsStream("book.xml"); 
15.         List<Book> books = sax.getBooks(input); 
16.         for(Book book : books){ 
17.             System.out.println(book.toString()); 
18.         } 
19.     } 
20. } 

import java.io.InputStream;
import java.util.List;

import junit.framework.TestCase;

import com.xtlh.cn.demo.DomParseService;
import com.xtlh.cn.demo.SaxParseService;
import com.xtlh.cn.entity.Book;

public class ParseTest extends TestCase{

	public void testSAX() throws Throwable{
		SaxParseService sax = new SaxParseService();
		InputStream input = this.getClass().getClassLoader().getResourceAsStream("book.xml");
		List<Book> books = sax.getBooks(input);
		for(Book book : books){
			System.out.println(book.toString());
		}
	}
}

在用Sax解析的时候最需要重视的一点就是不要把那些<节点>之间的空白忽略就好！