Validando um XML em relação ao XSD referenciado em C #

161

Eu tenho um arquivo XML com um local de esquema especificado, como este:

xsi:schemaLocation="someurl ..\localSchemaPath.xsd"

Eu quero validar em c #. O Visual Studio, quando abro o arquivo, o valida no esquema e lista os erros perfeitamente. De alguma forma, porém, não consigo validá-lo automaticamente em C # sem especificar o esquema a ser validado da seguinte forma:

XmlDocument asset = new XmlDocument();

XmlTextReader schemaReader = new XmlTextReader("relativeSchemaPath");
XmlSchema schema = XmlSchema.Read(schemaReader, SchemaValidationHandler);

asset.Schemas.Add(schema);

asset.Load(filename);
asset.Validate(DocumentValidationHandler);

Não devo validar com o esquema especificado no arquivo XML automaticamente? O que estou perdendo ?

jfclavette
fonte
1
Consulte o exemplo do MSDN: msdn.microsoft.com/en-us/library/…

Respostas:

167

Você precisa criar uma instância XmlReaderSettings e transmiti-la ao seu XmlReader quando a criar. Em seguida, você pode assinar o ValidationEventHandlernas configurações para receber erros de validação. Seu código terminará assim:

using System.Xml;
using System.Xml.Schema;
using System.IO;

public class ValidXSD
{
    public static void Main()
    {

        // Set the validation settings.
        XmlReaderSettings settings = new XmlReaderSettings();
        settings.ValidationType = ValidationType.Schema;
        settings.ValidationFlags |= XmlSchemaValidationFlags.ProcessInlineSchema;
        settings.ValidationFlags |= XmlSchemaValidationFlags.ProcessSchemaLocation;
        settings.ValidationFlags |= XmlSchemaValidationFlags.ReportValidationWarnings;
        settings.ValidationEventHandler += new ValidationEventHandler(ValidationCallBack);

        // Create the XmlReader object.
        XmlReader reader = XmlReader.Create("inlineSchema.xml", settings);

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

    }
    // Display any warnings or errors.
    private static void ValidationCallBack(object sender, ValidationEventArgs args)
    {
        if (args.Severity == XmlSeverityType.Warning)
            Console.WriteLine("\tWarning: Matching schema not found.  No validation occurred." + args.Message);
        else
            Console.WriteLine("\tValidation error: " + args.Message);

    }
}
Chris McMillan
fonte
4
+1 embora deve atualizar a utilizar usingcláusula para a integralidade :)
iAbstract
55
Se você deseja comparar com um arquivo XSD, adicione a seguinte linha ao código acima: settings.Schemas.Add ("YourDomainHere", "yourXSDFile.xsd");
9134 Jeff Fol
5
Para obter a linha # e a posição # do erro, basta usar: args.Exception.LineNumber ... em ValidationCallBack
user610064
1
E se o esquema que eu tenho não tiver um espaço para nome?
tree
1
Usando lambda , melhor IMHO, mais código clareza settings.ValidationEventHandler += (o, args) => { errors = true; // More code };
Kiquenet
107

Uma maneira mais simples, se você estiver usando o .NET 3.5, é usar XDocumente XmlSchemaSetvalidar.

XmlSchemaSet schemas = new XmlSchemaSet();
schemas.Add(schemaNamespace, schemaFileName);

XDocument doc = XDocument.Load(filename);
string msg = "";
doc.Validate(schemas, (o, e) => {
    msg += e.Message + Environment.NewLine;
});
Console.WriteLine(msg == "" ? "Document is valid" : "Document invalid: " + msg);

Consulte a documentação do MSDN para obter mais assistência.

salgar
fonte
2
Esse método requer que você conheça o esquema antecipadamente, em vez de usar o esquema embutido no xml.
Lankymart
isso funciona bem, mas gera erro quando o documento xml contém uma tag html como <catalog> meu <i> novo </i> catálogo .... </catalog>, no caso acima, tags html como "<i>" criam um problema como é o valor de "<catalog>" ... como validá-lo
Anil Purswani
6
@AnilPurswani: Se você deseja inserir HTML em um documento XML, é necessário agrupá-lo no CDATA. <catalog><![CDATA[my <i> new </i> catalog....]]></catalog>é a maneira correta de fazer isso.
P0lar_bear 20/05
Simples e elegante! Isso funciona muito bem ao validar em um conjunto de esquemas fixos (que é o nosso caso, e um grande problema com várias pastas e arquivos). Já estou pensando em colocar em cache o XmlSchemaSet para ser reutilizado entre as chamadas ao Validator. Muito obrigado!
Adail Retamal
20

O exemplo a seguir valida um arquivo XML e gera o erro ou aviso apropriado.

using System;
using System.IO;
using System.Xml;
using System.Xml.Schema;

public class Sample
{

    public static void Main()
    {
        //Load the XmlSchemaSet.
        XmlSchemaSet schemaSet = new XmlSchemaSet();
        schemaSet.Add("urn:bookstore-schema", "books.xsd");

        //Validate the file using the schema stored in the schema set.
        //Any elements belonging to the namespace "urn:cd-schema" generate
        //a warning because there is no schema matching that namespace.
        Validate("store.xml", schemaSet);
        Console.ReadLine();
    }

    private static void Validate(String filename, XmlSchemaSet schemaSet)
    {
        Console.WriteLine();
        Console.WriteLine("\r\nValidating XML file {0}...", filename.ToString());

        XmlSchema compiledSchema = null;

        foreach (XmlSchema schema in schemaSet.Schemas())
        {
            compiledSchema = schema;
        }

        XmlReaderSettings settings = new XmlReaderSettings();
        settings.Schemas.Add(compiledSchema);
        settings.ValidationEventHandler += new ValidationEventHandler(ValidationCallBack);
        settings.ValidationType = ValidationType.Schema;

        //Create the schema validating reader.
        XmlReader vreader = XmlReader.Create(filename, settings);

        while (vreader.Read()) { }

        //Close the reader.
        vreader.Close();
    }

    //Display any warnings or errors.
    private static void ValidationCallBack(object sender, ValidationEventArgs args)
    {
        if (args.Severity == XmlSeverityType.Warning)
            Console.WriteLine("\tWarning: Matching schema not found.  No validation occurred." + args.Message);
        else
            Console.WriteLine("\tValidation error: " + args.Message);

    }
}

O exemplo anterior usa os seguintes arquivos de entrada.

<?xml version='1.0'?>
<bookstore xmlns="urn:bookstore-schema" xmlns:cd="urn:cd-schema">
  <book genre="novel">
    <title>The Confidence Man</title>
    <price>11.99</price>
  </book>
  <cd:cd>
    <title>Americana</title>
    <cd:artist>Offspring</cd:artist>
    <price>16.95</price>
  </cd:cd>
</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>
Soroush
fonte
18

Pessoalmente, sou a favor da validação sem retorno de chamada:

public bool ValidateSchema(string xmlPath, string xsdPath)
{
    XmlDocument xml = new XmlDocument();
    xml.Load(xmlPath);

    xml.Schemas.Add(null, xsdPath);

    try
    {
        xml.Validate(null);
    }
    catch (XmlSchemaValidationException)
    {
        return false;
    }
    return true;
}

(consulte a publicação de Timiz0r em Validação de esquema XML síncrono? .NET 3.5 )

FrankyHollywood
fonte
9
O retorno de chamada fornece algumas informações extras sobre qual linha do seu XML não está correta. Este método é muito binário, seja certo ou errado :)
FrankyHollywood
13

Eu fiz esse tipo de validação automática em VB e foi assim que fiz (convertido em C #):

XmlReaderSettings settings = new XmlReaderSettings();
settings.ValidationType = ValidationType.Schema;
settings.ValidationFlags = settings.ValidationFlags |
                           Schema.XmlSchemaValidationFlags.ProcessSchemaLocation;
XmlReader XMLvalidator = XmlReader.Create(reader, settings);

Então, inscrevi-me no settings.ValidationEventHandlerevento enquanto lia o arquivo.

Welbog
fonte