Проверка XML на XSD со ссылкой в ​​C #

161

У меня есть файл XML с указанным расположением схемы, например:

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

Я хочу проверить в C #. Visual Studio, когда я открываю файл, проверяет его на соответствие схеме и выдает список ошибок. Однако почему-то я не могу проверить его автоматически в C #, не указав схему для проверки следующим образом:

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

Должен ли я иметь возможность автоматически проверять схему, указанную в файле XML? Чего мне не хватает?

jfclavette
источник
1
Направить образец MSDN: msdn.microsoft.com/en-us/library/...

Ответы:

167

Вам необходимо создать экземпляр XmlReaderSettings и передать его своему XmlReader при его создании. Затем вы можете подписаться на ValidationEventHandlerв настройках, чтобы получать ошибки проверки. Ваш код будет выглядеть так:

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 хотя следует обновить, чтобы использовать usingпредложение для полноты :)
IAbstract
55
Если вы хотите сравнить файл XSD, добавьте в приведенный выше код следующую строку: settings.Schemas.Add ("YourDomainHere", "yourXSDFile.xsd");
Джефф Фол
5
Чтобы получить строку # и позицию # ошибки, просто используйте: args.Exception.LineNumber ... в ValidationCallBack
user610064
1
Что если у моей схемы нет пространства имен?
дерево
1
Использование лямбды , лучше ИМХО, больше ясности кода settings.ValidationEventHandler += (o, args) => { errors = true; // More code };
Kiquenet
107

Более простой способ, если вы используете .NET 3.5, это использование XDocumentи XmlSchemaSetпроверка.

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

См. Документацию MSDN для получения дополнительной помощи.

saluce
источник
2
Этот метод требует, чтобы вы знали схему заранее, а не извлекали встроенную схему из xml.
Lankymart
это работает нормально, но выдает ошибку, когда XML-документ содержит некоторый HTML-тег, такой как <catalog> my <i> new </ i> catalog .... </ catalog>, в приведенном выше случае HTML-теги, такие как <i>, создают проблему как это значение "<каталог>" ... как это проверить
Анил Пурсвани
6
@AnilPurswani: Если вы хотите поместить HTML в документ XML, вам нужно обернуть его в CDATA. <catalog><![CDATA[my <i> new </i> catalog....]]></catalog>это правильный способ сделать это.
p0lar_bear
Просто и элегантно! Это очень хорошо работает при проверке по фиксированному набору схем (как в нашем случае, и большому с несколькими папками и файлами). Я уже думаю о кэшировании набора XmlSchemaSet для повторного использования между вызовами для Валидатора. Большое спасибо!
Адаил Ретамал
20

В следующем примере проверяется файл XML и генерируется соответствующая ошибка или предупреждение.

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

    }
}

В предыдущем примере используются следующие входные файлы.

<?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
источник
18

лично я одобряю проверку без обратного вызова:

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

(см. сообщение Timiz0r в Синхронной проверке XML-схемы? .NET 3.5 )

FrankyHollywood
источник
9
Обратный вызов предоставляет вам некоторую дополнительную информацию о том, какая строка в вашем XML не является правильной. Этот метод очень бинарный, правильный или неправильный :)
FrankyHollywood
13

Я должен был сделать этот вид автоматической проверки в VB, и вот как я это сделал (преобразован в C #):

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

Тогда я подписался на settings.ValidationEventHandlerсобытие, читая файл.

Welbog
источник