[XML]XMLBEAN 的使用工作日志

一、关于XML解析
　　
　　XML在Java应用程序里变得越来越重要, 广泛应用于数据存储和交换. 比如我们常见的配置文件,都

是以XML方式存储的. XML还应用于Java Message Service和Web Services等技术作为数据交换.
　　
　　因此,正确读写XML文档是XML应用的基础.
　　
　　Java提供了SAX和DOM两种方式用于解析XML,但即便如此,要读写一个稍微复杂的XML,也不是一件容易

的事.
　　
　　二、XMLBean简介
　　
　　Hibernate已经成为目前流行的面向Java环境的对象/关系数据库映射工具.
　　
　　在Hibernate等对象/关系数据库映射工具出现之前,对数据库的操作是通过JDBC来实现的,对数据库

的任何操作,开发人员都要自己写SQL语句来实现. 对象/关系数据库映射工具出现后,对数据库的操作转

成对JavaBean的操作,极大方便了数据库开发. 所以如果有一个类似的工具能够实现将对XML的读写转成

对JavaBean的操作,将会简化XML的读写,即使对XML不熟悉的开发人员也能方便地读写XML. 这个工具就是

XMLBean.
　　
　　三、准备XMLBean和XML文档
　　
　　XMLBean是Apache的一个开源项目,可以从http://www.apache.org/下载,最新的版本是2.0. 解压后

目录如下:
　　xmlbean2.0.0
　　+---bin
　　+---docs
　　+---lib
　　+---samples
　　+---schemas
　　
　　另外还要准备一个XML文档(customers.xml),在本文的例子里,我们将对这个文档进行读写操作. 文

档源码如下:
<?xml version="1.0" encoding="UTF-8"?>
<persons>
 <person>
  <name>潘爽</name>
  <sex>男</sex>
  <age>24</age>
 </person>
</persons>
　　
　　这是一个人的数据模型,每个人都有姓名（name）,性别（sex）,年龄（age）: 　　
　　此外,还要准备一个配置文件(文件名customer.xsdconfig),这个文件的作用我后面会讲,它的内容如

下:
　　<xb:config xmlns:xb="http://xml.apache.org/xmlbeans/2004/02/xbean/config">
　　<xb:namespace>
　　<xb:package>sample.xmlbean</xb:package>
　　</xb:namespace></xb:config>
　　
　　四、XMLBean使用步骤
　　
　　和其他面向Java环境的对象/关系数据库映射工具的使用步骤一样,在正式使用XMLBean前,我们要作

两个准备.
　　
　　1. 生成XML Schema文件
　　
　　什么是XML Schema文件? 正常情况下,每个XML文件都有一个Schema文件,XML Schema文件是一个XML

的约束文件,它定义了XML文件的结构和元素.以及对元素和结构的约束. 通俗地讲,如果说XML文件是数据

库里的记录,那么Schema就是表结构定义.
　　
　　为什么需要这个文件? XMLBean需要通过这个文件知道一个XML文件的结构以及约束,比如数据类型等

. 利用这个Schema文件,XMLBean将会产生一系列相关的Java Classes来实现对XML的操作. 而作为开发人

员,则是利用XMLBean产生的Java Classes来完成对XML的操作而不需要SAX或DOM.
　　
　　怎样产生这个Schema文件呢? 如果对于熟悉XML的开发人员,可以自己来写这个Schema文件,对于不熟

悉XML的开发人员,可以通过一些工具来完成.
　　
　　比较有名的如XMLSPY和Stylus Studio都可以通过XML文件来生成Schema文件. 加入我们已经生成这

个Schema文件(person.xsd):
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema attributeFormDefault="unqualified"

targetNamespace="http://www.person.huateng.com" xmlns:xs="http://www.w3.org/2001/XMLSchema"

elementFormDefault="qualified">
 <xs:element name="PERSONS" type="person:PERSON"

xmlns:person="http://www.person.huateng.com"/>
 <xs:complexType name="PERSON_AGEType">
  <xs:sequence>
   <xs:element type="xs:int" name="AGE"/>
  </xs:sequence>
 </xs:complexType>
 <xs:complexType name="PERSON_NAMEType">
  <xs:sequence>
   <xs:element type="xs:string" name="FULLNAME"/>
  </xs:sequence>
 </xs:complexType>
 <xs:complexType name="PERSON_SEXType">
  <xs:sequence>
   <xs:element type="xs:string" name="SEX"/>
  </xs:sequence>
 </xs:complexType>
 <xs:complexType name="PERSON_INFOType">
  <xs:sequence>
   <xs:element type="person:PERSON_NAMEType" name="PERSON_NAME"

xmlns:person="http://www.person.huateng.com" />
   <xs:element type="person:PERSON_AGEType" name="PERSON_AGE"

xmlns:person="http://www.person.huateng.com" />
   <xs:element type="person:PERSON_SEXType" name="PERSON_SEX"

xmlns:person="http://www.person.huateng.com" />
  </xs:sequence>
 </xs:complexType>
 <xs:complexType name="PERSON">
  <xs:sequence>
   <xs:element type="person:PERSON_INFOType" name="PERSON_INFO" maxOccurs="unbounded"

minOccurs="0" xmlns:person="http://www.person.huateng.com"/>
  </xs:sequence>
 </xs:complexType>
</xs:schema>

　　
　　2. 利用scomp来生成Java Classes
　　
　　scomp是XMLBean提供的一个编译工具,它在bin的目录下. 通过这个工具,我们可以将以上的Schema文

件生成Java Classes.
　　
　　scomp的语法如下:-
　　
　　scomp [options] [dirs]* [schemaFile.xsd]* [service.wsdl]* [config.xsdconfig]*
　　
　　主要参数说明:
　　-src [dir]　　　　　　　　　-- 生成的Java Classes存放目录
　　-srconly　　　　　　　　　-- 不编译Java Classes,不产生Jar文件
　　-out [jarFileName]　-- 生成的Jar文件,缺省是xmltypes.jar
　　-compiler　　　　　　　　 -- Java编译器的路径,即Javac的位置
　　schemaFile.xsd　　-- XML Schema文件位置
　　config.xsdconfig　 -- xsdconfig文件的位置, 这个文件主要用来制定生成的Java Class
　　的一些文件名规则和Package的名称,在本文,package是sample.xmlbean
　　
　　在本文,我是这样运行的:
　　scomp -src build/src　-out build/person.jar schema/person.xsd
　　-compiler C:/jdk/bin/javac person.xsdconfig
　　
　　这个命令行的意思是告诉scomp生成customerXmlBean.jar,放在build目录下,同时
　　生成源代码放在build/src下, Schema文件是customer.xsd,xsdconfig文件是customer.xsdconfig.
　　
　　其实, 生成的Java源代码没有多大作用,我们要的是jar文件.我们先看一下

build/src/sample/xmlbean下生成的Classes.
　　PersonDocument.java
　　-- 整个XML文档的Java Class映射
　　PERSONNAMEType.java
　　-- 节点name的映射
　　PERSONAGEType.java
　　-- 节点age的映射
　　PERSONSEXType.java
　　-- 节点sex的映射

　　
　　好了,到此我们所有的准备工作已经完成了. 下面就开始进入重点：利用刚才生成的jar文件读写

XML.
　　
　　五、利用XMLBean读XML文件
　　
　　新建一个Java Project,将XMLBean2.0.0/lib/下的Jar文件和刚才我们生成的person.jar加入
　　
　　到Project的ClassPath.
　　
　　新建一个Java Class: TransServletXML.java　源码如下:
　　package com.huateng.test.servlet;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.methods.InputStreamRequestEntity;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.xmlbeans.XmlOptions;

import com.huateng.person.PERSON;
import com.huateng.person.PERSONAGEType;
import com.huateng.person.PERSONINFOType;
import com.huateng.person.PERSONNAMEType;
import com.huateng.person.PERSONSDocument;
import com.huateng.person.PERSONSEXType;

/**
 * Servlet implementation class for Servlet: TransServletXML
 *
 */
 public class TransServletXML extends javax.servlet.http.HttpServlet implements

javax.servlet.Servlet {

 public TransServletXML() {
  super();
 }   
 

 protected void doGet(HttpServletRequest request, HttpServletResponse response) throws

ServletException, IOException {
  doPost(request, response);
 }  
 

 protected void doPost(HttpServletRequest request, HttpServletResponse response) throws

ServletException, IOException {
  String head = "<?xml version=/"1.0/" encoding=/"GB2312/" standalone=/"no/" ?>"
   + "/n";
  String encoding = "GB2312";
  //设置XML属性
  XmlOptions xmlOptions = new XmlOptions();
  xmlOptions.setSavePrettyPrint().setSavePrettyPrintIndent(4);
  xmlOptions.setCharacterEncoding(encoding);
 
  PERSONSDocument document = PERSONSDocument.Factory.newInstance();
  PERSON person = document.addNewPERSONS();
  PERSONINFOType type  =person.addNewPERSONINFO();
  PERSONNAMEType personName = type.addNewPERSONNAME();
  personName.setFULLNAME("潘爽");
  PERSONSEXType personSex = type.addNewPERSONSEX();
  personSex.setSEX("男");
  PERSONAGEType personAge = type.addNewPERSONAGE();
  personAge.setAGE(23);
 
  PERSONINFOType type1  =person.addNewPERSONINFO();
  PERSONNAMEType personName1 = type1.addNewPERSONNAME();
  personName1.setFULLNAME("姜久权");
  PERSONSEXType personSex1 = type1.addNewPERSONSEX();
  personSex1.setSEX("男");
  PERSONAGEType personAge1 = type1.addNewPERSONAGE();
  personAge1.setAGE(23);
 
  PERSONINFOType type2  =person.addNewPERSONINFO();
  PERSONNAMEType personName2 = type2.addNewPERSONNAME();
  personName2.setFULLNAME("张路");
  PERSONSEXType personSex2 = type2.addNewPERSONSEX();
  personSex2.setSEX("男");
  PERSONAGEType personAge2 = type2.addNewPERSONAGE();
  personAge2.setAGE(23);
 
  PERSONINFOType type3  =person.addNewPERSONINFO();
  PERSONNAMEType personName3 = type3.addNewPERSONNAME();
  personName3.setFULLNAME("李伟");
  PERSONSEXType personSex3 = type3.addNewPERSONSEX();
  personSex3.setSEX("男");
  PERSONAGEType personAge3 = type3.addNewPERSONAGE();
  personAge3.setAGE(23);
 

 
  StringBuffer buffer = new StringBuffer(head);
  String xmlContent = document.xmlText(xmlOptions);
  buffer.append(xmlContent);
 
  InputStream inputStream = new ByteArrayInputStream(buffer.toString().getBytes());
  HttpClient httpClient = new HttpClient();
  PostMethod postMethod = new PostMethod("http://127.0.0.1:8090/DWRTest/ParseXML");
  InputStreamRequestEntity inputStreamRequestEntity = new InputStreamRequestEntity

(inputStream,inputStream.available());
  postMethod.setRequestEntity(inputStreamRequestEntity);
  int resCode = httpClient.executeMethod(postMethod);
  if(resCode == HttpServletResponse.SC_OK) {
   byte[] resMessage = postMethod.getResponseBody();
   System.out.println(new String(resMessage));
  }
 }          
}
　　
　　运行它,参看输出结果:
　　Customer#0
　　Customer ID:1
　　First name:Jessica
　　Last name:Lim
　　Gender:female
　　PhoneNumber:1234567
　　PrimaryAddress:
　　PostalCode:350106
　　AddressLine1:#25-1
　　AddressLine2:SHINSAYAMA 2-CHOME
　　BillingAddress:
　　Receiver:Ms Danielle
　　PostalCode:350107
　　AddressLine1:#167
　　AddressLine2:NORTH TOWER HARBOUR CITY
　　Customer#1
　　Customer ID:2
　　First name:David
　　Last name:Bill
　　Gender:male
　　PhoneNumber:808182
　　PrimaryAddress:
　　PostalCode:319087
　　AddressLine1:1033 WS St.
　　AddressLine2:Tima Road
　　BillingAddress:
　　Receiver:Mr William
　　PostalCode:672993
　　AddressLine1:1033 WS St.
　　AddressLine2:Tima Road
　　怎么样,是不是很轻松? XMLBean的威力.
　　
　　六、利用XMLBean写XML文件
　　
　　利用XMLBean创建一个XML文档也是一件轻而易举的事.我们再增加一个Method,
　　请看一下的Java Class:
　　public void createCustomer() {
　　try {
　　// Create Document
　　CustomersDocument doc = CustomersDocument.Factory.newInstance();
　　// Add new customer
　　CustomerType customer = doc.addNewCustomers().addNewCustomer();
　　// set customer info
　　customer.setId(3);
　　customer.setFirstname("Jessica");
　　customer.setLastname("Lim");
　　customer.setGender("female");
　　customer.setPhoneNumber("1234567");
　　// Add new address
　　AddressType address = customer.addNewAddress();
　　// Add new PrimaryAddress
　　PrimaryAddressType primaryAddress = address.addNewPrimaryAddress();
　　primaryAddress.setPostalCode("350106");
　　primaryAddress.setAddressLine1("#25-1");
　　primaryAddress.setAddressLine2("SHINSAYAMA 2-CHOME");
　　// Add new BillingAddress
　　BillingAddressType billingAddress = address.addNewBillingAddress();
　　billingAddress.setReceiver("Ms Danielle");
　　billingAddress.setPostalCode("350107");
　　billingAddress.setAddressLine1("#167");
　　billingAddress.setAddressLine2("NORTH TOWER HARBOUR CITY");
　　File xmlFile = new File(filename);
　　doc.save(xmlFile);　　　　} catch (Exception ex) {
　　ex.printStackTrace();　　　　}　}
　　修改main method.
　　public static void main(String[] args) {
　　String filename = "F://JavaTest//Eclipse//XMLBean//xml//customers_new.xml";
　　CustomerXMLBean customerXMLBean = new CustomerXMLBean(filename);
　　customerXMLBean.createCustomer();
　　}
　　运行,打开customers_new.xml:
　　<?xml version="1.0" encoding="UTF-8"?>
　　<Customers>
　　<customer>
　　<id>3</id>
　　<gender>female</gender>
　　<firstname>Jessica</firstname>
　　<lastname>Lim</lastname>
　　<phoneNumber>1234567</phoneNumber>
　　<address>
　　<primaryAddress>
　　<postalCode>350106</postalCode>
　　<addressLine1>#25-1</addressLine1>
　　<addressLine2>SHINSAYAMA 2-CHOME</addressLine2>
　　</primaryAddress>
　　<billingAddress>
　　<receiver>Ms Danielle</receiver>
　　<postalCode>350107</postalCode>
　　<addressLine1>#167</addressLine1>
　　<addressLine2>NORTH TOWER HARBOUR CITY</addressLine2>
　　</billingAddress>
　　</address>
　　</customer>
　　</Customers>
　　
　　七、利用XMLBean修改XML文件
　　
　　我们再增加一个Method:
　　public void updateCustomer(int id,String lastname) {
　　try {
　　File xmlFile = new File(filename);
　　CustomersDocument doc = CustomersDocument.Factory.parse(xmlFile);
　　CustomerType[] customers = doc.getCustomers().getCustomerArray();
　　for (int i = 0; i < customers.length; i++) {
　　CustomerType customer = customers[i];
　　if(customer.getId()==id){
　　customer.setLastname(lastname);
　　break;
　　}
　　}
　　doc.save(xmlFile);
　　} catch (Exception ex) {
　　ex.printStackTrace();
　　}
　　}
　　main method:
　　public static void main(String[] args) {
　　String filename = "F://JavaTest//Eclipse//XMLBean//xml//customers_new.xml";
　　CustomerXMLBean customerXMLBean = new CustomerXMLBean(filename);
　　customerXMLBean.updateCustomer(3,"last");　　}
　　运行之后,我们将会看到人编号为3的客户的lastname已经改为last.
　　
　　八、利用XMLBean删除一个customer
　　
　　再增加一个Method:
　　public void deleteCustomer(int id) {
　　try {
　　File xmlFile = new File(filename);
　　CustomersDocument doc = CustomersDocument.Factory.parse(xmlFile);
　　CustomerType[] customers = doc.getCustomers().getCustomerArray();
　　for (int i = 0; i < customers.length; i++) {
　　CustomerType customer = customers[i];
　　if(customer.getId()==id){
　　customer.setNil() ;
　　break;
　　}
　　}
　　doc.save(xmlFile);
　　} catch (Exception ex) {
　　ex.printStackTrace();
　　}
　　}
　　
　　main method:
　　public static void main(String[] args) {
　　String filename = "F://JavaTest//Eclipse//XMLBean//xml//customers_new.xml";
　　CustomerXMLBean customerXMLBean = new CustomerXMLBean(filename);
　　customerXMLBean.deleteCustomer(3);
　　}
　　
　　运行,我们将会看到客户编号为3的客户的资料已经被删除.

注意：在建立XSD文件时，由于xmlspy工具的关系，生成的文件内容在细节上会有差异，但是都可以正常

使用。
在生成节点类型时，最好显示的给予标注， 可以按照如下的格式书写： <xs:element

name="phoneNumber" type="xs:string"/>
在用XSD文件生成JAVA文件时，sequence会根据属性的配置生成一个对象或者是该对象的一个数组，关键

就在于属性中是否配置了maxOccurs，当把maxOccurs配置为maxOccurs="unbounded"
时，在生成JAVA文件时会创建一个数组；否则只创建一个对象。（生成一个数组是比较好的）