Sprawdzanie poprawności kodu XML względem przywoływanego XSD w C #


161

Mam plik XML z określoną lokalizacją schematu, taką jak ta:

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

Chcę sprawdzić poprawność w C #. Visual Studio, kiedy otwieram plik, sprawdza go w odniesieniu do schematu i doskonale wyświetla listę błędów. Jednak w jakiś sposób nie mogę zweryfikować go automatycznie w C # bez określenia schematu do walidacji w następujący sposób:

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

Czy nie powinienem być w stanie automatycznie zweryfikować za pomocą schematu określonego w pliku XML? Czego mi brakuje ?


1
Zapoznaj się z przykładem MSDN: msdn.microsoft.com/en-us/library/ ...

Odpowiedzi:


167

Musisz utworzyć wystąpienie XmlReaderSettings i przekazać je do XmlReader podczas jego tworzenia. Następnie możesz zapisać się ValidationEventHandlerw ustawieniach, aby otrzymywać błędy walidacji. Twój kod będzie wyglądał tak:

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

    }
}

4
+1 chociaż należy zaktualizować, aby użyć usingklauzuli dla kompletności :)
IAbstract

55
Jeśli chcesz porównać z plikiem XSD, dodaj następujący wiersz do powyższego kodu: settings.Schemas.Add ("YourDomainHere", "yourXSDFile.xsd");
Jeff Fol,

5
Aby uzyskać numer wiersza i pozycję # błędu, po prostu użyj: args.Exception.LineNumber ... w ValidationCallBack
user610064

1
A jeśli schemat, który mam, nie ma przestrzeni nazw?
drzewo

1
Używając lambdy , lepszego IMHO, bardziej przejrzystego kodu settings.ValidationEventHandler += (o, args) => { errors = true; // More code };
Kiquenet

107

Prostszym sposobem, jeśli używasz .NET 3.5, jest użycie XDocumenti XmlSchemaSetwalidacja.

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

Więcej pomocy można znaleźć w dokumentacji MSDN .


2
Ta metoda wymaga wcześniejszej znajomości schematu, a nie pobierania schematu wbudowanego z xml.
Lankymart

to działa dobrze, ale generuje błąd, gdy dokument xml zawiera jakiś tag html, taki jak <catalog> mój <i> nowy </i> katalog .... </catalog> w powyższym przypadku tagi html, takie jak „<i>” tworzą problem, ponieważ to jest wartość „<catalog>” ... jak to sprawdzić
Anil Purswani,

6
@AnilPurswani: Jeśli chcesz umieścić HTML w dokumencie XML, musisz go opakować w CDATA. <catalog><![CDATA[my <i> new </i> catalog....]]></catalog>jest właściwym sposobem, aby to zrobić.
p0lar_bear

Prosty i elegancki! Działa to bardzo dobrze podczas sprawdzania poprawności względem stałego zestawu schematów (co jest naszym przypadkiem i dużym z wieloma folderami i plikami). Już myślę o buforowaniu zestawu XmlSchemaSet do ponownego użycia między wywołaniami walidatora. Wielkie dzięki!
Adail Retamal

20

Poniższy przykład sprawdza poprawność pliku XML i generuje odpowiedni błąd lub ostrzeżenie.

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

    }
}

W poprzednim przykładzie zastosowano następujące pliki wejściowe.

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

18

osobiście wolę walidację bez oddzwonienia:

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

(zobacz post Timiz0r w Synchronous XML Schema Validation? .NET 3.5 )


9
Wywołanie zwrotne dostarcza dodatkowych informacji o tym, który wiersz w Twoim xml jest nieprawidłowy. Ta metoda jest bardzo binarna, dobra lub zła :)
FrankyHollywood

13

Miałem taki rodzaj automatycznej walidacji w VB i tak to zrobiłem (przekonwertowałem na C #):

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

Następnie zapisałem się na settings.ValidationEventHandlerwydarzenie podczas czytania pliku.

Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.