用XmlBeans处理XML文档

ZDNet软件频道 时间:2005-12-15 作者:DJ Walker-Morgan |  我要评论()
本文关键词:xml XML Java
使用XmlBeans可以很容易在Java中读取和操作XML文档。下面将为你演示这一过程。

    XML具有可读性,但这种代码编写时实在枯燥无味。对于那些懒惰且追求效率的程序员来说,编写这种沉闷乏味的代码最头疼。然而由于XMLBeans和E4X的出现,这些问题被迎韧而解。

    现在的XMLBeans为2.0版本。XMLBeans由 BEA公司发明,后捐赠给Apache公司。当前世界都是XML/Java捆绑工具,而XMLBeans与众不同的是,它可用于很多与XML相关编程的领域,包括从低级节点,到非数据元素,到提取数据导向操作等方面。

    使用XMLBeans可从一个XML Schema开始。下面我们将以一个简单程序作为范例,本文其它的例子可从这里下载

    我们的示范schema指定一个包括“sites”元素,这一“sites”元素又包含很多个“sites”元素,而这些元素又依次包含很多个“rating”或“comment”元素,每个元素都将一个邮件地址作为识别作者级别和注解的属性。

    可以从Apache Web网站上获得XMLBeans并安装它。请记住将环境变量XMLBEANS_HOME设置为你安装的路径,并将$XMLBEANS_HOME/bin路径添加到安装目录。这可保证XMLBeans命令正确运行,即编译器“Scomp”能够正常工作。

如果我们现在运行:

scomp -out sites.jar sites.xsd

 将可看到:

Time to build schema type system: 1.185 seconds Time to generate code: 0.131 seconds Time to compile code: 1.179 seconds Compiled types to: sites.ja

    Scomp已经建立一个用于生成和编译Java代码的系统。在默认下,我们只能得到一个sites.jar文件作为输出。Scomp只能生成预编译的jar文件。如果你想看到生成的源代码,可运行:

scomp -srconly -src srcdir sites.xsd

    现在我们可以看到,生成的Java classes 全部在com.example.sites.site程序包中,这些类来源于schema的目标名称空间。在Schema文件的开头行指定:

<?XML version="1.0" encoding="utf-8"?>
<?xsd:schema XMLns:xsd="http://www.w3.org/2001/XMLSchema"
    XMLns:si="http://www.example.com/sites/SITE"

    targetNamespace="http://www.example.com/sites/SITE"
    elementFormDefault="qualified">

    如果你的schema没有一个目标名称空间,生成的类将出现在一个名为noNamespace的程序包中。比如一个名为SitesDocument的类,类的每一个属性都定义在schema,Sites,Site,Comment,Rating以及Email中。所有生成的类都会继承XMLBeans的基本类(即XMLObject)。现在我们可以直接剖析一个XML文档:

import com.example.sites.site.*;
import Java.io.*;
import org.apache.XMLbeans.*;
public class Example1 {
    public static void main(String[] args) {
      try {
        SitesDocument sd=SitesDocument.Factory.parse(new
          File("./sites.XML"));
        /* ......... */
      }
      catch (IOException e) {
        System.err.println("IOException:"+e);
      }
      catch (XMLException e) {
        System.err.println("XMLException:"+e);
      }
    }
}

    在剖析过程出现错误将会产生一个XMLException。如果异常产生,我们已经做好相应处理。所有生成类都由一个静态Factory通过剖析或程序方式建立一些实例(instance)。这里我们使用的是简单的剖析方式。

    我们添加一些代码以重复操作整个site并打印出注解和级别。首先必须得到文档的根元素(root element):

Sites sites=sd.getSites

    XMLBeans以数组形式表示XML Schemas的顺序,我们可以获得这一数组并重复调用它(请记住我们使用的是Java SE 5.0):

for(Site s:sites.getSiteArray()) 

    每一元素和属性都包含一些方法,你可以对它们赋值。现在我们提取site的src属性并打印它:

System.out.println(s.getSrc());

    同样的道理,我们在Site元素中获得Rating和Comment数组,并重复调用:

for(Rating r:s.getRatingArray()) {
  System.out.println(r.getEmail() + " rated the site "
    + r.getRated() + " on " + r.getRatedon());
}
for(Comment c:s.getCommentArray()) {
  System.out.println(c.getEmail() + " said "
    + c.getStringValue());
  }
}
 

    接下来,我们就可以操作XML。我们添加一个site到文档:

Site newsite=sites.addNewSite(); 

    同样,XMLbeans scomp已经生成了一些方法以允许你建立Site实例。现在我们必须做的就是设置“src”属性:

newsite.setSrc("http://www.example.net/specialpurpose.html");  

    通过索引方法也可以得到元素的顺序。例如,如果我们想在Site元素中插入一个Comment,可以使用:

Comment newcomment=newsite.insertNewComment(0);  

    即在0th位置上建立和插入一个空的Comment。现在我们需要设置它的属性和值:

newcomment.setEmail("fred@example.com");
newcomment.setStringValue("This was a reasonable addition"); 

    之后,我们可以保存这一文档。

sd.save(new File("./newsites.XML")); 

    可以看到,本文讲到的例子代码可见到Example1.Java。在运行这一程序之前,你必须将XMLBeans自带的xbean.jar和jsr173_api.jar,以及生成的sites.jar文件复制到lib目录。现在你可运行“ant example1”,将可在lib目录下得到一个newsites.XML文件。

    查看newsites.XML文件,你可看到XMLBeans保存XML Infoset的演示过程。这一文件已经被修改,但你将会注意到sites.XML文件的comment没有被删除而保留在合适的位置。当你处理那些内容不能丢失的XML文件时,这一属性非常有用。

    正如前面提到的,所有生成的类都是基于XMLObject,而XMLObject提供了浏览和验证更多的选项。在默认情况下,XMLBeans操作时没有验证。但通过调用XMLBean的vadilate()方法,你可以设置任何bean内容的验证,包括bean的子内容。验证内容包括XML Schema指定的各种限制。在我们的例子sites.xsd文件中,我们将对Emali类型进行限制,以确保输入合法的邮件地址。通过Email factory,我们可以建立Email的一个实例,对其设置数值,然后对其验证:

Email email=Email.Factory.newInstance();
email.setStringValue("email@example.com");
if(!email.validate()) { .... }

    在例子中,Validate.Java用于测试邮件地址的数组。对XMLBeans,以上方法并非唯一的验证机制。你可以设置一个验证错误“接收器”,即在某一位置上收集所有验证错误。或者,你可以在设置中打开验证。

    为了浏览一个文档,可以使用任一XMLObject的XML Cursor。我们想查看例子文件中的第一个site元素:

String stnamespace="http://www.example.com/sites/SITE";
SitesDocument sd=SitesDocument.Factory.parse(new File("./sites.XML"));
Site site=sd.getSites().getSiteArray()[0];
XMLCursor cursor=site.newCursor();
  

    此时,指针指向site元素。使用这一指针,我们可以查看整个文档内容。例如,我们想查看第一个element child:

cursor.toChild(stnamespace,"rating");  

    当你想以符号级别查看文档时,XMLCursors非常有用。以下例子(CoursorWalk.Java)剖析一个文档,然后查看整个文档,并打印出查收结果:

XMLObject sd=XMLObject.Factory.parse(new File("./sites.XML"));
XMLCursor sdcursor=sd.newCursor();
while(sdcursor.hasNextToken()) {
    sdcursor.toNextToken();
    if(sdcursor.isText()) {
      System.out.println(sdcursor.currentTokenType()
        + " " + sdcursor.getChars());
    } else {
      System.out.println(sdcursor.currentTokenType()
      + " " + sdcursor.getName());
    }
 

    值得一提的是,我们没有使用scomp生成的SiteDocument类,而直接使用XMLObject,这允许我们无需一个schema文件就可以剖析整个XML文件。

    XMLBeans 的另一种查看文档方式为:定位于提取数据的相反端,使用XPath/XQuery 表达式可查询和选择文档。XMLObjects支持selectPath()和execQuery()方法,selectPath()用于选择文档中的节点,而execQuery()方法可允许XQuery 并建立一个完整的新XML以返回数据。

    为了使用以上功能,你必须在classpath下添加更多的库,即8.1.1版本的Saxon库以及XMLBeans安装时附带的xbean_xpath.jar。你将会看到,Saxon版本中有一个与XMLBeans站点连接的链接,将saxon8.jar和xbean_xpath.jar文件复制到范例程序的lib目录下。

    为了演示使用XPath查询的过程,这里给出SimpleXPath.Java程序段。现在我们看看源代码:

String namespace="declare namespace st='http://www.example.com/sites/SITE';";
XMLObject[] sitelist=sd.selectPath(namespace+"//st:site[st:rating/@rated=5]");
for(Site site:(Site[])sitelist) System.out.println(site.getSrc());

    开始,使用XQuery声明名称空间,然后调用selectPath()。selectPath() 和 execQuery()都返回了一组XMLObjects。实际的XPath为:

//st:site[st:rating/@rated=5]  

    即,选择任一rated属性为5的site元素,我们将可得到一组XMLObjects,由此得到一组Sites并打印出结果。

    XPath 和 XQuery相互独立,但它们都能使XMLBeans执行查询和文档生成,其过程不需要减少schema类级别,而且不会让XMLBeans生成类的属性丢失。

    XMLBeans功能很强大,其inst2xsd工具能够使用一系列XML文件并为你生成一个.xsd文件。

    在下一文章中,我们将讲述有关E4X,并介绍结合E4X和XMLBeans访问基于信息服务的Web过程。

 

DJ Walker-Morgan是一名开发人员咨询师,专长是Java和用户对用户的消息发送和远程会议技术。

察看本文的国际来源

责任编辑:施衡


百度大联盟认证黄金会员Copyright© 1997- CNET Networks 版权所有。 ZDNet 是CNET Networks公司注册服务商标。
中华人民共和国电信与信息服务业务经营许可证编号:京ICP证010391号 京ICP备09041801号-159
京公网安备:1101082134