SDO2.0：创建和读取 XML 文档

SDO2.0：创建和读取 XML 文档

引言：什么是 SDO？

Service Data Object (SDO) 2.0 是一个开放标准数据模型编程 API，允许开发人员在较高的级别方便地操作数据。尽管 SDO 1.0 以相同的数据抽象为目标，但有几个大的缺点，其中主要的一点是缺少 Helper 类，如 XSDHelper, XMLHelper 等。而最终结果是，开发人员被迫使用 SDO 1.0 实现 API（来自 Eclipse Modeling Framework (EMF) SDK）。

当前的实现 (SDO 2.0) 使用 EMF 2.2 SDK，但这个 SDO 2.0 实现细节并不会影响开发人员根据新 API 编写程序。将来，开放源代码社区（通过 Apache Software Foundation）可能会决定提供不同的 SDO 2.0 实现，但这不应影响基于 SDO 2.0 API 构建的应用程序。

了解这个新 API 的优势的最基本方法是使用 SDO 2.0 来创建符合 XML 模式 (XSD) 的 XML 文档并对其进行读取操作。要在不使用 SDO 2.0 的情况下完成相同的工作，开发人员需要理解 XML 解析器如何工作，并将数据解析逻辑与应用程序紧密集成。如果以后 XSD 需要更改，将需要对应用程序的各处进行调整，从而可能对代码的质量带来灾难性的影响。

SDO 2.0 API 的新用户很难直接通过学习规范来理解相关概念。为了提供一定的帮助，我们从 XML Schema Primer（请参阅参考资料）创建了一个示例，以说明如何使用 SDO 2.0 API 进行以下任务：

• 将 XML 文档写入到磁盘
• 从磁盘读取该文档。

场景：购买订单信息收集和配送

以下是我们将尝试通过我们的示例实现的使用场景。首先，公司确定购买订单（purchase order，PO）信息的要求。完成此任务后，我们就开始创建静态表单，以设计信息的结构。在数据库中，此静态表单即表模式。在 XML，此静态表单即 XML 模式 (XSD)。如果以后需要收集更多的客户信息，我们将需要重新设计表单/表模式/XSD。

下订单时，客户需要填写 PO 表单，或向操作员提供相同的信息，以便填写此表单。表单中的信息将随后由公司用于对订单进行配送。

公司接收到 PO 信息后，很有可能会将其进行保存，并在以后对其进行读取以用于各种目的（如提供客户支持）。在此示例中，我们可以将信息以 XML 格式保存，然后使用 SDO API 进行读取。

图 1 显示了从客户 Robert Smith 收集的 PO 信息示例。将创建 XSD 文件，以采用结构化的方式存储此示例购买订单。将用一个名为 CreatePurchaseOrder.java 的示例程序来采用 XML 格式创建示例 PO（名为 po.xml）。最后，将使用 ReadPurchaseOrder.java 来演示如何从 po.xml 读取订单信息。

图 1. 来自 Rober Smith 的示例购买订单信息

Order date: 1999-10-20 Shipping information: Name:Alice Smith Street:123 Maple Street City:Mill Valley State:CA Zip code: 90952 Country:US Billing information: Name:Robert Smith Street:8 Oak Avenue City:Mill Valley State:PA Zip code: 95819 Country:US Order Items: 1. Part number:872-AA Product name:Lawnmower Quantity: 1 Price: 148.95 Comment:Confirm this is electric 2. Part number:926-AA Product name:Baby Monitor Quantity: 1 Price: 39.98 Ship date: 1999-05-21 Comment: Hurry, my lawn is going wild!

回页首

购买订单的 XML 模式

基于图 1 所示的示例购买订单，可以使用一个 PO 类型来表示订单。我们将其命名为 PurchaseOrderType。PurchaseOrderType 的实例可以包含四个主要数据，如下所示：

1. shipping information
2. billing information
3. order items information
4. comment

shipping information 和 billing information 可包含更多的数据，如 name、street、city、state、zip 和 country。Order items information 可以包含客户所购买的物品的很多信息。每个物品可能包含 part number、product name、quantity, price、ship date 和 comment。PO 的 comment 区域包含一个字符串值，并不要求采用更结构化的信息。

清单 1 显示了结构化为 XSD 格式的文件中包含的所有购买订单信息。

清单 1. PO.xsd

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:po="http://www.example.com/PO" targetNamespace="http://www.example.com/PO"> <xsd:element name="purchaseOrder" type="PurchaseOrderType"/> <xsd:element name="comment" type="xsd:string"/> <xsd:complexType name="PurchaseOrderType"> <xsd:sequence> <xsd:element name="shipTo" type="USAddress"/> <xsd:element name="billTo" type="USAddress"/> <xsd:element ref="comment" minOccurs="0"/> <xsd:element name="items" type="Items"/> </xsd:sequence> <xsd:attribute name="orderDate" type="xsd:date"/> </xsd:complexType> <xsd:complexType name="USAddress"> <xsd:sequence> <xsd:element name="name" type="xsd:string"/> <xsd:element name="street" type="xsd:string"/> <xsd:element name="city" type="xsd:string"/> <xsd:element name="state" type="xsd:string"/> <xsd:element name="zip" type="xsd:decimal"/> </xsd:sequence> <xsd:attribute name="country" type="xsd:NMTOKEN" fixed="US"/> </xsd:complexType> <xsd:complexType name="Items"> <xsd:sequence> <xsd:element name="item" minOccurs="0" maxOccurs="unbounded"> <xsd:complexType> <xsd:sequence> <xsd:element name="productName" type="xsd:string"/> <xsd:element name="quantity"> <xsd:simpleType> <xsd:restriction base="xsd:positiveInteger"> <xsd:maxExclusive value="100"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="USPrice" type="xsd:decimal"/> <xsd:element ref="comment" minOccurs="0"/> <xsd:element name="shipDate" type="xsd:date" minOccurs="0"/> </xsd:sequence> <xsd:attribute name="partNum" type="po:SKU" use="required"/> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:simpleType name="SKU"> <xsd:restriction base="xsd:string"> <xsd:pattern value="\d{3}-[A-Z]{2}"/> </xsd:restriction> </xsd:simpleType>

还可以使用统一建模语言（Unified Modeling Language，UML）类关系图来对购买订单信息进行结构化，如图 2 中所示。

图 2. 购买订单的 UML 类关系图

XSD po.xsd 文件和该 UML 类关系图具有以下区别：

1. 类关系图定义了 ItemType，而并未在 po.xsd.diagram 中定义此项。尽管 po.xsd 并不具体定义 ItemType，XSD 规范仍可将 ItemType 作为匿名类型处理。
2. XSD 中所有 xsd:<type> 在类关系图中都缩写为了 <type>。在 XSD 中，xsd:<type> 模式中的 xsd 用于指示类型所属的命名空间。在类关系图中，为了简单起见而将其省略了。
3. SKU type 未在类关系图中定义。SKU type 事实上是在 po 命名空间中定义的规范化字符串类型。在类关系图中，它由 string type 加以表示。

回页首

创建 XML 格式的示例 PO

清单 2 中所示的示例 CreatePurchaseOrder.java 程序用于创建一个 PO，该 PO 采用名为 po.xml 的 XML 格式（如清单 3 所示）。

清单 2. CreatePurchaseOrder.java

/** * Author: Fuhwei Lwo */ import java.io.FileOutputStream; import java.io.FileInputStream; import java.io.OutputStream; import commonj.sdo.DataObject; import commonj.sdo.helper.DataFactory; import commonj.sdo.helper.XMLHelper; import commonj.sdo.helper.XSDHelper; public class CreatePurchaseOrder { private static final String PO_MODEL = "po.xsd"; private static final String PO_NAMESPACE = "http://www.example.com/PO"; private static final String PO_XML = "po.xml"; private static void definePOTypes() throws Exception { FileInputStream fis = new FileInputStream(PO_MODEL); XSDHelper.INSTANCE.define(fis, null); fis.close(); } public static void main(String[] args) throws Exception { definePOTypes(); DataObject purchaseOrder = DataFactory.INSTANCE.create(PO_NAMESPACE, "PurchaseOrderType"); purchaseOrder.setString("orderDate", "1999-10-20"); DataObject shipTo = purchaseOrder.createDataObject("shipTo"); shipTo.set("country", "US"); shipTo.set("name", "Alice Smith"); shipTo.set("street", "123 Maple Street"); shipTo.set("city", "Mill Valley"); shipTo.set("state", "CA"); shipTo.setString("zip", "90952"); DataObject billTo = purchaseOrder.createDataObject("billTo"); billTo.set("country", "US"); billTo.set("name", "Robert Smith"); billTo.set("street", "8 Oak Avenue"); billTo.set("city", "Mill Valley"); billTo.set("state", "PA"); billTo.setString("zip", "95819"); purchaseOrder.set("comment", "Hurry, my lawn is going wild!"); DataObject items = purchaseOrder.createDataObject("items"); DataObject item1 = items.createDataObject("item"); item1.set("partNum", "872-AA"); item1.set("productName", "Lawnmower"); item1.setInt("quantity", 1); item1.setString("USPrice", "148.95"); item1.set("comment", "Confirm this is electric"); DataObject item2 = items.createDataObject("item"); item2.set("partNum", "926-AA"); item2.set("productName", "Baby Monitor"); iteim2.setInt("quantity", 1); item2.setString("USPrice", "39.98"); item2.setString("shipDate", "1999-05-21"); OutputStream stream = new FileOutputStream(PO_XML); XMLHelper.INSTANCE.save(purchaseOrder, PO_NAMESPACE, "purchaseOrder", stream); } }

清单 3. Po.xml

<?xml version="1.0" encoding="ASCII"?> <po:purchaseOrder xmlns:po="http://www.example.com/PO" orderDate="1999-10-20"> <shipTo country="US"> <name>Alice Smith</name> <street>123 Maple Street</street> <city>Mill Valley</city> <state>CA</state> <zip>90952</zip> </shipTo> <billTo country="US"> <name>Robert Smith</name> <street>8 Oak Avenue</street> <city>Mill Valley</city> <state>PA</state> <zip>95819</zip> </billTo> <comment>Hurry, my lawn is going wild!</comment> <items> <item partNum="872-AA"> <productName>Lawnmower</productName> <quantity>1</quantity> <USPrice>148.95</USPrice> <comment>Confirm this is electric</comment> </item> <item partNum="926-AA"> <productName>Baby Monitor</productName> <quantity>1</quantity> <USPrice>39.98</USPrice> <shipDate>1999-05-21</shipDate> </item> </items> </po:purchaseOrder>

该示例 Java 程序首先通过调用 XSDHelper.INSTANCE.define() 方法向 SDO 运行时注册 po.xsd 中描述的所有类型。然后，它从 PurchaseOrderType 创建一个根 DataObject。该程序将从该处使用 DataObject API 来构建 DataObject 树，以表示购买订单信息，如图 3 中所示。

图 3. DataObject 树

在图 3 中，每个矩形都划分为两个隔间。顶部间隔（灰色）指示 DataObject 实例名称及其实际类型；底部间隔指示所包含的属性。例如，树的根元素为 purchaseOrder DataObject 实例；其实际类型为 PurchaseOrderType，在清单 1 中的 PO.xsd 中定义。在此 DataObject 实例中，包含两个属性值——orderDate 和 comment。

创建 DataObject 树后，该程序调用 XMLHelper.INSTANCE.save() 方法来将从 purchaseOrder DataObject 实例开始的树内容保存到 XML 文档中（此例中为 po.xml）。事实上，可以将树中任何 DataObject 实例指定为 XMLHelper.INSTANCE.save() 方法的第一个参数，save() 方法将保存从所指定的实例开始的所有 DataObject 实例。

回页首

读取示例 PO

CreatePurchaseOrder.java 创建了 po.xml 后，我们可以编译并运行清单 4 中所示的 ReadPurchaseOrder.java，以演示如何使用 SDO API 来遍历 po.xml 的内容。该应用程序将执行以下操作：

1. 进行检查，以确保已向 SDO 运行时注册了 po.xsd 中定义的类型
2. 调用 XMLHelper.load() 方法来将 po.xml 加载到内存中（使用 XMLDocument 实例 xmlDoc 加以表示）
3. 调用 xmlDoc.getRootObject() 方法来检索名为 purchaseOrder 的 DataObject 树的根对象，该对象与图 3 中所示的 DataObject 树关系图中的 purchaseOrder DataObject 对应
4. purchaseOrder DataObject 返回后，遍历 DataObject 树，以检索关于此 PO 的所有信息

清单 4. ReadPurchaseOrder.java

/** /** * Author: Fuhwei Lwo */ import java.io.FileInputStream; import java.util.List; import commonj.sdo.DataObject; import commonj.sdo.helper.XMLDocument; import commonj.sdo.helper.XMLHelper; import commonj.sdo.helper.XSDHelper; public class ReadPurchaseOrder { private static final String PO_MODEL = "po.xsd"; private static final String PO_XML = "po.xml"; private static void definePOTypes() throws Exception { FileInputStream fis = new FileInputStream(PO_MODEL); XSDHelper.INSTANCE.define(fis, null); fis.close(); } public static void main(String[] args) throws Exception { definePOTypes(); FileInputStream fis = new FileInputStream(PO_XML); XMLDocument xmlDoc = XMLHelper.INSTANCE.load(fis); DataObject purchaseOrder = xmlDoc.getRootObject(); System.out.println("Order date: " + purchaseOrder.get("orderDate")); System.out.println("Comment: " + purchaseOrder.get("comment")); DataObject shipTo = purchaseOrder.getDataObject("shipTo"); System.out.println("Ship to name: " + shipTo.get("name")); DataObject billTo = purchaseOrder.getDataObject("billTo"); System.out.println("Bill to name: " + billTo.get("name")); System.out.println(); DataObject items = purchaseOrder.getDataObject("items"); List itemList = items.getList("item"); for (int i=0; i<itemList.size(); i++) { DataObject item = (DataObject)itemList.get(i); System.out.println("Part num: " + item.get("partNum"));S System.out.println("Product name: " + item.get("productName")); } // for } }

清单 4 中以黑体显示的 System.out.println() 显示各种数据对象的属性值，包括：

• purchaseOrder DataObject 的 orderDate 和 comment 属性
• shipTo DataObject 的 name 属性
• billTo DataObject 的 name 属性
• 各种数据对象的 partNum 和 productName 属性

图 4. 运行 ReadPurchaseOrder 的控制台输出

Order date: 1999-10-20 Comment:Hurry, my lawn is going wild! Ship to name:Alice Smith Bill to name:Robert Smith Part num:872-AA Product name:Lawnmower Part num:926-AA Product name:Baby monitor

在图 4 中，我们可以看到运行 ReadPurchaseOrder Java 代码的输出。

回页首

结束语：SDO 将成为事实上的数据模型编程 API

SDO 2.0 API 提供了创建和访问数据的一致方式，使开发人员不必了解分析和维护数据完整性的底层实现细节。SDO 2.0 目前是 Apache Software Foundation 下的一个试验性子项目（称为 Tuscany），预期将成为 SOA 开发的数据模型编程 API 的事实标准。请参阅参考资料部分，以获得一个相关链接。

可以从上面的示例中看出，SDO 2.0 API 使您完全不必知道和使用 XML 解析器 API 来读取、写入和操作数据。如果使用 Java 创建了 DataObject 来表示符合您所定义的 XML 模式的 XML 数据，SDO 2.0 将提供足够的方便性和灵活性，让您将精力放在如何使用数据上。因此，它可为您带来极大的好处，从而提高开发工作效率和产品质量。

总之，通过使用 SDO 2.0 提供的数据抽象技术，您可以根据所定义的业务逻辑来处理数据，以满足您的业务需求。这可以帮助您简化业务应用程序开发，也能提高团队的工作效率和工作质量。

回页首

参考资料

学习

• 您可以参阅本文在 developerWorks 全球站点上的 英文原文 。
  
  
• 请参阅 W3 网站上的 XML Schema Part 0:Primer Second Edition，以了解 XML 模式机制的说明，并了解如何使用 XML 模式语言创建模式。
  
  
• 请参阅 Service Data Objects 规范。
  
  
• 在 Apache Software Foundation 网站了解有关 Tuscany/SDO 2.0 project 的更多信息。
  
  
• 请访问 SOA and Web services 专区，以获得数百篇关于如何开发 Web 服务应用程序的文章以及入门级、中级和高级教程，您将大开眼界。

讨论

• developerWorks 博客 ——参加 developerWorks 社区。
  
  

回页首

关于作者

		Fuhwei Lwo 目前是 WebSphere Service Data Objects (SDO) 的团队负责人。他主要的工作重点是推动在面向服务的体系结构（Service Oriented Architecture，SOA）中将 SDO 作为数据数据模型编程 API 成功采用。

凡是有该标志的文章，都是该blog博主Caoer（草儿）原创，凡是索引、收藏
、转载请注明来处和原文作者。非常感谢。