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

Question

背景:

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

问题:

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

问题:

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

1. 是否可以轻松,可靠地删除内存中的命名空间？
2. 在这些情况下,最佳做法是什么？

我到目前为止的解决方案:

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

示例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>

Answer 1

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

首先,场景:有一个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>

我测试过,"格式错误的XML","根据XSD的输入无效","不正确的命名空间".

引用:

从内存流中读取

尝试避免异常处理检查wellformness

验证XSD,捕获错误

关于内联架构验证的有趣帖子

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

我做了以下测试:

• 测试: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.

参考:

附加多命名空间到的根元素