Java与XML联合编程之SAX篇

 

SAX概念

 

SAX是Simple API for XML的缩写，它并不是由W3C官方所提出的标准，可以说是“民间”的事实标准。实际上，它是一种社区性质的讨论产物。虽然如此，在XML中对SAX的应用丝毫不比DOM少，几乎所有的XML解析器都会支持它。
与DOM比较而言，SAX是一种轻量型的方法。我们知道，在处理DOM的时候，我们需要读入整个的XML文档，然后在内存中创建DOM树，生成DOM树上的每个Node对象。当文档比较小的时候，这不会造成什么问题，但是一旦文档大起来，处理DOM就会变得相当费时费力。特别是其对于内存的需求，也将是成倍的增长，以至于在某些应用中使用DOM是一件很不划算的事（比如在applet中）。这时候，一个较好的替代解决方法就是SAX。
SAX在概念上与DOM完全不同。首先，不同于DOM的文档驱动，它是事件驱动的，也就是说，它并不需要读入整个文档，而文档的读入过程也就是SAX的解析过程。所谓事件驱动，是指一种基于回调（callback）机制的程序运行方法。（如果你对Java新的代理事件模型比较清楚的话，就会很容易理解这种机制了）
在XMLReader接受XML文档，在读入XML文档的过程中就进行解析，也就是说读入文档的过程和解析的过程是同时进行的，这和DOM区别很大。解析开始之前，需要向XMLReader注册一个ContentHandler，也就是相当于一个事件监听器，在ContentHandler中定义了很多方法，比如startDocument()，它定制了当在解析过程中，遇到文档开始时应该处理的事情。当XMLReader读到合适的内容，就会抛出相应的事件，并把这个事件的处理权代理给ContentHandler，调用其相应的方法进行响应。
这样泛泛的说来或许有些不容易理解，别急，后面的例子会让你明白SAX的解析过程。看看这个简单XML文件：

1. <POEM>
2. <AUTHOR>Ogden Nash</AUTHOR>
3. <TITLE>Fleas</TITLE>
4. <LINE>Adam</LINE>
5. </POEM> 

当XMLReader读到<POEM>标签时，就会调用ContentHandler.startElement()方法，并把标签名POEM作为参数传递过去。在你实现的startElement()方法中需要做相应的动作，以处理当<POEM>出现时应该做的事情。各个事件随着解析的过程（也就是文档读入的过程）一个个顺序的被抛出，相应的方法也会被顺序的调用，最后，当解析完成，方法都被调用后，对文档的处理也就完成了。下面的这个表，列出了在解析上面的那个XML文件的时候，顺序被调用的方法：
遇到的项目    方法回调
{文档开始}    startDocument()
<POEM>        startElement(null,"POEM",null,{Attributes})
"/n"          characters("<POEM>/n...", 6, 1)
<AUTHOR>      startElement(null,"AUTHOR",null,{Attributes})
"Ogden Nash"  characters("<POEM>/n...", 15, 10)
</AUTHOR>     endElement(null,"AUTHOR",null)
"/n"          characters("<POEM>/n...", 34, 1)
<TITLE>       startElement(null,"TITLE",null,{Attributes})
"Fleas"       characters("<POEM>/n...", 42, 5)
</TITLE>      endElement(null,"TITLE",null)
"/n"          characters("<POEM>/n...", 55, 1)
<LINE>        startElement(null,"LINE",null,{Attributes})
"Adam"        characters("<POEM>/n...", 62, 4)
</LINE>       endElement(null,"LINE",null)
"/n"          characters("<POEM>/n...", 67, 1)
</POEM>       endElement(null,"POEM",null)
{文档结束}    endDocument()
ContentHandler实际上是一个接口，当处理特定的XML文件的时候，就需要为其创建一个实现了ContentHandler的类来处理特定的事件，可以说，这个实际上就是SAX处理XML文件的核心。下面我们来看看定义在其中的一些方法：
void characters(char[] ch, int start, int length)：
这个方法用来处理在XML文件中读到字符串，它的参数是一个字符数组，以及读到的这个字符串在这个数组中的起始位置和长度，我们可以很容易的用String类的一个构造方法来获得这个字符串的String类：String charEncontered=new String(ch,start,length)。
void startDocument()：
当遇到文档的开头的时候，调用这个方法，可以在其中做一些预处理的工作。
void endDocument()：
和上面的方法相对应，当文档结束的时候，调用这个方法，可以在其中做一些善后的工作。
void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, Attributes atts)
当读到一个开始标签的时候，会触发这个方法。在SAX1.0版本中并不支持名域，而在新的2.0版本中提供了对名域的支持，这儿参数中的namespaceURI就是名域，localName是标签名，qName是标签的修饰前缀，当没有使用名域的时候，这两个参数都未null。而atts是这个标签所包含的属性列表。通过atts，可以得到所有的属性名和相应的值。要注意的是SAX中一个重要的特点就是它的流式处理，在遇到一个标签的时候，它并不会纪录下以前所碰到的标签，也就是说，在startElement()方法中，所有你所知道的信息，就是标签的名字和属性，至于标签的嵌套结构，上层标签的名字，是否有子元属等等其它与结构相关的信息，都是不得而知的，都需要你的程序来完成。这使得SAX在编程处理上没有DOM来得那么方便。
void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
这个方法和上面的方法相对应，在遇到结束标签的时候，调用这个方法。
因为ContentHandler是一个接口，在使用的时候可能会有些不方便，因而，SAX中还为其制定了一个Helper类：DefaultHandler，它实现了这个接口，但是其所有的方法体都为空，在实现的时候，你只需要继承这个类，然后重载相应的方法即可。
到这儿SAX的基本知识已经差不多讲完了，下面我们来看看两个具体的例子，以更好的理解SAX地用法。
SAX编程实例

我们还是沿用讲DOM的时候使用的那个文档例子，但首先，我们先看一个简单一些的应用，我们希望能够统计一下XML文件中各个标签出现的次数。这个例子很简单，但是足以阐述SAX编程的基本思路了。
一开始当然还是import语句了：

1. import org.xml.sax.helpers.DefaultHandler;
2. import javax.xml.parsers.*;
3. import org.xml.sax.*;
4. import org.xml.sax.helpers.*;
5. import java.util.*;
6. import java.io.*; 

然后，我们创建一个继承于DefaultHandler的类，具体的程序逻辑在这儿可以暂且放在一边，要注意的是程序的结构：

1. public class SAXCounter extends DefaultHandler {
2. private Hashtable tags; //这个Hashtable用来记录tag出现的次数
3. // 处理文档前的工作
4. public void startDocument() throws SAXException {
5. tags = new Hashtable();//初始化Hashtable
6. }
7. //对每一个开始元属进行处理
8. public void startElement(String namespaceURI, String localName,
9. String rawName, Attributes atts)
10. throws SAXException
11. {
12. String key = localName;
13. Object value = tags.get(key);
14. if (value == null) {
15. // 如果是新碰到的标签，这在Hastable中添加一条记录
16. tags.put(key, new Integer(1));
17. } else {
18. // 如果以前碰到过，得到其计数值，并加1
19. int count = ((Integer)value).intValue();
20. count++;
21. tags.put(key, new Integer(count));
22. }
23. }
24. //解析完成后的统计工作
25. public void endDocument() throws SAXException {
26. Enumeration e = tags.keys();
27. while (e.hasMoreElements()) {
28. String tag = (String)e.nextElement();
29. int count = ((Integer)tags.get(tag)).intValue();
30. System.out.println("Tag <" + tag + "> occurs " + count
31. + " times");
32. }
33. }
34. //程序入口，用来完成解析工作
35. static public void main(String[] args) {
36. String filename = null;
37. boolean validation = false;
38. filename="links.xml";
39. SAXParserFactory spf = SAXParserFactory.newInstance();
40. XMLReader xmlReader = null;
41. SAXParser saxParser=null;
42. try {
43. // 创建一个解析器SAXParser对象
44. saxParser = spf.newSAXParser();
45. // 得到SAXParser中封装的SAX XMLReader
46. xmlReader = saxParser.getXMLReader();
47. } catch (Exception ex) {
48. System.err.println(ex);
49. System.exit(1);
50. }
51. try {
52. //使用指定的ContentHandler，解析给XML文件，这儿要注意的是，为了
53. //程序的简单起见，这儿将主程序和ContentHandler放在了一起。实际上
54. //main方法中所作的所有事情，都与ContentHandler无关。
55. xmlReader.parse(new File(filename),new SAXCounter());
56. } catch (SAXException se) {
57. System.err.println(se.getMessage());
58. System.exit(1);
59. } catch (IOException ioe) {
60. System.err.println(ioe);
61. System.exit(1);
62. }
63. }
64. } 

我们来看看这段程序作了些什么，在main()方法中，主要做的就是创建解析器，然后解析文档。实际上，在这儿创建SAXParser对象的时候，为了使程序代码于具体的解析器无关，使用了同DOM中一样的设计技巧：通过一个SAXParserFactory类来创建具体的SAXParser对象，这样，当需要使用不同的解析器的时候，要改变的，只是一个环境变量的值，而程序的代码可以保持不变。这就是FactoryMethod模式的思想。在这儿不再具体讲了，如果还有不明白的，可以参看上面DOM中的解释，原理是一样的。
不过在这儿还有一点点要注意的地方，就是SAXParser类和XMLReader类之间的关系。你可能有些迷糊了吧，实际上SAXParser是JAXP中对XMLReader的一个封装类，而XMLReader是定义在SAX2.0种的一个用来解析文档的接口。你可以同样的调用SAXParser或者XMLReader中的parser()方法来解析文档，效果是完全一样的。不过在SAXParser中的parser()方法接受更多的参数，可以对不同的XML文档数据源进行解析，因而使用起来要比XMLReader要方便一些。

这个例子仅仅涉及了SAX的一点皮毛，而下面的这个，可就要高级一些了。下面我们要实现的功能，在DOM的例子中已经有实现了，就是从XML文档中读出内容并格式化输出，虽然程序逻辑看起来还是很简单，但是SAX可不比DOM哦，看着吧。

前面说过，当遇到一个开始标签的时候，在startElement()方法中，我们并不能够得到这个标签在XML文档中所处的位置。这在处理XML文档的时候是个大麻烦，因为在XML中标签的语义，有一部分是由其所处的位置所决定的。而且在一些需要验证文档结构的程序中，这更是一个问题。当然，没有解决不了的问题了，我们可以使用一个栈来实现对文档结构的纪录。
栈的特点是先进先出，我们现在的想法是，在startElemnt()方法中用push将这个标签的名字添加到栈中，在endElement()方法中在把它pop出来。我们知道对一个结构良好的XML而言，其嵌套结构是完备的，每一个开始标签总会对应一个结束标签，而且不会出现标签嵌套之间的错位。因而，每一次startElement()方法的调用，必然会对应一个endElement()方法的调用，这样push和pop也是成对出现的，我们只需要分析栈的结构，就可以很容易的知道当前标签所处在文档结构中的位置了。

1. public class SAXReader extends DefaultHandler {
2. java.util.Stack tags=new java.util.Stack();
3. //--------------XML Content-------------
4. String text=null;
5. String url=null;
6. String author=null;
7. String description=null;
8. String day=null;
9. String year=null;
10. String month=null;
11. //----------------------------------------------
12. public void endDocument() throws SAXException {
13. System.out.println("------Parse End--------");
14. }
15. public void startDocument() throws SAXException {
16. System.out.println("------Parse Begin--------");
17. }
18. public void startElement(String p0, String p1, String p2, Attributes p3) throws SAXException {
19. tags.push(p1);
20. }
21. public void endElement(String p0, String p1, String p2) throws SAXException {
22. tags.pop();
23. //一个link节点的信息收集齐了，将其格式化输出
24. if (p1.equals("link")) printout();
25. }
26. public void characters(char[] p0, int p1, int p2) throws SAXException {
27. //从栈中得到当前节点的信息
28. String tag=(String) tags.peek();
29. if (tag.equals("text")) text=new String(p0,p1,p2);
30. else if (tag.equals("url")) url=new String(p0,p1,p2);
31. else if (tag.equals("author")) author=new String(p0,p1,p2);
32. else if (tag.equals("day")) day=new String(p0,p1,p2);
33. else if (tag.equals("month")) month=new String(p0,p1,p2);
34. else if (tag.equals("year")) year=new String(p0,p1,p2);
35. else if (tag.equals("description")) year=new String(p0,p1,p2);
36. }
37. private void printout(){
38. System.out.print("Content: ");
39. System.out.println(text);
40. System.out.print("URL: ");
41. System.out.println(url);
42. System.out.print("Author: ");
43. System.out.println(author);
44. System.out.print("Date: ");
45. System.out.println(day+"-"+month+"-"+year);
46. System.out.print("Description: ");
47. System.out.println(description);
48. System.out.println();
49. }
50. static public void main(String[] args) {
51. String filename = null;
52. boolean validation = false;
53. filename="links.xml";
54. SAXParserFactory spf = SAXParserFactory.newInstance();
55. SAXParser saxParser=null;
56. try {
57. saxParser = spf.newSAXParser();
58. } catch (Exception ex) {
59. System.err.println(ex);
60. System.exit(1);
61. }
62. try {
63. saxParser.parse(new File(filename),new SAXReader());
64. } catch (SAXException se) {
65. System.err.println(se.getMessage());
66. System.exit(1);
67. } catch (IOException ioe) {
68. System.err.println(ioe);
69. System.exit(1);
70. }
71. }
72. } 

 

在这儿虽然没有使用到栈的分析，但实际上栈的分析是一件很容易的事情，应为java.util.Stack继承了java.util.Vector类，而且Stack中的元素是按栈的结构由底至上排列的，因个，我们可以使用Vector类的size()方法来得到Stack的元素个数，还可以使用Vector的get(int)方法来得到具体的每一个元属。实际上，如果把Stack的元素从底向上逐一排列出来，我们就得到了从XML根节点到当前节点的一条唯一的路径，有了这条路径的信息，文档的结构就在清楚不过了。
小节
好了，到这儿为止，我们已经掌握了对于XML编程的两大利器：DOM和SAX，也知道了该如何在一个Java程序中使用它们。DOM编程相对简单，但是速度比较慢，占用内存多，而SAX编程复杂一些，但是速度快，占用内存少。所以，我们应该根据不同的环境选择使用不同的方法。大部分的XML应用基本都可以用它们来解决。需要特别说明的是，DOM和SAX其实都是语言无关的，并非Java所独有，也就是说，只要有相应的语言实现，DOM和SAX可以应用在任何面向对象的语言中。