XmlSchemaSet Classe

Definição

Contém um cache de esquemas XSD (linguagem de definição de esquema XML).Contains a cache of XML Schema definition language (XSD) schemas.

public ref class XmlSchemaSet
public class XmlSchemaSet
type XmlSchemaSet = class
Public Class XmlSchemaSet
Herança
XmlSchemaSet

Exemplos

O exemplo a seguir valida um arquivo XML usando esquemas armazenados no XmlSchemaSet.The following example validates an XML file using schemas stored in the XmlSchemaSet. O namespace no arquivo XML, urn:bookstore-schema, identifica qual esquema no XmlSchemaSet a ser usado para validação.The namespace in the XML file, urn:bookstore-schema, identifies which schema in the XmlSchemaSet to use for validation. A saída do exemplo mostra que o arquivo XML tem duas violações de esquema:Output from the example shows that the XML file has two schema violations:

  • O primeiro <elemento de > de livro <contém um elemento de autor <>, mas <nenhum > de título ou elemento de > de preço.The first <book> element contains an <author> element but no <title> or <price> element.

  • O <elemento autor > no último <> elemento de livro não tem um <primeiro nome > e <o último nome > elemento e, em vez disso, <tem um elemento de > de nome inválido.The <author> element in the last <book> element is missing a <first-name> and <last-name> element and instead has an invalid <name> element.

#using <System.Xml.dll>

using namespace System;
using namespace System::Xml;
using namespace System::Xml::Schema;
using namespace System::IO;

// Display any validation errors.
static void ValidationCallBack( Object^ /*sender*/, ValidationEventArgs^ e )
{
   Console::WriteLine( L"Validation Error:\n   {0}", e->Message );
   Console::WriteLine();
}

int main()
{
   // Create the XmlSchemaSet class.
   XmlSchemaSet^ sc = gcnew XmlSchemaSet;

   // Add the schema to the collection.
   sc->Add( L"urn:bookstore-schema", L"books.xsd" );

   // Set the validation settings.
   XmlReaderSettings^ settings = gcnew XmlReaderSettings;
   settings->ValidationType = ValidationType::Schema;
   settings->Schemas = sc;
   settings->ValidationEventHandler += gcnew ValidationEventHandler(ValidationCallBack);

   // Create the XmlReader object.
   XmlReader^ reader = XmlReader::Create( L"booksSchemaFail.xml", settings );

   // Parse the file. 
   while ( reader->Read() )
      ;

   return 1;
}
// The example displays output like the following:
//   Validation Error: 
//        The element 'book' in namespace 'urn:bookstore-schema' has invalid child element 'author' 
//        in namespace 'urn:bookstore-schema'. List of possible elements expected: 'title' in 
//        namespace 'urn:bookstore-schema'.
//
//    Validation Error: 
//       The element 'author' in namespace 'urn:bookstore-schema' has invalid child element 'name' 
//       in namespace 'urn:bookstore-schema'. List of possible elements expected: 'first-name' in 
//       namespace 'urn:bookstore-schema'.
using System;
using System.Xml;
using System.Xml.Schema;
using System.IO;

public class Sample 
{
  public static void Main() {

    // Create the XmlSchemaSet class.
    XmlSchemaSet sc = new XmlSchemaSet();

    // Add the schema to the collection.
    sc.Add("urn:bookstore-schema", "books.xsd");

    // Set the validation settings.
    XmlReaderSettings settings = new XmlReaderSettings();
    settings.ValidationType = ValidationType.Schema;
    settings.Schemas = sc;
    settings.ValidationEventHandler += ValidationCallBack;
 
    // Create the XmlReader object.
    XmlReader reader = XmlReader.Create("booksSchemaFail.xml", settings);

    // Parse the file. 
    while (reader.Read());
  }

  // Display any validation errors.
  private static void ValidationCallBack(object sender, ValidationEventArgs e) {
    Console.WriteLine($"Validation Error:\n   {e.Message}\n");
  }
}
// The example displays output like the following:
//   Validation Error: 
//        The element 'book' in namespace 'urn:bookstore-schema' has invalid child element 'author' 
//        in namespace 'urn:bookstore-schema'. List of possible elements expected: 'title' in 
//        namespace 'urn:bookstore-schema'.
//
//    Validation Error: 
//       The element 'author' in namespace 'urn:bookstore-schema' has invalid child element 'name' 
//       in namespace 'urn:bookstore-schema'. List of possible elements expected: 'first-name' in 
//       namespace 'urn:bookstore-schema'.
Imports System.Xml
Imports System.Xml.Schema
Imports System.IO

Public Module Sample 
  Public Sub Main() 

    ' Create the XmlSchemaSet class.
    Dim sc as XmlSchemaSet = new XmlSchemaSet()

    ' Add the schema to the collection.
    sc.Add("urn:bookstore-schema", "books.xsd")

    ' Set the validation settings.
    Dim settings as XmlReaderSettings = new XmlReaderSettings()
    settings.ValidationType = ValidationType.Schema
    settings.Schemas = sc
    AddHandler settings.ValidationEventHandler, AddressOf ValidationCallBack
 
    ' Create the XmlReader object.
    Dim reader as XmlReader = XmlReader.Create("booksSchemaFail.xml", settings)

    ' Parse the file. 
    While reader.Read()
    End While
    
  End Sub

  ' Display any validation errors.
  Private Sub ValidationCallBack(sender as object, e as ValidationEventArgs) 
    Console.WriteLine($"Validation Error:{vbCrLf}   {e.Message}")
    Console.WriteLine()
  End Sub
End Module
' The example displays output like the following:
'   Validation Error: 
'        The element 'book' in namespace 'urn:bookstore-schema' has invalid child element 'author' 
'        in namespace 'urn:bookstore-schema'. List of possible elements expected: 'title' in 
'        namespace 'urn:bookstore-schema'.
'
'    Validation Error: 
'       The element 'author' in namespace 'urn:bookstore-schema' has invalid child element 'name' 
'       in namespace 'urn:bookstore-schema'. List of possible elements expected: 'first-name' in 
'       namespace 'urn:bookstore-schema'.

EntradaInput

O exemplo usa os dois arquivos de entrada a seguir.The sample uses the following two input files.

booksSchemaFail.xml:booksSchemaFail.xml:

<?xml version='1.0'?>
<bookstore xmlns="urn:bookstore-schema">
  <book>
    <author>
      <first-name>Benjamin</first-name>
      <last-name>Franklin</last-name>
    </author>
  </book>
  <book genre="novel">
    <title>The Confidence Man</title>
    <author>
      <first-name>Herman</first-name>
      <last-name>Melville</last-name>
    </author>
    <price>11.99</price>
  </book>
  <book genre="philosophy">
    <title>The Gorgias</title>
    <author>
      <name>Plato</name>
    </author>
    <price>9.99</price>
  </book>
</bookstore>

books.xsd:books.xsd:

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns="urn:bookstore-schema"
    elementFormDefault="qualified"
    targetNamespace="urn:bookstore-schema">

 <xsd:element name="bookstore" type="bookstoreType"/>

 <xsd:complexType name="bookstoreType">
  <xsd:sequence maxOccurs="unbounded">
   <xsd:element name="book"  type="bookType"/>
  </xsd:sequence>
 </xsd:complexType>

 <xsd:complexType name="bookType">
  <xsd:sequence>
   <xsd:element name="title" type="xsd:string"/>
   <xsd:element name="author" type="authorName"/>
   <xsd:element name="price"  type="xsd:decimal"/>
  </xsd:sequence>
  <xsd:attribute name="genre" type="xsd:string"/>
 </xsd:complexType>

 <xsd:complexType name="authorName">
  <xsd:sequence>
   <xsd:element name="first-name"  type="xsd:string"/>
   <xsd:element name="last-name" type="xsd:string"/>
  </xsd:sequence>
 </xsd:complexType>

</xsd:schema>

Comentários

Importante

  • Não use esquemas de fontes ou locais desconhecidos ou não confiáveis.Do not use schemas from unknown or untrusted sources or locations. Isso irá comprometer a segurança do seu código.Doing so will compromise the security of your code.
  • Esquemas XML (incluindo esquemas embutidos) são inerentemente vulneráveis a ataques de negação de serviço; Não os aceite em cenários não confiáveis.XML schemas (including inline schemas) are inherently vulnerable to denial of service attacks; do not accept them in untrusted scenarios.
  • Mensagens de erro de validação de esquema e exceções podem expor informações confidenciais sobre o modelo de conteúdo ou caminhos de URI para o arquivo de esquema.Schema validation error messages and exceptions may expose sensitive information about the content model or URI paths to the schema file. Tenha cuidado para não expor essas informações a chamadores não confiáveis.Be careful not to expose this information to untrusted callers.
  • Considerações de segurança adicionais são abordadas na seção "considerações sobre segurança".Additional security considerations are covered in the "Security Considerations" section.

XmlSchemaSeté um cache ou biblioteca em que você pode armazenar esquemas XSD (linguagem de definição de esquema XML).XmlSchemaSet is a cache or library where you can store XML Schema definition language (XSD) schemas. O XmlSchemaSet melhora o desempenho armazenando em cache os esquemas na memória em vez de acessá-lo de um arquivo ou URL.XmlSchemaSet improves performance by caching schemas in memory instead of accessing them from a file or a URL. Cada esquema é identificado pelo URI do namespace e pelo local que foi especificado quando o esquema foi adicionado ao conjunto.Each schema is identified by the namespace URI and location that was specified when the schema was added to the set. Você usa a XmlReaderSettings.Schemas propriedade para atribuir o XmlSchemaSet objeto que um leitor de XML deve usar para validação de dados.You use the XmlReaderSettings.Schemas property to assign the XmlSchemaSet object an XML reader should use for data validation.

Considerações sobre segurançaSecurity Considerations

  • Não use esquemas de fontes desconhecidas ou não confiáveis.Do not use schemas from unknown or untrusted sources. Isso irá comprometer a segurança do seu código.Doing so will compromise the security of your code. Os namespaces externos ou locais referenciados nos elementos include, Import e redefine de um esquema são resolvidos em relação ao URI de base do esquema que os inclui ou importa.External namespaces or locations referenced in include, import, and redefine elements of a schema are resolved with respect to the base URI of the schema that includes or imports them. Por exemplo, se o URI de base do esquema de inclusão ou importação estiver vazio nullou se os locais externos forem resolvidos em relação ao diretório atual.For example, if the base URI of the including or importing schema is empty or null, the external locations are resolved with respect to the current directory. A XmlUrlResolver classe é usada para resolver esquemas externos por padrão.The XmlUrlResolver class is used to resolve external schemas by default. Para desabilitar a resolução dos elementos include, Import e redefine de um esquema, defina a XmlSchemaSet.XmlResolver Propriedade como null.To disable resolution of include, import, and redefine elements of a schema, set the XmlSchemaSet.XmlResolver property to null.

  • A XmlSchemaSet classe usa a System.Text.RegularExpressions.Regex classe para analisar e corresponder expressões regulares em um esquema XML.The XmlSchemaSet class uses the System.Text.RegularExpressions.Regex class to parse and match regular expressions in an XML schema. A validação de facetas de padrão com expressões regulares em um esquema XML pode envolver um aumento no uso da CPU e deve ser evitada em cenários de alta disponibilidade.Validation of pattern facets with regular expressions in an XML schema may involve increased CPU usage and should be avoided in high availability scenarios.

  • As exceções geradas como resultado do uso XmlSchemaSet da classe, como a XmlSchemaException classe, podem conter informações confidenciais que não devem ser expostas em cenários não confiáveis.Exceptions raised as a result of using the XmlSchemaSet class, such as the XmlSchemaException class may contain sensitive information that should not be exposed in untrusted scenarios. Por exemplo, a SourceUri propriedade de um XmlSchemaException retorna o caminho do URI para o arquivo de esquema que causou a exceção.For example, the SourceUri property of an XmlSchemaException returns the URI path to the schema file that caused the exception. A SourceUri propriedade não deve ser exposta em cenários não confiáveis.The SourceUri property should not be exposed in untrusted scenarios. As exceções devem ser manipuladas adequadamente para que essas informações confidenciais não sejam expostas em cenários não confiáveis.Exceptions should be properly handled so that this sensitive information is not exposed in untrusted scenarios.

Construtores

XmlSchemaSet()

Inicializa uma nova instância da classe XmlSchemaSet.Initializes a new instance of the XmlSchemaSet class.

XmlSchemaSet(XmlNameTable)

Inicializa uma nova instância da classe XmlSchemaSet com o XmlNameTable especificado.Initializes a new instance of the XmlSchemaSet class with the specified XmlNameTable.

Propriedades

CompilationSettings

Obtém ou define o XmlSchemaCompilationSettings do XmlSchemaSet.Gets or sets the XmlSchemaCompilationSettings for the XmlSchemaSet.

Count

Obtém o número de esquemas de linguagem de definição de esquema XML (XSD) no XmlSchemaSet.Gets the number of logical XML Schema definition language (XSD) schemas in the XmlSchemaSet.

GlobalAttributes

Obtém todos os atributos globais em todos os esquemas XSD de linguagem de definição de esquema XML no XmlSchemaSet.Gets all the global attributes in all the XML Schema definition language (XSD) schemas in the XmlSchemaSet.

GlobalElements

Obtém todos os elementos globais em todos os esquemas XSD de linguagem de definição de esquema XML no XmlSchemaSet.Gets all the global elements in all the XML Schema definition language (XSD) schemas in the XmlSchemaSet.

GlobalTypes

Obtém todos os tipos complexos e simples globais em todos os esquemas XSD de linguagem de definição de esquema XML no XmlSchemaSet.Gets all of the global simple and complex types in all the XML Schema definition language (XSD) schemas in the XmlSchemaSet.

IsCompiled

Obtém um valor que indica se os esquemas de linguagem de definição de esquema XML (XSD) no XmlSchemaSet foram compilados.Gets a value that indicates whether the XML Schema definition language (XSD) schemas in the XmlSchemaSet have been compiled.

NameTable

Obtém o XmlNameTable padrão usado pelo XmlSchemaSet ao carregar novos esquemas de linguagem de definição de esquema XML (XSD).Gets the default XmlNameTable used by the XmlSchemaSet when loading new XML Schema definition language (XSD) schemas.

XmlResolver

Define o XmlResolver usado para resolver namespaces ou locais referenciados nos elementos de inclusão e importação de um esquema.Sets the XmlResolver used to resolve namespaces or locations referenced in include and import elements of a schema.

Métodos

Add(String, String)

Adiciona o esquema XSD (linguagem de definição de esquema XML) à URL especificada para o XmlSchemaSet.Adds the XML Schema definition language (XSD) schema at the URL specified to the XmlSchemaSet.

Add(String, XmlReader)

Adiciona o esquema XSD (linguagem de definição de esquema XML) contido no XmlReader ao XmlSchemaSet.Adds the XML Schema definition language (XSD) schema contained in the XmlReader to the XmlSchemaSet.

Add(XmlSchema)

Adiciona o XmlSchema especificado ao XmlSchemaSet.Adds the given XmlSchema to the XmlSchemaSet.

Add(XmlSchemaSet)

Adiciona todos os esquemas XSD (linguagem de definição de esquema XML) no XmlSchemaSet determinado para o XmlSchemaSet.Adds all the XML Schema definition language (XSD) schemas in the given XmlSchemaSet to the XmlSchemaSet.

Compile()

Compila os esquemas de XSD (linguagem de definição de esquema XML) adicionados ao XmlSchemaSet em um esquema lógico.Compiles the XML Schema definition language (XSD) schemas added to the XmlSchemaSet into one logical schema.

Contains(String)

Indica se um esquema de linguagem de definição de esquema XML (XSD) com o URI do namespace de destino especificado é o XmlSchemaSet.Indicates whether an XML Schema definition language (XSD) schema with the specified target namespace URI is in the XmlSchemaSet.

Contains(XmlSchema)

Indica se o objeto XmlSchema do esquema de linguagem de definição de esquema XML (XSD) especificado está no XmlSchemaSet.Indicates whether the specified XML Schema definition language (XSD) XmlSchema object is in the XmlSchemaSet.

CopyTo(XmlSchema[], Int32)

Copia todos os objetos XmlSchema do XmlSchemaSet para a matriz fornecida, iniciando no índice especificado.Copies all the XmlSchema objects from the XmlSchemaSet to the given array, starting at the given index.

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
Remove(XmlSchema)

Remove o esquema XSD (linguagem de definição de esquema XML) especificado do XmlSchemaSet.Removes the specified XML Schema definition language (XSD) schema from the XmlSchemaSet.

RemoveRecursive(XmlSchema)

Remove o esquema de linguagem de definição de esquema XML (XSD) especificado e todas as importações de esquema do XmlSchemaSet.Removes the specified XML Schema definition language (XSD) schema and all the schemas it imports from the XmlSchemaSet.

Reprocess(XmlSchema)

Reprocessa um esquema de linguagem de definição de esquema XML (XSD) que já existe no XmlSchemaSet.Reprocesses an XML Schema definition language (XSD) schema that already exists in the XmlSchemaSet.

Schemas()

Retorna uma coleção de todos os esquemas XSD (linguagem de definição de esquema XML) no XmlSchemaSet.Returns a collection of all the XML Schema definition language (XSD) schemas in the XmlSchemaSet.

Schemas(String)

Retorna uma coleção de todos os esquemas de linguagem de definição de esquema XML (XSD) no XmlSchemaSet que pertencem ao namespace fornecido.Returns a collection of all the XML Schema definition language (XSD) schemas in the XmlSchemaSet that belong to the given namespace.

ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Eventos

ValidationEventHandler

Especifica um manipulador de eventos para receber informações sobre erros de validação de esquema XSD (linguagem de definição de esquema XML).Specifies an event handler for receiving information about XML Schema definition language (XSD) schema validation errors.

Aplica-se a