可扩展标注语言(EXTENSIBLE MARKUP LANGUAGE,XML)正被迅速的运用于业界,它已作为与平台、语言和协议无关的格式描述和交换数据的广泛应用标准。XML和它的辅助规范可用于描述数据的文档表现,描述XML文档类型的限制,描述XML文档和资源之间的链接,描述XML文档的自动转换和格式化。
如何开发自定义标签库?
我使用JSP和ASP编程已经有一段颇长的时间了,在两种服务器端的编程方式中,我越来越觉得JSP的功能要强大得多。不提别的,其中JSP的标签库就是我选择JSP作为首选服务器端WEB应用开发工具的原因。为什么?因为:维护和开发的速度。在一个单一的服务器页面中,你可以混合使用各种不同的脚本方法和对象。就QUOT;混凝土"一样,这种混合可令服务器端的脚本变得强大,并且让服务器端的编程者设计出非常灵活和动态的WEB页面。不过这种自由的混合也有其缺点,那就是维护起来非常麻烦,特别是当项目逐渐变大时。由于最终的产品是经由一个传统的WEB设计者来维护的,因此会带来问题。更糟糕的是,随着代码的复杂性增加,开发的速度就会变慢,不利于开发中等和大型的WEB应用,一旦开发完,站点还要找合格的编程者来维护这些颇为复杂的代码。 幸好,JSP提供了一个很好解决的办法。标签库提供了一个简单的方法来建立一个可重用的代码块。一旦标签库设计好,它就可以在许多项目中再次使用。更方便的是,与COM和J2EE不同,你无需学习任何其它的技巧就可以建立一个标签库!只要你懂得写JSP,你就可以建立一个标签库。标签库还可以改善WEB应用的维护。这个是得益于JSP页面自定义标签的简单XML接口。这样,WEB设计者甚至可以做到无需知道任何JSP的知识,就可以建立JSP的WEB应用。这个开放式的WEB开发对于团队运作是非常有效的。JSP编程者可以建立自定义的标签和后台的代码模块,而WEB设计者可以使用自定义的标签来建立WEB应用,并且将精力集中在WEB设计上。
1. 标签库的定义 JSP标签库(也称自定义库)可看成是一套产生基于XML脚本的方法,它经由JAVABEANS来支持。在概念上说,标签库是非常简单和可以重用的代码构造。 执行XML/XSL转换的标签范例和HTML页面
<%@ TAGLIB URI="HTTP://WWW.JSPINSIDER.COM/JSPKIT/JAXP" PREFIX="JAXP"%> C:/XML/EXAMPLE.XML C:/XML/EXAMPLE.XSL
在这个例子中,通过使用简单的标签来访问后台更为强大的代码,一个XML被装载,并且通过一个XSL文件来产生一个结果,并发送给客户端,全部通过使用一个简单的标签调用就做到了。 自定义标签为在JSP项目中创建易于重用的代码打开了一扇大门。你所需要的只是标签库和它的文档说明。
2. 标签的组件 虽然标签库非常易于使用,不过要建立一个内里的设计来支持标签库是颇复杂的,起码要比建立一个简单的JAVABEAN复杂。这个复杂是来自于标签库是由几部分构成的。不过,你只需要知道JAVA和JSP的知识就够了。 一个简单的标签由下面的元素构成: ⑴ JAVABEANS:为了得到JAVA与生具来的面向对象的好处,可重用的代码应该放到一个独立的代码容器中。这些JAVABEANS并不是标签库的一部分。不过它是你的代码库用来执行相关任务的基本代码块。 ⑵ 标签处理:这是标签库的真正核心。一个标签处理器将引用它需要的任何资源(你的JAVABEANS)和访问你的JSP页面的全部信息(PAGECONTEXT对象)。JSP页面也会将所有已经被设置的标签属性和JSP页面上的标签体中的内容传送给标签处理器。在标签处理器处理完毕后,它将发回输出到你的JSP页面进行处理。 ⑶ 标签库的描述(TLD文件):这是一个简单的XML文件,它记录着标签处理器的属性、信息和位置。JSP容器通过这个文件来得知从哪里及如何调用一个标签库。 ⑷ 网站的WEB.XML文件:这是你网站的初始化文件,在这个文件中,你定义了网站中用到的自定义标签,以及哪个TLD文件用来描述每个自定义的标签。 ⑸ 分发文件(一个WAR或者JAR文件):如果你想重用自定义标签的话,你需要一个方法来将它由一个项目转移到另一个项目中。将标签库打包为一个JAR文件是一个简单而且有效的方式。 ⑹ 在你的JSP文件中作标签库声明:很简单,如果要用到该标签的话,只要在页面声明一下就可以,其后,你就可以在该JSP页面的任何地方使用它。 看来要做的工作很多,不过其实并不是很难。它的要点并不在于编码,而是在于如何将各部分正确地组织起来。不过,这样的分层是很重要的,它可令标签的使用灵活和更容易转移。更重要的是,这些层的存在可让处理建立标签的工程通过一个JSP IDE(JSP的集成开发环境)自动完成。期望将来的JSP IDE可自动完成创建一个自定义标签的大部分工作,这样你只需要写代码和标签处理就可以了。 注意:一个标签处理仅定义一个自定义标签;一个标签库是几个处理相同任务的标签处理器的集合。
3. 建立自己的标签 以下将一步一步地教你如何建立自定义的标签,具体的例子是扩展JSP,令它拥有自己的HTML编码功能。这个功能将所有的<和>字符用HTML代码来代替。它可以很容易地扩展为做其它的编码处理。为了简化,这个例子只解释了建立自定义标签的基本要素。 ⑴ 创建一个JAVABEAN 你代码中任何可重新使用的部分都应该放到一个JAVABEAN中。这个很重要,因为你要经常在项目的其它地方用到这些代码。放在标签处理器中的任何代码在标签外都是不可以重新使用的,因此将可重用的代码部分独立开来是很重要的。在这个例子总,为HTML编码的逻辑是常用的,因此放到JAVABEAN中。 ⑵ HTML编码JAVABEAN
/* HTML_FORMAT.JAVA */ PUBLIC CLASS HTML_FORMAT EXTENDS OBJECT IMPLEMENTS JAVA.IO.SERIALIZABLE { /** 创建新的HTML_FORMAT */ PUBLIC HTML_FORMAT() {} /** 将一个字符串中所有的所有 < 和 > 字符用响应的HTML编码代替 */ PUBLIC STRING HTML_ENCODE(STRING AS_DATA) { INT LI_LEN = AS_DATA.LENGTH(); /*STRING BUFFER的长度要比原来的字符串长*/ STRINGBUFFER LSB_ENCODE = NEW STRINGBUFFER(LI_LEN + (LI_LEN/10)); /* 循环替换全部的< 和 > 字符 */ FOR( INT LI_COUNT = 0 ; LI_COUNT < LI_LEN ; LI_COUNT++) { STRING LS_NEXT = STRING.VALUEOF(AS_DATA.CHARAT(LI_COUNT)); IF (LS_NEXT.EQUALS("<")) LS_NEXT = "<"; IF (LS_NEXT.EQUALS(">")) LS_NEXT = ">"; LSB_ENCODE.APPEND( LS_NEXT ); } RETURN( LSB_ENCODE.TOSTRING() ); } }
⑶ 创建一个标签处理器 标签处理器使用以下的代码:
HTML编码标签处理器 IMPORT JAVA.IO.IOEXCEPTION; IMPORT JAVAX.SERVLET.JSP.*; IMPORT JAVAX.SERVLET.JSP.TAGEXT.*; PUBLIC CLASS HTML_FORMATTAG EXTENDS BODYTAGSUPPORT { /* 1} 在标签末将会调用这个函数 */ PUBLIC INT DOENDTAG() THROWS JSPTAGEXCEPTION { TRY { /* 2}得到标签中的文本 */ BODYCONTENT L_TAGBODY = GETBODYCONTENT(); STRING LS_OUTPUT = ""; /* 3}如果标签体有文本,就处理它 */ IF(L_TAGBODY != NULL) { HTML_FORMAT L_FORMAT = NEW HTML_FORMAT(); /* 3A} 将标签体的内容转换为一个字符串 */ STRING LS_HTML_TEXT = L_TAGBODY.GETSTRING(); LS_OUTPUT = L_FORMAT.HTML_ENCODE(LS_HTML_TEXT); } /* 4}将结果写回到数据流中 */ PAGECONTEXT.GETOUT().WRITE(LS_OUTPUT.TRIM()); } CATCH (IOEXCEPTION E) { THROW NEW JSPTAGEXCEPTION("TAG ERROR:" + E.TOSTRING()); } /* 让JSP继续处理以下页面的内容 */ RETURN EVAL_PAGE; } }
这个处理很简单,它包括有: O 读入标签开始和结束间的文本 O 调用HTML编码函数 O 返回结果到JSP页面。 ⑷ 创建一个标签描述器 需要描述自定义标签以让系统知道如何处理。该描述文件的后缀为.TLD,通常它的名字和标签处理器相同,并存放在"/WEB-INF/"目录。
HTML编码标签描述器 <XML VERSION="1.0" ENCODING="UTF-8" > <!DOCTYPE TAGLIB PUBLIC "-//SUN MICROSYSTEMS, INC.//DTD JSP TAG LIBRARY 1.1//EN" "HTTP://JAVA.SUN.COM/J2EE/DTDS/WEB-JSPTAGLIBRARY_1_1.DTD"> <TAGLIB> <TLIBVERSION>1.0</TLIBVERSION> <JSPVERSION>1.1</JSPVERSION> <SHORTNAME>HTML_FORMATTAG</SHORTNAME> <URI></URI> <INFO>HTML ENCODING TAG </INFO> <TAG> <NAME>HTMLENCODE</NAME> <TAGCLASS>HTML_FORMATTAG</TAGCLASS> <INFO>ENCODE HTML</INFO> </TAG> </TAGLIB>
⑸ 更新WEB XML文件 现在可告诉JSP容器使用标签库。为此要修改WEB.XML文件,具体说来是要在其中加入一个TAGLIB的项目来注册该标签库。最重要的是,要为TAG分配一个URI。URI是一个唯一的引用,只应用在该网站的这个特别的标签上。使用全长的URL或者包名是一个好的习惯,它可以确保唯一性,因为该标签可以在不同的网站使用。这个例子是简化了。
修改WEB.XML文件 <XML VERSION="1.0" ENCODING="ISO-8859-1">
<!DOCTYPE WEB-APP PUBLIC "-//SUN MICROSYSTEMS, INC.//DTD WEB APPLICATION 2.2//EN" "HTTP://JAVA.SUN.COM/J2EE/DTDS/WEB-APP_2.2.DTD"> <WEB-APP> <TAGLIB> <TAGLIB-URI> HTMLENCODE </TAGLIB-URI> <TAGLIB-LOCATION> /WEB-INF/HTML_FORMATTAG.TLD </TAGLIB-LOCATION> </TAGLIB> </WEB-APP>
⑹ 使用新的标签 自定义的标签已经设置好,可以用在一个JSP页面上。要做到这一点,只需在该页面使用TAGLIB指示命令声明一下该标签就可以了,该标签通过它唯一的URI被引用,并且会被分配一个名字空间前缀。前缀可以任意,只要它不与其它的名字空间冲突便可。 在一个JSP页面上使用HTML编码标签:
<%@ TAGLIB URI="HTMLENCODE" PREFIX="EXAMPLES" %> <PRE> <XML:NAMESPACE PREFIX = EXAMPLES /><EXAMPLES:HTMLENCODE> < HELLO , SIMPLE SAMPLE > </EXAMPLES:HTMLENCODE> </PRE> 范例代码的输出 < HELLO , SIMPLE SAMPLE > WHICH DISPLAYS AS: < HELLO , SIMPLE SAMPLE >
通过这个标签,我就将该页面的所有代码编码了。有趣的是所有的自定义标签都是在服务器上处理的。这意味着你将不会在输出的页面上看到自定义的标签。 建立一个标签不是很难吧。最困难的部分是要学习标签处理的所有细节。这是一个很强大的功能,我们只是提到了最基本的地方。由于这个处理需要几步,新的JSP编程者在创建标签时将会感到迷惑。
如何利用JSP开发DOM应用?
DOM是DOCUMENT OBJECT MODEL的缩写,即文档对象模型。XML将数据组织为一颗树,所以DOM就是对这颗树的一个对象描叙。通俗的说,就是通过解析XML文档,为XML文档在逻辑上建立一个树模型,树的节点是一个个对象。我们通过存取这些对象就能够存取XML文档的内容。 下面我们来看一个简单的例子,看看在DOM中,我们是如何来操作一个XML文档的。这是一个XML文档,也是我们要操作的对象:
<XML VERSION="1.0" ENCODING="UTF-8"> <MESSAGES> <MESSAGE>GOOD-BYE SERIALIZATION, HELLO JAVA!</MESSAGE> </MESSAGES>
下面,我们需要把这个文档的内容解析到一个个的JAVA对象中去供程序使用,利用JAXP,我们只需几行代码就能做到这一点。首先,我们需要建立一个解析器工厂,以利用这个工厂来获得一个具体的解析器对象: DOCUMENTBUILDERFACTORY DBF = DOCUMENTBUILDERFACTORY.NEWINSTANCE(); 我们在这里使用DOCUMENTBUILDERFACOTRY的目的是为了创建与具体解析器无关的程序,当DOCUMENTBUILDERFACTORY类的静态方法NEWINSTANCE()被调用时,它根据一个系统变量来决定具体使用哪一个解析器。又因为所有的解析器都服从于JAXP所定义的接口,所以无论具体使用哪一个解析器,代码都是一样的。所以当在不同的解析器之间进行切换时,只需要更改系统变量的值,而不用更改任何代码。这就是工厂所带来的好处。 DOCUMENTBUILDER DB = DBF.NEWDOCUMENTBUILDER(); 当获得一个工厂对象后,使用它的静态方法NEWDOCUMENTBUILDER()方法可以获得一个DOCUMENTBUILDER对象,这个对象代表了具体的DOM解析器。但具体是哪一种解析器,微软的或者IBM的,对于程序而言并不重要。 然后,我们就可以利用这个解析器来对XML文档进行解析了: DOCUMENT DOC = DB.PARSE("C:/XML/MESSAGE.XML"); DOCUMENTBUILDER的PARSE()方法接受一个XML文档名作为输入参数,返回一个DOCUMENT对象,这个DOCUMENT对象就代表了一个XML文档的树模型。以后所有的对XML文档的操作,都与解析器无关,直接在这个DOCUMENT对象上进行操作就可以了。而具体对DOCUMENT操作的方法,就是由DOM所定义的了。 从得到的DOCUMENT对象开始,我们就可以开始我们的DOM之旅了。使用DOCUMENT对象的GETELEMENTSBYTAGNAME()方法,我们可以得到一个NODELIST对象,一个NODE对象代表了一个XML文档中的一个标签元素,而NODELIST对象,观其名而知其意,所代表的是一个NODE对象的列表: NODELIST NL = DOC.GETELEMENTSBYTAGNAME("MESSAGE"); 我们通过这样一条语句所得到的是XML文档中所有<MESSAGE>标签对应的NODE对象的 一个列表。然后,我们可以使用NODELIST对象的ITEM()方法来得到列表中的每一个NODE对象: NODE MY_NODE = NL.ITEM(0); 当一个NODE对象被建立之后,保存在XML文档中的数据就被提取出来并封装在这个NODE中了。在这个例子中,要提取MESSAGE标签内的内容,我们通常会使用NODE对象的GETNODEVALUE()方法: STRING MESSAGE = MY_NODE.GETFIRSTCHILD().GETNODEVALUE(); 请注意,这里还使用了一个GETFIRSTCHILD()方法来获得MESSAGE下面的第一个子NODE对象。虽然在MESSAGE标签下面除了文本外并没有其它子标签或者属性,但是我们坚持在这里使用GETFIRSECHILD()方法,这主要和W3C对DOM的定义有关。W3C把标签内的文本部分也定义成一个NODE,所以先要得到代表文本的那个NODE,我们才能够使用GETNODEVALUE()来获取文本的内容。现在,既然我们已经能够从XML文件中提取出数据了,我们就可以把这些数据用在合适的地方,来构筑应用程序。
DOM实例
先说说这个例子到底要做的是什么吧,我们在一个名为LINK.XML文件中保存了一些URL地址,我们希望可以通过DOM把这些URL读出并显示出来,也可以反过来向这个XML文件中写入加入的URL地址。很简单,却很实用,也足够来例示DOM的绝大部分用法了。 第一个程序我们称为XMLDISPLAY.JAVA,主要的功能就是读取这个XML文件中各个节点的内容,然后在格式化输出在SYSTEM.OUT上,我们来看看这个程序:
IMPORT JAVAX.XML.PARSERS.*; IMPORT ORG.W3C.DOM.*;
这是引入必要的类,因为在这里使用的是SUN所提供的XML解析器,因而需要引入JAVA.XML.PARSERS包,其中包含了有DOM解析器和SAX解析器的具体实现。ORG.W3C.DOM包中定义了W3C所制定的DOM接口。
DOCUMENTBUILDERFACTORY FACTORY = DOCUMENTBUILDERFACTORY.NEWINSTANCE(); DOCUMENTBUILDER BUILDER=FACTORY.NEWDOCUMENTBUILDER(); DOCUMENT DOC=BUILDER.PARSE("LINKS.XML"); DOC.NORMALIZE();
除了上面讲到的,还有一个小技巧,对DOCUMENT对象调用NORMALIZE(),可以去掉XML文档中作为格式化内容的空白而映射在DOM树中的不必要的TEXT NODE对象。否则你得到的DOM树可能并不如你所想象的那样。特别是在输出的时候,这个NORMALIZE()更为有用。
NODELIST LINKS =DOC.GETELEMENTSBYTAGNAME("LINK");
刚才说过,XML文档中的空白符也会被作为对象映射在DOM树中。因而,直接调用NODE方法的GETCHILDNODES方法有时候会有些问题,有时不能够返回所期望的NODELIST对象。解决的办法是使用ELEMENT的GETELEMENTBYTAGNAME(STRING),返回的NODELISE就是所期待的对象了。然后,可以用ITEM()方法提取想要的元素。
FOR (INT I=0;I<LINKS.GETLENGTH();I++){ ELEMENT LINK=(ELEMENT) LINKS.ITEM(I); SYSTEM.OUT.PRINT("CONTENT: "); SYSTEM.OUT.PRINTLN(LINK.GETELEMENTSBYTAGNAME("TEXT").ITEM(0).GETFIRSTCHILD(); .GETNODEVALUE()); ……
上面的代码片断就完成了对XML文档内容的格式化输出。只要注意到一些细节的问题,比如GETFIRSTCHILE()方法和GETELEMENTSBYTAGNAME()方法的使用,这些还是比较容易的。 下面的内容,就是在修改了DOM树后重新写入到XML文档中去的问题了。这个程序名为XMLWRITE.JAVA。在JAXP1.0版本中,并没有直接的类和方法能够处理XML文档的写入问题,需要借助其它包中的一些辅助类。而在JAXP1.1版本中,引入了对XSLT的支持,所谓XSLT,就是对XML文档进行变换(TRANSLATION)后,得到一个新的文档结构。利用这个新加入的功能,我们就能够很方便的把新生成或者修改后的DOM树从新写回到XML文件中去了,下面我们来看看代码的实现,这段代码的主要功能是向LINKS.XML文件中加入一个新的LINK节点:
IMPORT JAVAX.XML.PARSERS.*; IMPORT JAVAX.XML.TRANSFORM.*; IMPORT JAVAX.XML.TRANSFORM.DOM.DOMSOURCE; IMPORT JAVAX.XML.TRANSFORM.STREAM.STREAMRESULT; IMPORT ORG.W3C.DOM.*;
新引入的JAVA.XML.TRANSFORM包中的几个类,就是用来处理XSLT变换的。 我们希望在上面的XML文件中加入一个新的LINK节点,因而首先还是要读入LINKS.XML文件,构建一个DOM树,然后再对这个DOM树进行修改(添加节点),最后把修改后的DOM写回到LINKS.XML文件中:
DOCUMENTBUILDERFACTORY FACTORY = DOCUMENTBUILDERFACTORY.NEWINSTANCE(); DOCUMENTBUILDER BUILDER=FACTORY.NEWDOCUMENTBUILDER(); DOCUMENT DOC=BUILDER.PARSE("LINKS.XML"); DOC.NORMALIZE(); //---取得变量---- STRING TEXT="HANZHONG’S HOMEPAGE"; STRING URL="WWW.HZLIU.COM"; STRING AUTHOR="HZLIU LIU"; STRING DISCRIPTION="A SITE FROM HANZHONG LIU, GIVE U LOTS OF SUPRISE!!!";
为了看清重点,简化程序,我们把要加入的内容硬编码到记忆STRING对象中,而实际操作中,往往利用一个界面来提取用户输入,或者通过JDBC从数据库中提取想要的内容。
TEXT TEXTSEG; ELEMENT LINK=DOC.CREATEELEMENT("LINK");
首先应该明了的是,无论什么类型的NODE,TEXT型的也好,ATTR型的也好,ELEMENT型的也好,它们的创建都是通过DOCUMENT对象中的CREATEXXX()方法来创建的(XXX代表具体要创建的类型),因此,我们要向XML文档中添加一个LINK项目,首先要创建一个LINK对象:
ELEMENT LINKTEXT=DOC.CREATEELEMENT("TEXT"); TEXTSEG=DOC.CREATETEXTNODE(TEXT); LINKTEXT.APPENDCHILD(TEXTSEG); LINK.APPENDCHILD(LINKTEXT); ……
创建节点的过程可能有些千篇一律,但需要注意的地方是,对ELEMENT中所包含的TEXT(在DOM中,这些TEXT也是代表了一个NODE的,因此也必须为它们创建相应的NODE),不能直接用ELEMENT对象的SETNODEVALUE()方法来设置这些TEXT的内容,而需要用创建的TEXT对象的SETNODEVALUE()方法来设置文本,这样才能够把创建的ELEMENT和其文本内容添加到DOM树中。看看前面的代码,你会更好的理解这一点: DOC.GETDOCUMENTELEMENT().APPENDCHILD(LINK); 最后,不要忘记把创建好的节点添加到DOM树中。DOCUMENT类的GETDOCUMENTELEMENT()方法,返回代表文档根节点的ELEMENT对象。在XML文档中,根节点一定是唯一的。
TRANSFORMERFACTORY TFACTORY =TRANSFORMERFACTORY.NEWINSTANCE(); TRANSFORMER TRANSFORMER = TFACTORY.NEWTRANSFORMER(); DOMSOURCE SOURCE = NEW DOMSOURCE(DOC); STREAMRESULT RESULT = NEW STREAMRESULT(NEW JAVA.IO.FILE("LINKS.XML")); TRANSFORMER.TRANSFORM(SOURCE, RESULT);
然后就是用XSLT把DOM树输出了。这里的TRANSFORMERFACTORY也同样应用了工厂模式,使得具体的代码同具体的变换器无关。实现的方法和DOCUMENTBUILDERFACTORY相同,这儿就不赘述了。TRANSFORMER类的TRANSFROM方法接受两个参数、一个数据源SOURCE和一个输出目标RESULT。这里分别使用的是DOMSOURCE和STREAMRESULT,这样就能够把DOM的内容输出到一个输出流中,当这个输出流是一个文件的时候,DOM的内容就被写入到文件中去了。
如何利用JSP开发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文件:
<POEM> <AUTHOR>OGDEN NASH</AUTHOR> <TITLE>FLEAS</TITLE> <LINE>ADAM</LINE> </POEM>
当XMLREADER读到<POEM>标签时,就会调用CONTENTHANDLER.STARTELEMENT()方法,并把标签名POEM作为参数传递过去。在你实现的STARTELEMENT()方法中需要做相应的动作,以处理当<POEM>出现时应该做的事情。各个事件随着解析的过程(也就是文档读入的过程)一个个顺序的被抛出,相应的方法也会被顺序的调用,最后,当解析完成,方法都被调用后,对文档的处理也就完成了。下面的这个表,列出了在解析上面的那个XML文件的时候,顺序被调用的方法:
遇到的项目 方法回调
{文档开始} STARTDOCUMENT() <POEM> STARTELEMENT(NULL,"POEM",NULL,{ATTRIBUTES}) " " CHARACTERS("<POEM> ...", 6, 1) <AUTHOR> STARTELEMENT(NULL,"AUTHOR",NULL,{ATTRIBUTES}) "OGDEN NASH" CHARACTERS("<POEM> ...", 15, 10) </AUTHOR> ENDELEMENT(NULL,"AUTHOR",NULL) " " CHARACTERS("<POEM> ...", 34, 1) <TITLE> STARTELEMENT(NULL,"TITLE",NULL,{ATTRIBUTES}) "FLEAS" CHARACTERS("<POEM> ...", 42, 5) </TITLE> ENDELEMENT(NULL,"TITLE",NULL) " " CHARACTERS("<POEM> ...", 55, 1) <LINE> STARTELEMENT(NULL,"LINE",NULL,{ATTRIBUTES}) "ADAM" CHARACTERS("<POEM> ...", 62, 4) </LINE> ENDELEMENT(NULL,"LINE",NULL) " " CHARACTERS("<POEM> ...", 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(STRING NAMESPACEURI, STRING LOCALNAME, STRING QNAME, ATTRIBUTES ATTS):当读到一个开始标签的时候,会触发这个方法。在SAX1.0版本中并不支持名域,而在新的2.0版本中提供了对名域的支持,这儿参数中的NAMESPACEURI就是名域,LOCALNAME是标签名,QNAME是标签的修饰前缀,当没有使用名域的时候,这两个参数都未NULL。而ATTS是这个标签所包含的属性列表。通过ATTS,可以得到所有的属性名和相应的值。要注意的是SAX中一个重要的特点就是它的流式处理,在遇到一个标签的时候,它并不会纪录下以前所碰到的标签,也就是说,在STARTELEMENT()方法中,所有你所知道的信息,就是标签的名字和属性,至于标签的嵌套结构,上层标签的名字,是否有子元属等等其它与结构相关的信息,都是不得而知的,都需要你的程序来完成。这使得SAX在编程处理上没有DOM来得那么方便。 VOID ENDELEMENT(STRING NAMESPACEURI, STRING LOCALNAME, STRING QNAME):这个方法和上面的方法相对应,在遇到结束标签的时候,调用这个方法。 我们还是沿用讲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; ……
我们来看看这段程序作了些什么。在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=NEWJAVA.UTIL.STACK(); ……
在这儿虽然没有使用到栈的分析,但实际上栈的分析是一件很容易的事情,应为JAVA.UTIL.STACK继承了JAVA.UTIL.VECTOR类,而且STACK中的元素是按栈的结构由底至上排列的,因个,我们可以使用VECTOR类的SIZE()方法来得到STACK的元素个数,还可以使用VECTOR的GET(INT)方法来得到具体的每一个元属。实际上,如果把STACK的元素从底向上逐一排列出来,我们就得到了从XML根节点到当前节点的一条唯一的路径,有了这条路径的信息,文档的结构就在清楚不过了。 到目前为止,我们已经掌握了对于XML编程的两大利器:DOM和SAX,也知道了该如何在一个JAVA程序中使用它们。DOM编程相对简单,但是速度比较慢,占用内存多,而S AX编程复杂一些,但是速度快,占用内存少。所以,我们应该根据不同的环境选择使用不同的方法。大部分的XML应用基本都可以用它们来解决。需要特别说明的是,DOM和SAX其实都是语言无关的,并非JAVA所独有,也就是说,只要有相应的语言实现,DOM和SAX可以应用在任何面向对象的语言中。
|