Premiers pas avec la validation XSD avec .NET

Question

Voici ma première tentative de validation de XML avec XSD.

Le fichier XML à valider:

<?xml version="1.0" encoding="utf-8" ?> 
<config xmlns="Schemas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="config.xsd"> 
    <levelVariant> 
    <filePath>SampleVariant</filePath> 
    </levelVariant> 
    <levelVariant> 
    <filePath>LegendaryMode</filePath> 
    </levelVariant> 
    <levelVariant> 
    <filePath>AmazingMode</filePath> 
    </levelVariant> 
</config> 

Le XSD, situé dans "schemas/config.xsd" par rapport au fichier XML à valider:

<?xml version="1.0" encoding="utf-8" ?> 
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> 
    <xs:element name="config"> 
    <xs:complexType> 
     <xs:sequence> 
     <xs:element name="levelVariant"> 
      <xs:complexType> 
      <xs:sequence> 
       <xs:element name="filePath" type="xs:anyURI"> 
       </xs:element> 
      </xs:sequence> 
      </xs:complexType> 
     </xs:element> 
     </xs:sequence> 
    </xs:complexType> 
    </xs:element> 
</xs:schema> 

En ce moment, je je veux juste valider le fichier XML précisément tel qu'il apparaît actuellement. Une fois que je comprendrai mieux, je développerai plus. Ai-je vraiment besoin de tant de lignes pour quelque chose d'aussi simple que le fichier XML tel qu'il existe actuellement?

Le code de validation en C#:

 public void SetURI(string uri) 
     { 
      XElement toValidate = XElement.Load(Path.Combine(PATH_TO_DATA_DIR, uri) + ".xml"); 

// begin confusion 

     // exception here 
     string schemaURI = toValidate.Attributes("xmlns").First().ToString() 
           + toValidate.Attributes("xsi:noNamespaceSchemaLocation").First().ToString(); 
     XmlSchemaSet schemas = new XmlSchemaSet(); 
     schemas.Add(null, schemaURI); 

     XDocument toValidateDoc = new XDocument(toValidate); 
     toValidateDoc.Validate(schemas, null); 
// end confusion 

      root = toValidate; 
     } 

Exécution du code ci-dessus donne cette exception:

The ':' character, hexadecimal value 0x3A, cannot be included in a name. 

Toute illumination serait appréciée.

Answer 1

Plutôt que d'utiliser la méthode d'extension XDocument.Validate, j'utiliserais un XmlReader qui peut être configuré pour traiter un schéma en ligne via XmlReaderSettings. Vous pourriez faire quelque chose comme le code suivant.

public void VerifyXmlFile(string path) 
{ 
    // configure the xmlreader validation to use inline schema. 
    XmlReaderSettings config = new XmlReaderSettings(); 
    config.ValidationType = ValidationType.Schema; 
    config.ValidationFlags |= XmlSchemaValidationFlags.ReportValidationWarnings; 
    config.ValidationFlags |= XmlSchemaValidationFlags.ProcessInlineSchema; 
    config.ValidationFlags |= XmlSchemaValidationFlags.ProcessSchemaLocation; 
    config.ValidationEventHandler += new ValidationEventHandler(ValidationCallBack); 

    // Get the XmlReader object with the configured settings. 
    XmlReader reader = XmlReader.Create(path, config); 

    // Parsing the file will cause the validation to occur. 
    while (reader.Read()) ; 

} 

private void ValidationCallBack(object sender, ValidationEventArgs vea) 
{ 
    if (vea.Severity == XmlSeverityType.Warning) 
     Console.WriteLine(
      "\tWarning: Matching schema not found. No validation occurred. {0}", 
      vea.Message); 
    else 
     Console.WriteLine("\tValidation error: {0}", vea.Message); 

} 

Le code ci-dessus suppose les instructions d'utilisation suivantes.

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

Juste pour garder ce simple, je ne suis pas retourné un boolean ou une collection d'erreurs de validation, vous pouvez facilement modifier ce faire.

Remarque: J'ai modifié vos fichiers config.xml et config.xsd pour les valider. Ce sont les changements que j'ai faits.

config.xsd:

<xs:element maxOccurs="unbounded" name="levelVariant"> 

config.xml:

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="config.xsd"> 

Answer 2

Votre code pour extraire l'emplacement du schéma semble étrange. Pourquoi obtenez-vous la valeur de l'attribut xmlns et concattez-le avec la valeur de l'attribut xsi: noNamespaceSchemaLocation? L'exception est provoquée par le fait que vous ne pouvez pas spécifier un préfixe dans un appel aux attributs; vous devez spécifier le XNamespace désiré.

Essayez ceci (non testé):

// Load document 
XDocument doc = XDocument.Load("file.xml"); 

// Extract value of xsi:noNamespaceSchemaLocation 
XNamespace xsi = "http://www.w3.org/2001/XMLSchema-instance"; 
string schemaURI = (string)doc.Root.Attribute(xsi + "noNamespaceSchemaLocation"); 

// Create schema set 
XmlSchemaSet schemas = new XmlSchemaSet(); 
schemas.Add("Schemas", schemaURI); 

// Validate 
doc.Validate(schemas, (o, e) => 
         { 
          Console.WriteLine("{0}", e.Message); 
         }); 

Answer 3

Après est hors d'un échantillon de travail:

Utilisation:

XMLValidator val = new XMLValidator(); 
if (!val.IsValidXml(File.ReadAllText(@"d:\Test2.xml"), @"D:\Test2.xsd")) 
    MessageBox.Show(val.Errors); 

Classe:

public class CXmlValidator 
{ 
    private int nErrors = 0; 
    private string strErrorMsg = string.Empty; 
    public string Errors { get { return strErrorMsg; } } 
    public void ValidationHandler(object sender, ValidationEventArgs args) 
    { 
     nErrors++; 
     strErrorMsg = strErrorMsg + args.Message + "\r\n"; 
    } 

    public bool IsValidXml(string strXml/*xml in text*/, string strXsdLocation /*Xsd location*/) 
    { 
     bool bStatus = false; 
     try 
     { 
      // Declare local objects 
      XmlTextReader xtrReader = new XmlTextReader(strXsdLocation); 
      XmlSchemaCollection xcSchemaCollection = new XmlSchemaCollection(); 
      xcSchemaCollection.Add(null/*add your namespace string*/, xtrReader);//Add multiple schemas if you want. 

      XmlValidatingReader vrValidator = new XmlValidatingReader(strXml, XmlNodeType.Document, null); 
      vrValidator.Schemas.Add(xcSchemaCollection); 

      // Add validation event handler 
      vrValidator.ValidationType = ValidationType.Schema; 
      vrValidator.ValidationEventHandler += new ValidationEventHandler(ValidationHandler); 

      //Actual validation, read conforming the schema. 
      while (vrValidator.Read()) ; 

      vrValidator.Close();//Cleanup 

      //Exception if error. 
      if (nErrors > 0) { throw new Exception(strErrorMsg); } 
      else { bStatus = true; }//Success 
     } 
     catch (Exception error) { bStatus = false; } 

     return bStatus; 
    } 
} 

Le code ci-dessus valide xml (code3) en fonction de xsd (code4). En validant contre xml/xsd, je reçois des erreurs différentes de la vôtre; Je pense que cela peut vous aider à continuer (ajouter/supprimer des éléments XML) à partir d'ici:

Errors http://www.freeimagehosting.net/uploads/01a570ce8b.jpg

Vous pouvez également essayer le processus inverse; essayez de générer le schéma à partir de votre fichier XML et comparez avec votre xsd réel - voir la différence; et la façon la plus simple de le faire est d'utiliser le schéma généré avec l'IDE VS. Voici comment vous le faire:

Create XSD from XML http://i44.tinypic.com/15yhto3.jpg

Hope this helps.

--EDIT--

Ceci est à la demande de John, s'il vous plaît voir le code mis à jour en utilisant des méthodes non dépréciées:

public bool IsValidXmlEx(string strXmlLocation, string strXsdLocation) 
{ 
    bool bStatus = false; 
    try 
    { 
     // Declare local objects 
     XmlReaderSettings rs = new XmlReaderSettings(); 
     rs.ValidationType = ValidationType.Schema; 
     rs.ValidationFlags |= XmlSchemaValidationFlags.ProcessSchemaLocation | XmlSchemaValidationFlags.ReportValidationWarnings; 
     rs.ValidationEventHandler += new ValidationEventHandler(rs_ValidationEventHandler); 
     rs.Schemas.Add(null, XmlReader.Create(strXsdLocation)); 

     using (XmlReader xmlValidatingReader = XmlReader.Create(strXmlLocation, rs)) 
     { while (xmlValidatingReader.Read()) { } } 

     ////Exception if error. 
     if (nErrors > 0) { throw new Exception(strErrorMsg); } 
     else { bStatus = true; }//Success 
    } 
    catch (Exception error) { bStatus = false; } 

    return bStatus; 
} 

void rs_ValidationEventHandler(object sender, ValidationEventArgs e) 
{ 
    if (e.Severity == XmlSeverityType.Warning) strErrorMsg += "WARNING: " + Environment.NewLine; 
    else strErrorMsg += "ERROR: " + Environment.NewLine; 
    nErrors++; 
    strErrorMsg = strErrorMsg + e.Exception.Message + "\r\n"; 
} 

Utilisation:

if (!val.IsValidXmlEx(@"d:\Test2.xml", @"D:\Test2.xsd")) 
       MessageBox.Show(val.Errors); 
      else 
       MessageBox.Show("Success"); 

Test2 .XML

<?xml version="1.0" encoding="utf-8" ?> 
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Test2.xsd"> 
    <levelVariant> 
    <filePath>SampleVariant</filePath> 
    </levelVariant> 
    <levelVariant> 
    <filePath>LegendaryMode</filePath> 
    </levelVariant> 
    <levelVariant> 
    <filePath>AmazingMode</filePath> 
    </levelVariant> 
</config> 

Test2.XSD (généré à partir de VS IDE)

<?xml version="1.0" encoding="utf-8" ?> 
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> 
    <xs:element name="config"> 
    <xs:complexType> 
     <xs:sequence> 
     <xs:element maxOccurs="unbounded" name="levelVariant"> 
      <xs:complexType> 
      <xs:sequence> 
       <xs:element name="filePath" type="xs:anyURI"> 
       </xs:element> 
      </xs:sequence> 
      </xs:complexType> 
     </xs:element> 
     </xs:sequence> 
    </xs:complexType> 
    </xs:element> 
</xs:schema> 

Ceci est garanti pour travailler!