用于编译架构的 XmlSchemaSet
介绍 XmlSchemaSet，一个可以存储和验证 XML 架构定义语言 (XSD) 架构的缓存。
XmlSchemaSet 类
XmlSchemaSet 是一个可以存储和验证 XML 架构定义语言 (XSD) 架构的缓存。
在 System.Xml 1.0 版中，XML 架构作为架构库加载到 XmlSchemaCollection 类中。在 System.Xml 2.0 版中，XmlValidatingReader 和 XmlSchemaCollection 类已过时，分别由 Create 方法和 XmlSchemaSet 类所取代。
引入了 XmlSchemaSet 来解决许多问题，包括标准兼容性、性能和过时的 Microsoft XML 数据简化 (XDR) 架构格式。
以下是 XmlSchemaCollection 类和 XmlSchemaSet 类之间的比较。
XmlSchemaCollection |
XmlSchemaSet |
|---|---|
支持 Microsoft XDR 和 W3C XML 架构。 |
只支持 W3C XML 架构。 |
架构在调用 Add 方法时编译。 |
架构在调用 Add 方法时不编译。这样可以提高创建架构库时的性能。 |
每个架构都会生成单独编译的版本，这就会产生各个“架构岛”。因此，所有包含和导入仅在该架构中有效。 |
已编译的架构生成单个逻辑架构，即一个架构“集”。添加到该架构集的架构内的任何导入架构将直接添加到架构集中。这意味着所有类型可以供所有架构使用。 |
特定目标命名空间在集合中只能存在一个架构。 |
只要不存在类型冲突，就可以为同一目标命名空间添加多个架构。 |
迁移到 XmlSchemaSet
以下代码示例提供从过时的 XmlSchemaCollection 类迁移到新的 XmlSchemaSet 类的指南。该代码示例说明两个类之间的下列主要区别。
与 XmlSchemaCollection 类的 Add 方法不同，在调用 XmlSchemaSet 的 Add 方法时，不编译架构。XmlSchemaSet 的 Compile 方法在示例代码中显式调用。
要循环访问 XmlSchemaSet，必须使用 XmlSchemaSet 的 Schemas 属性。
以下是过时的 XmlSchemaCollection 代码示例。
Dim schemaCollection As XmlSchemaCollection = New XmlSchemaCollection()
schemaCollection.Add("https://www.contoso.com/retail", "https://www.contoso.com/retail.xsd")
schemaCollection.Add("https://www.contoso.com/books", "https://www.contoso.com/books.xsd")
Dim schema As XmlSchema
For Each schema in schemaCollection
Console.WriteLine(schema.TargetNamespace)
Next
XmlSchemaCollection schemaCollection = new XmlSchemaCollection();
schemaCollection.Add("https://www.contoso.com/retail", "https://www.contoso.com/retail.xsd");
schemaCollection.Add("https://www.contoso.com/books", "https://www.contoso.com/books.xsd");
foreach(XmlSchema schema in schemaCollection)
{
Console.WriteLine(schema.TargetNamespace);
}
以下是等效的 XmlSchemaSet 代码示例。
Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()
schemaSet.Add("https://www.contoso.com/retail", "https://www.contoso.com/retail.xsd")
schemaSet.Add("https://www.contoso.com/books", "https://www.contoso.com/books.xsd")
schemaSet.Compile()
Dim schema As XmlSchema
For Each schema in schemaSet.Schemas()
Console.WriteLine(schema.TargetNamespace)
Next
XmlSchemaSet schemaSet = new XmlSchemaSet();
schemaSet.Add("https://www.contoso.com/retail", "https://www.contoso.com/retail.xsd");
schemaSet.Add("https://www.contoso.com/books", "https://www.contoso.com/books.xsd");
schemaSet.Compile();
foreach(XmlSchema schema in schemaSet.Schemas())
{
Console.WriteLine(schema.TargetNamespace);
}
添加和检索架构
架构是使用 XmlSchemaSet 的 Add 方法添加到 XmlSchemaSet 中的。架构添加到 XmlSchemaSet 中后，将与目标命名空间 URI 关联。目标命名空间 URI 可以指定为 Add 方法的参数，如果未指定目标命名空间，XmlSchemaSet 将使用架构中定义的目标命名空间。
架构是使用 XmlSchemaSet 的 Schemas 属性从 XmlSchemaSet 检索的。通过 XmlSchemaSet 的 Schemas 属性，可以循环访问 XmlSchemaSet 中包含的 XmlSchema 对象。Schemas 属性返回 XmlSchemaSet 中包含的所有 XmlSchema 对象，如果给定了目标命名空间参数，则返回属于该目标命名空间的所有 XmlSchema 对象。如果 null 指定为目标命名空间参数，Schemas 属性将返回所有没有命名空间的架构。
以下示例将 https://www.contoso.com/books 命名空间中的 books.xsd 架构添加到 XmlSchemaSet，从 XmlSchemaSet 检索所有属于 https://www.contoso.com/books 命名空间的架构，然后将这些架构写入 Console。
Dim schemaSet As XmlSchemaSet = New XmlSchemaSet
schemaSet.Add("https://www.contoso.com/books", "books.xsd")
Dim schema As XmlSchema
For Each schema In schemaSet.Schemas("https://www.contoso.com/books")
schema.Write(Console.Out)
Next
XmlSchemaSet schemaSet = new XmlSchemaSet();
schemaSet.Add("https://www.contoso.com/books", "books.xsd");
foreach (XmlSchema schema in schemaSet.Schemas("https://www.contoso.com/books"))
{
schema.Write(Console.Out);
}
有关在 XmlSchemaSet 对象中添加和检索架构的更多信息，请参见 Add 方法和 Schemas 属性的参考文档。
编译架构
XmlSchemaSet 中的架构通过 XmlSchemaSet 的 Compile 方法编译为一个逻辑架构。
.gif "注意") 注意 |
|---|
与过时的 XmlSchemaCollection 类不同，架构在调用 Add 方法时不编译。 |
如果 Compile 方法成功执行，XmlSchemaSet 的 IsCompiled 属性将设置为 true。
| 注意 |
|---|
如果架构在 XmlSchemaSet 中编辑，IsCompiled 属性不受影响。不跟踪对 XmlSchemaSet 中各个架构的更新。因此，只要 XmlSchemaSet 中没有添加或移除任何架构，即使 XmlSchemaSet 中包含的一个架构已更改，IsCompiled 属性也可以为 true。 |
以下示例将 books.xsd 文件添加到 XmlSchemaSet 中，然后调用 Compile 方法。
Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()
schemaSet.Add("https://www.contoso.com/books", "books.xsd")
schemaSet.Compile()
XmlSchemaSet schemaSet = new XmlSchemaSet();
schemaSet.Add("https://www.contoso.com/books", "books.xsd");
schemaSet.Compile();
有关编译 XmlSchemaSet 中的架构的更多信息，请参见 Compile 方法参考文档。
重新处理架构
重新处理 XmlSchemaSet 中的架构时，将执行调用 XmlSchemaSet 的 Add 方法时对架构执行的所有预处理步骤。如果调用 Reprocess 方法成功，XmlSchemaSet 的 IsCompiled 属性将设置为 false。
如果 XmlSchemaSet 中的架构在 XmlSchemaSet 执行编译之后已修改，应使用 Reprocess 方法。
以下示例说明如何使用 Reprocess 方法重新处理添加到 XmlSchemaSet 中的架构。在使用 Compile 方法编译了 XmlSchemaSet 后，并且修改了添加到 XmlSchemaSet 中的架构，即使 XmlSchemaSet 中的架构已修改，IsCompiled 属性仍将设置为 true。调用 Reprocess 方法将执行通过 Add 方法执行的所有预处理步骤，并将 IsCompiled 属性设置为 false。
Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()
Dim schema As XmlSchema = schemaSet.Add("https://www.contoso.com/books", "https://www.contoso.com/books.xsd")
schemaSet.Compile()
Dim element As XmlSchemaElement = New XmlSchemaElement()
schema.Items.Add(element)
element.Name = "book"
element.SchemaTypeName = New XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema")
schemaSet.Reprocess(schema)
XmlSchemaSet schemaSet = new XmlSchemaSet();
XmlSchema schema = schemaSet.Add("https://www.contoso.com/books", "https://www.contoso.com/books.xsd");
schemaSet.Compile();
XmlSchemaElement element = new XmlSchemaElement();
schema.Items.Add(element);
element.Name = "book";
element.SchemaTypeName = new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");
schemaSet.Reprocess(schema);
有关重新处理 XmlSchemaSet 中的架构的更多信息，请参见 Reprocess 方法参考文档。
检查架构
可以使用 XmlSchemaSet 的 Contains 方法检查架构是否包含在 XmlSchemaSet 中。Contains 方法使用目标命名空间或要检查的 XmlSchema 对象。在任何一种情况下，如果架构包含在 XmlSchemaSet 中，Contains 方法将返回 true；否则，将返回 false。
有关检查架构的更多信息，请参见 Contains 方法参考文档。
移除架构
架构使用 XmlSchemaSet 的 Remove 和 RemoveRecursive 方法从 XmlSchemaSet 中移除。Remove 方法将指定架构从 XmlSchemaSet 中移除，而 RemoveRecursive 方法将指定架构及其导入的所有架构从 XmlSchemaSet 中移除。
以下示例说明如何将多个架构添加到 XmlSchemaSet 中，然后使用 RemoveRecursive 方法移除其中一个架构及其导入的所有架构。
Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()
schemaSet.Add("https://www.contoso.com/retail", "https://www.contoso.com/retail.xsd")
schemaSet.Add("https://www.contoso.com/books", "https://www.contoso.com/books.xsd")
schemaSet.Add("https://www.contoso.com/music", "https://www.contoso.com/music.xsd")
Dim schema As XmlSchema
For Each schema In schemaSet.Schemas()
If schema.TargetNamespace = "https://www.contoso.com/music" Then
schemaSet.RemoveRecursive(schema)
End If
Next
XmlSchemaSet schemaSet = new XmlSchemaSet();
schemaSet.Add("https://www.contoso.com/retail", "https://www.contoso.com/retail.xsd");
schemaSet.Add("https://www.contoso.com/books", "https://www.contoso.com/books.xsd");
schemaSet.Add("https://www.contoso.com/music", "https://www.contoso.com/music.xsd");
foreach (XmlSchema schema in schemaSet.Schemas())
{
if (schema.TargetNamespace == "https://www.contoso.com/music")
{
schemaSet.RemoveRecursive(schema);
}
}
有关移除 XmlSchemaSet 中的架构的更多信息，请参见 Remove 和 RemoveRecursive 方法的参考文档。
架构解析和 xs:import
下列示例说明 XmlSchemaSet 中存在给定命名空间的多个架构时，用于导入架构的 XmlSchemaSet 行为。
例如，考虑包含 https://www.contoso.com 命名空间的多个架构的 XmlSchemaSet。具有以下 xs:import 指令的架构添加到 XmlSchemaSet 中。
<xs:import namespace="https://www.contoso.com" schemaLocation="https://www.contoso.com/schema.xsd" />
XmlSchemaSet 尝试导入 https://www.contoso.com 命名空间的架构，方法是从 https://www.contoso.com/schema.xsd URL 加载该架构。只有架构文档中声明的架构声明和类型可以在导入架构中使用，即使 XmlSchemaSet 中存在 https://www.contoso.com 命名空间的其他架构文档。如果 schema.xsd 文件不能位于 https://www.contoso.com/schema.xsd URL，则不会有任何 https://www.contoso.com 命名空间的架构导入到导入架构中。
验证 XML 文档
XML 文档可以针对 XmlSchemaSet 中的架构进行验证。要验证 XML 文档，可以通过下列方式：将架构添加到 XmlReaderSettings 对象的 XmlSchemaSetSchemas 属性中，或将 XmlSchemaSet 添加到 XmlReaderSettings 对象的 Schemas 属性中。然后，XmlReader 类的 Create 方法使用 XmlReaderSettings 对象创建一个 XmlReader 对象并验证该 XML 文档。
有关使用 XmlSchemaSet 验证 XML 文档的更多信息，请参见使用 XmlSchemaSet 进行 XML 架构 (XSD) 验证。