Friday, April 6, 2007

java与xml联合编程之sax篇

java与xml联合编程之sax篇  
文章出处:www.ccidnet.com 作者:扬帆    发布时间:2004-12-28   点击:0
 

   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文件: 

ogden nash

adam


  当xmlreader读到<poem>标签时,就会调用contenthandler.startelement()方法,并把标签名poem作为参数传递过去。在你实现的startelement()方法中需要做相应的动作,以处理当<poem>出现时应该做的事情。各个事件随着解析的过程(也就是文档读入的过程)一个个顺序的被抛出,相应的方法也会被顺序的调用,最后,当解析完成,方法都被调用后,对文档的处理也就完成了。下面的这个表,列出了在解析上面的那个xml文件的时候,顺序被调用的方法: 

遇到的项目 方法回调 
{文档开始} startdocument() 
<poem> startelement(null,"poem",null,{attributes}) 
"\n" characters("\n...", 6, 1) 
<author>  startelement(null,"author",null,{attributes}) 
"ogden nash"  characters("\n...", 15, 10) 
</author>  endelement(null,"author",null) 
"\n" characters("\n...", 34, 1) 
<title>  startelement(null,"title",null,{attributes}) 
"fleas" characters("\n...", 42, 5) 
</title>  endelement(null,"title",null) 
"\n"  characters("\n...", 55, 1) 
<line>  startelement(null,"line",null,{attributes}) 
"adam"  characters("\n...", 62, 4) 
</line>  endelement(null,"line",null) 
"\n" characters("\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,它实现了这个接口,但是其所有的方法体都为空,在实现的时候,你只需要继承这个类,然后重载相应的方法即可。 

  ok,到这儿sax的基本知识已经差不多讲完了,下面我们来看看两个具体的例子,以更好的理解sax地用法。 

  sax编程实例 

  我们还是沿用讲dom的时候使用的那个文档例子,但首先,我们先看一个简单一些的应用,我们希望能够统计一下xml文件中各个标签出现的次数。这个例子很简单,但是足以阐述sax编程的基本思路了。 

  一开始当然还是import语句了: 

import org.xml.sax.helpers.defaulthandler;
import javax.xml.parsers.*;
import org.xml.sax.*;
import org.xml.sax.helpers.*;
import java.util.*;
import java.io.*; 


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

public class saxcounter extends defaulthandler {
private hashtable tags; //这个hashtable用来记录tag出现的次数
// 处理文档前的工作
public void startdocument() throws saxexception {
tags = new hashtable();//初始化hashtable
}
//对每一个开始元属进行处理
public void startelement(string namespaceuri, string localname,
string rawname, attributes atts)
throws saxexception
{
string key = localname;
object value = tags.get(key);
if (value == null) {
// 如果是新碰到的标签,这在hastable中添加一条记录
tags.put(key, new integer(1));
} else {
// 如果以前碰到过,得到其计数值,并加1
int count = ((integer)value).intvalue();

count++;
tags.put(key, new integer(count));
}
}
//解析完成后的统计工作
public void enddocument() throws saxexception {
enumeration e = tags.keys();
while (e.hasmoreelements()) {
string tag = (string)e.nextelement();
int count = ((integer)tags.get(tag)).intvalue();
system.out.println("tag <" + tag + "> occurs " + count
+ " times");
}
}
//程序入口,用来完成解析工作
static public void main(string[] args) {
string filename = null;
boolean validation = false;

filename="links.xml";
saxparserfactory spf = saxparserfactory.newinstance();
xmlreader xmlreader = null;
saxparser saxparser=null;
try {
// 创建一个解析器saxparser对象
saxparser = spf.newsaxparser();
// 得到saxparser中封装的sax xmlreader
xmlreader = saxparser.getxmlreader();
} catch (exception ex) {
system.err.println(ex);
system.exit(1);
}
try {
//使用指定的contenthandler,解析给xml文件,这儿要注意的是,为了
//程序的简单起见,这儿将主程序和contenthandler放在了一起。实际上
//main方法中所作的所有事情,都与contenthandler无关。
xmlreader.parse(new file(filename),new saxcounter());
} catch (saxexception se) {

system.err.println(se.getmessage());
system.exit(1);
} catch (ioexception ioe) {
system.err.println(ioe);
system.exit(1);
}
}


  我们来看看这段程序作了些什么,在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也是成对出现的,我们只需要分析栈的结构,就可以很容易的知道当前标签所处在文档结构中的位置了。 

public class saxreader extends defaulthandler {
java.util.stack tags=new java.util.stack();
//--------------xml content-------------
string text=null;
string url=null;
string author=null;
string description=null;
string day=null;
string year=null;
string month=null;
//----------------------------------------------
public void enddocument() throws saxexception {
system.out.println("------parse end--------");
}
public void startdocument() throws saxexception {
system.out.println("------parse begin--------");
}
public void startelement(string p0, string p1, string p2, attributes p3) throws saxexception {
tags.push(p1);
}
public void endelement(string p0, string p1, string p2) throws saxexception {
tags.pop();
//一个link节点的信息收集齐了,将其格式化输出
if (p1.equals("link")) printout();
}
public void characters(char[] p0, int p1, int p2) throws saxexception {
//从栈中得到当前节点的信息
string tag=(string) tags.peek();
if (tag.equals("text")) text=new string(p0,p1,p2);
else if (tag.equals("url")) url=new string(p0,p1,p2);
else if (tag.equals("author")) author=new string(p0,p1,p2);
else if (tag.equals("day")) day=new string(p0,p1,p2);
else if (tag.equals("month")) month=new string(p0,p1,p2);
else if (tag.equals("year")) year=new string(p0,p1,p2);
else if (tag.equals("description")) year=new string(p0,p1,p2);
}
private void printout(){
system.out.print("content: ");
system.out.println(text);
system.out.print("url: ");
system.out.println(url);
system.out.print("author: ");
system.out.println(author);
system.out.print("date: ");
system.out.println(day+"-"+month+"-"+year);
system.out.print("description: ");
system.out.println(description);
system.out.println();
}
static public void main(string[] args) {
string filename = null;
boolean validation = false;
filename="links.xml";
saxparserfactory spf = saxparserfactory.newinstance();
saxparser saxparser=null;
try {
saxparser = spf.newsaxparser();
} catch (exception ex) {
system.err.println(ex);
system.exit(1);
}
try {
saxparser.parse(new file(filename),new saxreader());
} catch (saxexception se) {
system.err.println(se.getmessage());
system.exit(1);
} catch (ioexception ioe) {
system.err.println(ioe);
system.exit(1);
}
}

     在这儿虽然没有使用到栈的分析,但实际上栈的分析是一件很容易的事情,应为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可以应用在任何面向对象的语言中。 

    上面我们介绍了xml文档的读入,内容提取,以及文档添加和修改的一些方法。还有一类的问题就是xml文档的转换,虽然用dom和sax也可以解决,但是实现起来很复杂,而应用xslt就会简单许多。这个问题,笔者将会在以后的文章中再和大家详细讨论。 

No comments: