技巧: 使用 XML Schema Standard Type Library 简化开发
使用模式定义简化例程验证
XML 验证让您能够创建复杂规则以定义可接受的数据。但是如果您不使用这些规则,那么它们就毫无用处。在本文中,您将学习使用 XML Schema Standard Type Library 简化获取格式化数据(如电子邮件地址和电话号码)的过程。
本文假定您熟悉 XML 并至少对 XML Schema 有一定程度的了解。文中的示例将使用 XForms,但不强制要求了解 XForms。(如果您想要运行示例,可下载针对 Firefox 的 XForms 扩展。 )
验证 XML 或确保满足基于类型的某些限制是语言自身所固有的能力;Document Type Definitions 是 XML 规范的一部分。不久之后,对更高灵活性和更强功能的需求逐渐明显,从而产生了 XML Schema。XML Schema 使您能够创建具有很多特殊指定的定义。您可以指定元素必须包含特定数量的附加元素,或属性必须包含 datetime 值,文本符合某种模式,或任何其他结构。
例如,考虑以下 XForms 表单(参见清单 1)。
清单 1. 基本表单
<?xml version="1.0"?>
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:xforms="http://www.w3.org/2002/xforms"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<head>
<title>Contact Form</title>
<xforms:model>
<xforms:instance id="content">
<contact xmlns="">
<name />
<email />
<phone />
</contact>
</xforms:instance>
<xforms:submission id="submitContact" method="post"
action="." />
</xforms:model>
<link href="gen_default.css" rel="stylesheet"/>
</head>
<body>
<h1 align="center">Contact information</h1>
<xforms:input ref="/contact/name">
<xforms:label>Name: </xforms:label>
</xforms:input>
<br />
<xforms:input ref="/contact/email">
<xforms:label>Email: </xforms:label>
</xforms:input>
<br />
<xforms:input ref="/contact/phone">
<xforms:label>Phone: </xforms:label>
</xforms:input>
<br />
<xforms:submit submission="submitContact">
<xforms:label>Submit</xforms:label>
</xforms:submit>
</body>
</html>
此表单很简单,只是查找用户的姓名、电子邮件地址和电话号码,如图 1 所示。
图 1. 表单
在本例中,将电子邮件或电话号码的条目约束为有效的电子邮件或电话号码 — 或者至少将其约束为正确的形式,都会有所帮助。为此,您需要向文档添加模式(见清单 2)。
清单 2. 添加模式
...
<xforms:model>
<xsd:element name="contact">
<xsd:complexType>
<xsd:element name="name" xsd:type="xsd:string" />
<xsd:element name="email" />
<xsd:element name="phone" />
</xsd:complexType>
</xsd:element>
</xsd:schema>
<xforms:instance id="content">
<contact xmlns="">
<name />
<email />
<phone />
</contact>
</xforms:instance>
...
然后您可以添加事件,用以在条目无效时告知用户(见 源代码 中的使用方法)。
注意,此时电子邮件和电话号码定义没有附带类型。原因是大多数程序员都不愿意卷入检查类型的麻烦。电子邮件地址有多种格式,但是有一种标准格式。同样,电话号码的形式也花样繁多,如 “带区号”、“不带区号”、“带分机号” 等等,并且这还不包括国家区号。
谁愿意去做所有的这些工作?反正我不愿意。所幸的是,存在电话号码或电子邮件地址的常见类型库。您可以从 http://www.codesynthesis.com/projects/xsstl/ 下载 XML schema standard type library。导入正确的名称空间和文档即可将该库添加到模式中(见清单 3)。
清单 3. 导入模式定义
<?xml version="1.0"?>
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:ev="http://www.w3.org/2001/xml-events"
xmlns:xforms="http://www.w3.org/2002/xforms"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:stl="http://www.codesynthesis.com/xmlns/xsstl">
<head>
<title>Contact Form</title>
<xforms:model>
<xsd:schema targetNamespace=""
xmlns:stl="http://www.codesynthesis.com/xmlns/xsstl">
<xsd:import
namespace="http://www.codesynthesis.com/xmlns/xsstl"
schemaLocation="xsstl.xsd"/>
<xsd:element name="contact">
<xsd:complexType>
<xsd:element name="name" xsd:type="xsd:string" />
<xsd:element name="email" xsd:type="stl:EmailAddress" />
<xsd:element name="phone" xsd:type="stl:PhoneNumber" />
</xsd:complexType>
</xsd:element>
</xsd:schema>
<xforms:instance id="content">
<contact xmlns="">
<name />
<email />
<phone />
</contact>
</xforms:instance>
<xforms:bind nodeset="/contact/email"
type="stl:EmailAddress"/>
<xforms:bind nodeset="/contact/phone"
type="stl:PhoneNumber"/>
<xforms:submission id="submitContact" method="post"
action="." />
...
此示例中导入了主文档,使所有的类型都可用。但是,您可以只导入实际需要的文档。XML Schema Standard Type Library 包含了几个单一类型的文档: email-address.xsd:EmailAddress 类型约束数据为标准的电子邮件地址。 percentage.xsd:Percentage 类型表示从 0 到 100 之间的数字(包括 0 和 100)。 iso3166-country-code.xsd:ISO3166CountyCode 类型约束数据为两个字母的字符串并且要求其必须为一个实际的 ISO 3166-1 国家区号。 rfc822-date-time.xsd:RFC822DateTime 类型要求数据格式符合 RFC822 的指定要求。 其他文档包含了单一类型的变体: ipv4-address.xsd:此文件包含了一个适当端点的变体,比如 IPv4Address、Port 和 IPv4Endpoint,表示一个适当的 IP 地址(使用 dot 表示法)和一个端口。还包含了 IPv4EndpointStruct,它是一个结构体类型数据而不是单个字符串。 phone-number.xsd:此文档指定电话号码的各个部分 PhoneCountryCode、PhoneAreaCode、PhoneSubscriberNumber 和 PhoneExtensionNumber,以及 PhoneNumber(它是将上述四者全部组合起来的一个字符串并至少需要一个订阅号)和 PhoneNumberStruct(将各个部分分隔到单个元素中的结构体)。 us-state-code.xsd:此文档包含了 “US state” 定义的几个变体,包括 USStateTerritoryCode(包含 50 个州和 9 个美国海外属地)、USStateCode(只针对州和华盛顿特区)、USTerritoryCode(只针对行政区,如美属维尔京群岛,不包含华盛顿特区)、USContinentalStateCode(所有的除夏威夷外的州,外加华盛顿特区)和 USContiguousStateCode(所有除夏威夷和阿拉斯加之外的州,外加华盛顿特区)。 XML Schema Standard Type Library 是创建模块定义以简化开发的一个示例。当您将它们导入到自己的模式中后,您就可以直接使用这些类型而无需亲自定义。