使用XSD验证XML时忽略提供的命名空间

时间:2012-01-04 13:44:40

标签: c# xml xsd-validation

背景

我们正在构建一个应用程序,允许我们的客户以预定义(即我们无法控制)的XML格式提供数据。 XSD由第三方提供给我们,我们期望在我们处理它之前收到一个传递模式验证的XML文件。

问题:

我们提供的XSD包括默认和目标命名空间,这意味着如果客户提供的XML文件不包含命名空间,则验证将通过。我们显然不希望他们提供说他们通过但不应该提供的东西,但更大的问题是如果我找不到解决办法,我们将需要对每个元素进行大量的额外检查。 XML验证。

问题:

是否可以强制.NET执行验证并忽略提供的XML和XSD上的命名空间。即以某种方式“假设”命名空间被附加。

  1. 是否可以轻松,可靠地删除内存中的命名空间?
  2. 这些情况下的最佳做法是什么?
  3. 我到目前为止的解决方案:

    1. 每次更新时都会从XSD中删除命名空间(不应经常使用)。 这并没有解决这样一个事实,即如果它们提供命名空间,它仍将通过验证。
    2. 从XSD中删除命名空间,并找到一种方法,每次都从传入的XML中剥离命名空间。这似乎是执行简单操作的很多代码。
    3. 在验证之前对XML文件进行一些预先限定,以确保它具有正确的命名空间。如果文件的内容正确,则由于名称空间无效而导致它们失败似乎是错误的。
    4. 创建一个没有命名空间的重复XSD,但如果它们只提供错误的命名空间或不同的命名空间,那么它仍然会通过。
    5. 示例Xml:

      <?xml version="1.0"?>
      <xsd:schema version='3.09' elementFormDefault='qualified' attributeFormDefault='unqualified' id='blah' targetNamespace='urn:schemas-blah.com:blahExample' xmlns='urn:blah:blahExample' xmlns:xsd='http://www.w3.org/2001/XMLSchema'>
      ...
      </xsd:schema>
      

      使用不同的命名空间

       <?xml version="1.0" encoding="UTF-8" ?> 
      <root xmlns="urn:myCompany.com:blahExample1" attr1="2001-03-03" attr2="google" >
      ...
      </root>
      

      根本没有命名空间。

       <?xml version="1.0" encoding="UTF-8" ?> 
      <root attr1="2001-03-03" attr2="google" >
      ...
      </root>
      

3 个答案:

答案 0 :(得分:6)

试图解决同样的问题。我想出了一个相当干净的解决方案。为清楚起见,我已经对输入参数进行了一些验证。

首先,场景:有一个Web服务接收一个文件,该文件应该是“格式良好”的xml并且对XSD有效。当然,我们不相信“好公”,也不相信XSD对“我们知道”是正确的。

此类Web服务方法的代码如下所示,我认为这是不言自明的。

主要关注点是验证发生的顺序,在加载之前不检查命名空间,之后检查,但干净利落。

我决定接受一些异常处理,因为预计大多数文件都会“好”,因为这是交易的框架方式(所以我不会反对)。

private DataTable xmlErrors;
[WebMethod]
public string Upload(byte[] f, string fileName) {
    string ret = "This will have the response";

    // this is the namespace that we want to use
    string xmlNs = "http://mydomain.com/ns/upload.xsd";

    // you could put a public url of xsd instead of a local file
    string xsdFileName = Server.MapPath("~") + "//" +"shiporder.xsd"; 

    // a simple table to store the eventual errors 
    // (more advanced ways possibly exist)
    xmlErrors = new DataTable("XmlErrors");
    xmlErrors.Columns.Add("Type");
    xmlErrors.Columns.Add("Message");

    try {
        XmlDocument doc = new XmlDocument(); // create a document

        // bind the document, namespace and xsd
        doc.Schemas.Add(xmlNs, xsdFileName); 

        // if we wanted to validate if the XSD has itself XML errors
        // doc.Schemas.ValidationEventHandler += 
        // new ValidationEventHandler(Schemas_ValidationEventHandler);

        // Declare the handler that will run on each error found
        ValidationEventHandler xmlValidator = 
            new ValidationEventHandler(Xml_ValidationEventHandler);

        // load the document 
        // will trhow XML.Exception if document is not "well formed"
        doc.Load(new MemoryStream(f));

        // Check if the required namespace is present
        if (doc.DocumentElement.NamespaceURI == xmlNs) {

            // Validate against xsd 
            // will call Xml_ValidationEventHandler on each error found
            doc.Validate(xmlValidator);

            if (xmlErrors.Rows.Count == 0) {
                ret = "OK";
            } else {
                // return the complete error list, this is just to proove it works
                ret = "File has " + xmlErrors.Rows.Count + " xml errors ";
                ret += "when validated against our XSD.";
            }
        } else {
            ret = "The xml document has incorrect or no namespace.";                
        }
    } catch (XmlException ex) {
        ret = "XML Exception: probably xml not well formed... ";
        ret += "Message = " + ex.Message.ToString();
    } catch (Exception ex) {
        ret = "Exception: probably not XML related... "
        ret += "Message = " + ex.Message.ToString();
    }
    return ret;
}

private void Xml_ValidationEventHandler(object sender, ValidationEventArgs e) {
    xmlErrors.Rows.Add(new object[] { e.Severity, e.Message });
}

现在,xsd会有类似的东西:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="shiporder"
    targetNamespace="http://mydomain.com/ns/upload.xsd"
    elementFormDefault="qualified"
    xmlns="http://mydomain.com/ns/upload.xsd"
    xmlns:mstns="http://mydomain.com/ns/upload.xsd"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
>
    <xs:simpleType name="stringtype">
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
    ...
    </xs:schema>

“好”的XML会是这样的:

<?xml version="1.0" encoding="utf-8" ?>
<shiporder orderid="889923"  xmlns="http://mydomain.com/ns/upload.xsd">
  <orderperson>John Smith</orderperson>
  <shipto>
    <names>Ola Nordmann</names>
    <address>Langgt 23</address>

我测试过,“格式化格式错误”,“根据XSD输入无效”,“错误的命名空间”。

<强>的引用:

Read from memorystream

Trying avoid exception handling checking for wellformness

Validating against XSD, catch the errors

Interesting post about inline schema validation


Martin , 评论部分对我的答案来说太短了,所以我会在这里给出,它可能或不是一个完整的答案,让我们一起改进它:)

我做了以下测试:

  • 测试:xmlns =“blaa”
  • 结果:由于名称空间错误,文件被拒绝。
  • 测试:xmlns =“http://mydomain.com/ns/upload.xsd”和xmlns:a =“blaa”,元素有“a:someElement”
  • 结果:文件重新发送错误,说它不期望“a:someElement”
  • 测试:xmlns =“http://mydomain.com/ns/upload.xsd”和xmlns:a =“blaa”且元素的“someElement”缺少某些必需属性
  • 结果:文件返回错误,指出该属性缺失

策略后面(我更喜欢)是,如果文件不符合,那么不接受,但提供一些信息的原因(例如。“错误的命名空间”)。

这个策略似乎与你之前所说的相反:

  

但是,如果客户在提交的XML中错过了名称空间声明,那么我想说我们仍然可以验证它。我不想只是说“你搞砸了,现在解决它!”

在这种情况下,您似乎可以忽略XML中定义的命名空间。为此,您将跳过正确命名空间的验证:

    ...
    // Don't Check if the required namespace is present
    //if (doc.DocumentElement.NamespaceURI == xmlNs) {

        // Validate against xsd 
        // will call Xml_ValidationEventHandler on each error found
        doc.Validate(xmlValidator);

        if (xmlErrors.Rows.Count == 0) {
            ret = "OK - is valid against our XSD";
        } else {
            // return the complete error list, this is just to proove it works
            ret = "File has " + xmlErrors.Rows.Count + " xml errors ";
            ret += "when validated against our XSD.";
        }
    //} else {
    //    ret = "The xml document has incorrect or no namespace.";                
    //}
    ...


其他想法......

在一个平行的思路中,要用你自己的命名替换提供的命名空间,也许你可以设置doc.DocumentElement.NamespaceURI = "mySpecialNamespace",从而替换根元素的namepsace。

参考

add-multiple-namespaces-to-the-root-element

答案 1 :(得分:0)

XSD架构背后的重点是它将无类型XML转换为强类型XML。

XML类型可以定义为node-name和namespace的组合。

如果有人向您发送没有命名空间的XML,那么尽管有意图,XML也不会引用XSD架构定义的类型。

从XML验证的角度来看,只要

,XML就是有效的
  1. 结构良好
  2. 它确认任何类型的XML定义,由xmlns属性
  3. 指定

答案 2 :(得分:0)

我使用XmlSchemaValidationFlags.ReportValidationWarnings标志。否则,具有未知命名空间(或没有命名空间)的xml将默默地通过验证。

public static void Validate(string xml, string schemaPath)
{
    //oops: no ValidationFlag property, cant use linq
    //var d = XDocument.Parse(xml);
    //var sc = new XmlSchemaSet();
    //sc.Add(null, schemaPath);
    //sc.CompilationSettings.EnableUpaCheck = false;
    //d.Validate(sc, null);

    XmlReaderSettings Xsettings = new XmlReaderSettings();
    Xsettings.Schemas.Add(null, schemaPath);
    Xsettings.ValidationType = ValidationType.Schema;
    Xsettings.ValidationFlags |= XmlSchemaValidationFlags.ReportValidationWarnings;
    Xsettings.Schemas.CompilationSettings.EnableUpaCheck = false;
    Xsettings.ValidationEventHandler += new ValidationEventHandler(ValidationCallBack);

    XmlReader reader = XmlReader.Create(new StringReader(xml), Xsettings);
    while (reader.Read())
    {
    }
}

private static void ValidationCallBack(object sender, ValidationEventArgs e)
{
    if (e.Severity == XmlSeverityType.Warning)
        throw new Exception(string.Format("No validation occurred. {0}", e.Message));
    else
        throw new Exception(string.Format("Validation error: {0}", e.Message));
}