一个 XSD 实例

本节会为您演示如何编写一个 XML Schema。您还将学习到编写 schema 的不同方法。

XML 文档

让我们看看这个名为 "shiporder.xml" 的 XML 文档：

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2.  
  3. <shiporder orderid="889923"
  4. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5. xsi:noNamespaceSchemaLocation="shiporder.xsd">
  6.  <orderperson>George Bush</orderperson>
  7.  <shipto>
  8.   <name>John Adams</name>
  9.   <address>Oxford Street</address>
  10.   <city>London</city>
  11.   <country>UK</country>
  12.  </shipto>
  13.  <item>
  14.   <title>Empire Burlesque</title>
  15.   <note>Special Edition</note>
  16.   <quantity>1</quantity>
  17.   <price>10.90</price>
  18.  </item>
  19.  <item>
  20.   <title>Hide your heart</title>
  21.   <quantity>1</quantity>
  22.   <price>9.90</price>
  23.  </item>
  24. </shiporder>

上面的XML文档包括根元素 "shiporder"，其中包含必须名为 "orderid" 的属性。"shiporder" 元素包含三个不同的子元素："orderperson"、"shipto" 以及 "item"。"item" 元素出现了两次，它含有一个 "title"、一个可选 "note" 元素、一个 "quantity" 以及一个 "price" 元素。

上面这一行 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"，告知XML解析器根据某个 schema 来验证此文档。这一行：xsi:noNamespaceSchemaLocation="shiporder.xsd" 规定了 schema 的位置（在这里，它与 "shiporder.xml" 处于相同的文件夹）。

创建一个 XML Schema

现在，我们需要为上面这个 XML 文档创建一个 schema。

我们可以通过打开一个新的文件来开始，并把这个文件命名为 "shiporder.xsd"。要创建schema，我们仅仅需要简单地遵循 XML 文档中的结构，定义我们所发现的每个元素。首先我们开始定义一个标准的 XML 声明：

  1. <?xml version="1.0" encoding="ISO-8859-1" ?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  3. ...
  4. ...
  5.  
  6.  
  7. </xs:schema>

在上面的 schema 中，我们使用了标准的命名空间 (xs)，与此命名空间相关联的 URI 是 Schema 的语言定义（Schema language definition），其标准值是 http://www.w3.org/2001/XMLSchema。

接下来，我们需要定义 "shiporder" 元素。此元素拥有一个属性，其中包含其他的元素，因此我们将它认定为复合类型。"shiporder" 元素的子元素被 xs:sequence 元素包围，定义了子元素的次序：

  1. <xs:element name="shiporder">
  2.  <xs:complexType>
  3.   <xs:sequence>
  4.   ...
  5.   ...
  6.   </xs:sequence>
  7.   ...
  8.  </xs:complexType>
  9. </xs:element>

然后我们需要把 "orderperson" 元素定义为简易类型（这是因为它不包含任何属性或者其他的元素）。类型 (xs:string) 的前缀是由命名空间的前缀规定的，此命名空间与指示预定义的 schema 数据类型的 XML schema 相关联：

  1. <xs:element name="orderperson" type="xs:string"/>

接下来，我需要把两个元素定义为复合类型："shipto" 和 "item"。我们从定义 "shipto" 元素开始：

  1. <xs:element name="shipto">
  2.  <xs:complexType>
  3.   <xs:sequence>
  4.    <xs:element name="name" type="xs:string"/>
  5.    <xs:element name="address" type="xs:string"/>
  6.    <xs:element name="city" type="xs:string"/>
  7.    <xs:element name="country" type="xs:string"/>
  8.   </xs:sequence>
  9.  </xs:complexType>
  10. </xs:element>

通过 schema，我们可使用 maxOccurs 和 minOccurs 属性来定义某个元素可能出现的次数。maxOccurs 定义某元素出现次数的最大值，而 minOccurs 则定义某元素出现次数的最小值。maxOccurs 和 minOccurs 的默认值都是 1！

现在，我们可以定义 "item" 元素了。这个元素可在 "shiporder" 元素内部出现多次。这是通过把 "item" 元素的 maxOccurs 属性的值设定为 "unbounded" 来实现的，这样 "item" 元素就可出现创作者所希望的任意多次。请注意，"note" 元素是可选元素。我们已经把此元素的 minOccurs 属性设定为 0 了：

  1. <xs:element name="item" maxOccurs="unbounded">
  2.  <xs:complexType>
  3.   <xs:sequence>
  4.    <xs:element name="title" type="xs:string"/>
  5.    <xs:element name="note" type="xs:string" minOccurs="0"/>
  6.    <xs:element name="quantity" type="xs:positiveInteger"/>
  7.    <xs:element name="price" type="xs:decimal"/>
  8.   </xs:sequence>
  9.  </xs:complexType>
  10. </xs:element>

现在，我们可以声明 "shiporder" 元素的属性了。由于这是一个必选属性，我们规定 use="required"。

注释：此属性的声明必须被置于最后：

  1. <xs:attribute name="orderid" type="xs:string" use="required"/>

这是这个名为 "shiporder.xsd" 的 schema 文件的文档清单：

  1. <?xml version="1.0" encoding="ISO-8859-1" ?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  3.  
  4. <xs:element name="shiporder">
  5.  <xs:complexType>
  6.   <xs:sequence>
  7.    <xs:element name="orderperson" type="xs:string"/>
  8.    <xs:element name="shipto">
  9.     <xs:complexType>
  10.      <xs:sequence>
  11.       <xs:element name="name" type="xs:string"/>
  12.       <xs:element name="address" type="xs:string"/>
  13.       <xs:element name="city" type="xs:string"/>
  14.       <xs:element name="country" type="xs:string"/>
  15.      </xs:sequence>
  16.     </xs:complexType>
  17.    </xs:element>
  18.    <xs:element name="item" maxOccurs="unbounded">
  19.     <xs:complexType>
  20.      <xs:sequence>
  21.       <xs:element name="title" type="xs:string"/>
  22.       <xs:element name="note" type="xs:string" minOccurs="0"/>
  23.       <xs:element name="quantity" type="xs:positiveInteger"/>
  24.       <xs:element name="price" type="xs:decimal"/>
  25.      </xs:sequence>
  26.     </xs:complexType>
  27.    </xs:element>
  28.   </xs:sequence>
  29.   <xs:attribute name="orderid" type="xs:string" use="required"/>
  30.  </xs:complexType>
  31. </xs:element>
  32.  
  33. </xs:schema>

分割 Schema

前面的设计方法非常容易，但当文档很复杂时却难以阅读和维护。

接下来介绍的设计方法基于首先对所有元素和属性的定义，然后再使用 ref 属性来引用它们。

这是用新方法设计的 schema 文件：

  1. <?xml version="1.0" encoding="ISO-8859-1" ?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  3.  
  4. <!-- 简易元素的定义 -->
  5. <xs:element name="orderperson" type="xs:string"/>
  6. <xs:element name="name" type="xs:string"/>
  7. <xs:element name="address" type="xs:string"/>
  8. <xs:element name="city" type="xs:string"/>
  9. <xs:element name="country" type="xs:string"/>
  10. <xs:element name="title" type="xs:string"/>
  11. <xs:element name="note" type="xs:string"/>
  12. <xs:element name="quantity" type="xs:positiveInteger"/>
  13. <xs:element name="price" type="xs:decimal"/>
  14.  
  15. <!-- 属性的定义 -->
  16. <xs:attribute name="orderid" type="xs:string"/>
  17.  
  18. <!-- 复合元素的定义 -->
  19. <xs:element name="shipto">
  20.  <xs:complexType>
  21.   <xs:sequence>
  22.    <xs:element ref="name"/>
  23.    <xs:element ref="address"/>
  24.    <xs:element ref="city"/>
  25.    <xs:element ref="country"/>
  26.   </xs:sequence>
  27.  </xs:complexType>
  28. </xs:element>
  29. <xs:element name="item">
  30.  <xs:complexType>
  31.   <xs:sequence>
  32.    <xs:element ref="title"/>
  33.    <xs:element ref="note" minOccurs="0"/>
  34.    <xs:element ref="quantity"/>
  35.    <xs:element ref="price"/>
  36.   </xs:sequence>
  37.  </xs:complexType>
  38. </xs:element>
  39.  
  40. <xs:element name="shiporder">
  41.  <xs:complexType>
  42.   <xs:sequence>
  43.    <xs:element ref="orderperson"/>
  44.    <xs:element ref="shipto"/>
  45.    <xs:element ref="item" maxOccurs="unbounded"/>
  46.   </xs:sequence>
  47.   <xs:attribute ref="orderid" use="required"/>
  48.  </xs:complexType>
  49. </xs:element>
  50.  
  51. </xs:schema>

使用指定的类型（Named Types）

第三种设计方法定义了类或者类型，这样使我们有能力重复使用元素的定义。具体的方式是：首先对简易元素和复合元素进行命名，然后通过元素的 type 属性来指向它们。

这是利用第三种方法设计的 schema 文件 ("shiporder.xsd")：

  1. <?xml version="1.0" encoding="ISO-8859-1" ?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  3.  
  4. <xs:simpleType name="stringtype">
  5.  <xs:restriction base="xs:string"/>
  6. </xs:simpleType>
  7.  
  8. <xs:simpleType name="inttype">
  9.  <xs:restriction base="xs:positiveInteger"/>
  10. </xs:simpleType>
  11.  
  12. <xs:simpleType name="dectype">
  13.  <xs:restriction base="xs:decimal"/>
  14. </xs:simpleType>
  15.  
  16. <xs:simpleType name="orderidtype">
  17.  <xs:restriction base="xs:string">
  18.   <xs:pattern value="[0-9]{6}"/>
  19.  </xs:restriction>
  20. </xs:simpleType>
  21.  
  22. <xs:complexType name="shiptotype">
  23.  <xs:sequence>
  24.   <xs:element name="name" type="stringtype"/>
  25.   <xs:element name="address" type="stringtype"/>
  26.   <xs:element name="city" type="stringtype"/>
  27.   <xs:element name="country" type="stringtype"/>
  28.  </xs:sequence>
  29. </xs:complexType>
  30.  
  31. <xs:complexType name="itemtype">
  32.  <xs:sequence>
  33.   <xs:element name="title" type="stringtype"/>
  34.   <xs:element name="note" type="stringtype" minOccurs="0"/>
  35.   <xs:element name="quantity" type="inttype"/>
  36.   <xs:element name="price" type="dectype"/>
  37.  </xs:sequence>
  38. </xs:complexType>
  39.  
  40. <xs:complexType name="shipordertype">
  41.  <xs:sequence>
  42.   <xs:element name="orderperson" type="stringtype"/>
  43.   <xs:element name="shipto" type="shiptotype"/>
  44.   <xs:element name="item" maxOccurs="unbounded" type="itemtype"/>
  45.  </xs:sequence>
  46.  <xs:attribute name="orderid" type="orderidtype" use="required"/>
  47. </xs:complexType>
  48.  
  49. <xs:element name="shiporder" type="shipordertype"/>
  50.  
  51. </xs:schema>

restriction 元素显示出数据类型源自于 W3C XML Schema 命名空间的数据类型。因此，下面的片段也就意味着元素或属性的值必须是字符串类型的值：

  1. <xs:restriction base="xs:string">

restriction 元素常被用于向元素施加限制。请看下面这些来自以上 schema 的片段：

  1. <xs:simpleType name="orderidtype">
  2.  <xs:restriction base="xs:string">
  3.   <xs:pattern value="[0-9]{6}"/>
  4.  </xs:restriction>
  5. </xs:simpleType>

这段代码指示出，元素或属性的值必须为字符串，并且必须是连续的六个字符，同时这些字符必须是 0-9 的数字。