XmlSchemaSet Clase

Definición

public ref class XmlSchemaSet

public class XmlSchemaSet

type XmlSchemaSet = class

Public Class XmlSchemaSet

Herencia

Object

XmlSchemaSet

Ejemplos

En el ejemplo siguiente se valida un archivo XML mediante esquemas almacenados en .XmlSchemaSet El espacio de nombres del archivo XML, urn:bookstore-schema, identifica el esquema que va a usarse en XmlSchemaSet para la validación. La salida del ejemplo muestra que el archivo XML tiene dos infracciones de esquema:

• El primer <book> elemento contiene un <author> elemento pero no un <title> elemento o un <price> elemento.

• El elemento <author> en el último elemento <book> carece de un elemento <first-name> y un <last-name>, y en su lugar tiene un <name> elemento no válido.

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'.

Input

En el ejemplo se usan los dos archivos de entrada siguientes.

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:

<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>

Comentarios

XmlSchemaSet es una memoria caché o biblioteca donde puede almacenar esquemas del lenguaje de definición de esquemas XML (XSD). XmlSchemaSet mejora el rendimiento mediante el almacenamiento en caché de esquemas en la memoria en lugar de acceder a ellos desde un archivo o una dirección URL. Cada esquema se identifica mediante el URI del espacio de nombres y la ubicación que se especificó cuando se agregó el esquema al conjunto. Use la XmlReaderSettings.Schemas propiedad para asignar el objeto que XmlSchemaSet un lector XML debe usar para la validación de datos.

Consideraciones de seguridad

• No use esquemas de orígenes desconocidos o que no sean de confianza. Si lo hace, se pondrá en peligro la seguridad del código. Los espacios de nombres o las ubicaciones externas a los que se hace referencia en los elementos include, import y redefine de un esquema se resuelven con respecto al URI base del esquema que los incluye o importa. Por ejemplo, si el URI base del esquema de inclusión o importación está vacío o null, las ubicaciones externas se resuelven con respecto al directorio actual. La XmlUrlResolver clase se usa para resolver esquemas externos de forma predeterminada. Para deshabilitar la resolución de elementos de inclusión, importación y redefinición de un esquema, establezca la propiedad XmlSchemaSet.XmlResolver en null.

• La XmlSchemaSet clase usa la System.Text.RegularExpressions.Regex clase para analizar y buscar coincidencias con expresiones regulares en un esquema XML. La validación de facetas de patrón con expresiones regulares en un esquema XML puede implicar un mayor uso de CPU y debe evitarse en escenarios de alta disponibilidad.

• Las excepciones generadas como resultado del uso de la XmlSchemaSet clase , como la XmlSchemaException clase , pueden contener información confidencial que no se debe exponer en escenarios que no son de confianza. Por ejemplo, la propiedad SourceUri de un XmlSchemaException devuelve la ruta de acceso del URI al archivo de esquema que provocó la excepción. La propiedad SourceUri no se debe exponer en escenarios que no sean de confianza. Las excepciones deben controlarse correctamente para que esta información confidencial no se exponga en escenarios que no son de confianza.