2012-01-04 13 views
12

पृष्ठभूमि के साथ एक्सएमएल मान्य:आपूर्ति नामस्थान की उपेक्षा कर जब XSD

हम एक आवेदन है कि हमारे ग्राहकों को एक पूर्वनिर्धारित में डेटा की आपूर्ति करने की अनुमति देता है का निर्माण कर रहे (। यानी हम नियंत्रित नहीं करते हैं) XML स्वरूप। एक्सएसडी हमें थर्ड पार्टी द्वारा आपूर्ति की जाती है, और हम एक एक्सएमएल फाइल प्राप्त करने की उम्मीद कर रहे हैं जो हमें प्रोसेस करने से पहले स्कीमा सत्यापन पास करती है।

समस्या:

XSD है कि हम एक डिफ़ॉल्ट और लक्ष्य नाम स्थान, जिसका अर्थ है कि एक ग्राहक एक XML फ़ाइल की आपूर्ति करता है, तो उस नाम स्थान शामिल नहीं है शामिल साथ आपूर्ति की जाती है, तो सत्यापन पारित करेंगे । हम स्पष्ट रूप से उन चीजों की आपूर्ति नहीं करना चाहते हैं जो कहते हैं कि वे पास करते हैं लेकिन नहीं करना चाहिए, लेकिन बड़ी चिंता अतिरिक्त जांच के द्रव्यमान के आसपास है कि अगर हमें कोई समाधान नहीं मिल रहा है तो हमें प्रत्येक तत्व पर करने की आवश्यकता होगी एक्सएमएल सत्यापन।

सवाल:

यह संभव आपूर्ति की एक्सएमएल और XSD पर सत्यापन करते हैं और नाम स्थान की अनदेखी करने के नेट मजबूर करने के लिए है। यानी किसी भी तरह से "मान लें" कि नामस्थान संलग्न था।

  1. यह आसानी से, स्मृति में नामस्थान दूर करने के लिए, और मज़बूती से संभव है?
  2. इन स्थितियों में सबसे अच्छा अभ्यास क्या है?

समाधान मैं अब तक है:

  1. XSD हर यह अपडेट हो जाता है से नाम स्थान निकालें (बहुत बार नहीं होना चाहिए इस तथ्य के आसपास नहीं मिलता है कि अगर वे। एक namespace यह अभी भी प्रमाणीकरण में सफल हो जाएगा की आपूर्ति।
  2. XSD से नाम स्थान निकालें, और भेजे एक्सएमएल हर से नाम स्थान पट्टी करने के लिए एक रास्ता खोजने। यह कुछ सरल प्रदर्शन करने के लिए कोड का एक बहुत की तरह लगता है।
  3. डो यह सुनिश्चित करने के लिए कि यह सही नामस्थान है, से पहले एक्सएमएल फ़ाइल पर कुछ पूर्व-योग्यता है। फ़ाइल की सामग्री सही होने पर अमान्य नेमस्पेस के कारण उन्हें विफल करने में गलत लगता है।
  4. एक डुप्लिकेट एक्सएसडी बनाएं जिसमें नामस्थान नहीं है, हालांकि अगर वे गलत नामस्थान या एक अलग नामस्थान प्रदान करते हैं, तो यह अभी भी पास हो जाएगा।

उदाहरण में 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> 
+0

एक्सएमएल नेमस्पेस एक अच्छी बात है, इसे क्यों लड़ें? –

+1

यह ऐसा कुछ है जिसे हम नियंत्रित नहीं कर सकते हैं, मैं यह सुनिश्चित करना चाहता हूं कि ग्राहक सही एक्सएमएल भेज रहे हों, हालांकि, यदि कोई ग्राहक अपने सबमिट किए गए एक्सएमएल में नेमस्पेस घोषणा को याद करता है तो मैं यह कहना चाहूंगा कि हम अभी भी इसे सत्यापित कर सकते हैं। मैं बस इतना कहना नहीं चाहता "तुम गड़बड़ हो जाओ, अब इसे ठीक करो!" (और हाँ मैं बेहतर शब्दों का उपयोग करता हूं, लेकिन आपको विचार मिलता है)। – Martin

उत्तर

6

कोशिश कर रहा है एक ही समस्या को हल करने के लिए। मैं जो सोचता हूं उसके साथ आया वह काफी साफ समाधान है। स्पष्टता के लिए, मैंने इनपुट पैरामीटर पर कुछ सत्यापन को समाप्त कर दिया है।

पहले, परिदृश्य: वहाँ एक वेब सेवा है कि एक फ़ाइल प्राप्त करता है, कि "अच्छी तरह से गठित" होने के लिए एक्सएमएल और एक XSD के विरुद्ध वैध माना जाता है है। बेशक, हम "अच्छी तरह से चतुरता" पर भरोसा नहीं करते हैं और न ही यह एक्सएसडी के खिलाफ मान्य है कि "हम जानते हैं" सही है।

ऐसी वेब सेवा विधि के लिए नीचे दिए गए कोड प्रस्तुत किया है, मुझे लगता है कि यह स्वतः स्पष्ट है।

ब्याज का मुख्य बिंदु सत्यापन हो रही हैं, तो आप लोड करने से पहले नाम स्थान के लिए चेक नहीं करते हैं जिसमें आदेश, आप के बाद जाँच, लेकिन सफाई से है।

मैंने तय कर लिया कि मैं, कुछ अपवाद हैंडलिंग के साथ रह सकता है के रूप में यह अपेक्षा की जाती है कि ज्यादातर फाइलों "अच्छा" हो जाएगा और क्योंकि वह काम कर के ढांचे रास्ता नहीं है (इसलिए मैं यह लड़ाई नहीं होगी)।

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 somthing होता की तरह:

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

मैं परीक्षण किया है, "बुरा प्रारूप एक्सएमएल", "एक्सएसडी के अनुसार अमान्य इनपुट", "गलत नामस्थान"।

संदर्भ:

Read from memorystream

Trying avoid exception handling checking for wellformness

Validating against XSD, catch the errors

Interesting post about inline schema validation


हाय मार्टिन, टिप्पणी sction मेरा उत्तर के लिए बहुत छोटा है, तो मैं इसे यहाँ या दे देंगे, यह नहीं किया जा सकता पूरा जवाब हो सकता है, यह एक साथ में सुधार :)

मैं निम्नलिखित परीक्षण किए गए जाने :

  • टेस्ट: xmlns = "blaa"
  • परिणाम: फ़ाइल को अस्वीकार कर दिया जाता है, गलत नाम स्थान की वजह से।
  • टेस्ट: xmlns = "http://mydomain.com/ns/upload.xsd" और xmlns: एक = "blaa" और तत्वों था फ़ाइल retunrs त्रुटि हुए कहा कि यह है: "एक: someElement"
  • परिणाम "ए: कुछ एलीमेंट" की उम्मीद नहीं है
  • टेस्ट: xmlns = "http://mydomain.com/ns/upload.xsd" और xmlns: a = "blaa" और तत्वों में कुछ आवश्यक विशेषता के साथ "someElement" था
  • परिणाम: फ़ाइल रिटर्न त्रुटि कह रही है कि विशेषता अनुपलब्ध है

रणनीति पीछा किया (जो मैं पसंद करते हैं) थी, अगर घ ocument का पालन नहीं करता है, तो स्वीकार नहीं करते हैं, लेकिन कारण पर कुछ जानकारी दें (उदाहरण के लिए। "गलत नामस्थान")।

यह रणनीति क्या आपने पहले कहा के विपरीत लगता है:

लेकिन, अगर कोई ग्राहक अपनी प्रस्तुत एक्सएमएल में नाम स्थान घोषणा चूक जाता है तो मैं कहना है कि हम अभी भी यह मान्य कर सकते हैं करना चाहते हैं। मैं बस इतना कहना नहीं चाहता "तुम गड़बड़ हो जाओ, अब इसे ठीक करो!"

इस मामले में, ऐसा लगता है कि आप एक्सएमएल में परिभाषित नेमस्पेस को अनदेखा कर सकते हैं। कि आप सही नाम स्थान का सत्यापन छोड़ जाएगा करने के लिए:

... 
    // 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" सेट करें, इस प्रकार मूल तत्व के नामस्थान को प्रतिस्थापित करें।

संदर्भ:

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

+0

क्या आपने इसका नाम एक नामस्थान प्रदान किया है जो आप नहीं जोड़ रहे हैं? और जो भी आप जोड़ते हैं उसके साथ भी। इसके अतिरिक्त, हमारे पास यह मुद्दा था कि यदि वे उपसर्ग (उदा। Xmlns: a = "blah") के साथ नामस्थान प्रदान करते हैं, तो हम इसे ठीक से हटा नहीं सकते और अपना स्वयं का जोड़ नहीं सकते। – Martin

+0

@ मार्टिन मैंने आपकी टिप्पणी का जवाब देने के लिए मेरा जवाब संपादित किया। –

+0

नेमस्पेस चेक को हटाने के साथ समस्या यह है कि सत्यापनकर्ता को सत्यापित करने के लिए कुछ भी नहीं मिलेगा। यदि आप एक नामस्थान जोड़ते हैं और नोड्स में नेमस्पेस उपसर्ग होता है, तो उन्हें सत्यापित नहीं किया जाएगा (मेरे ज्ञान के लिए)। मुझे तत्वों को पुन: सक्रिय करने और उनके उपसर्ग को हटाने के बारे में सोचना होगा ... संभव होना चाहिए ... – Martin

0

एक्सएसडी स्कीमा के पीछे पूरा बिंदु यह है कि यह दृढ़ता से टाइप किए गए एक्सएमएल में अनियमित एक्सएमएल बनाता है।

एक एक्सएमएल प्रकार को नोड-नाम और नामस्थान के संयोजन के रूप में परिभाषित किया जा सकता है।

किसी इरादे के रूप में XSD स्कीमा द्वारा परिभाषित एक्सएमएल प्रकार का उल्लेख नहीं करता बावजूद तो कोई नाम स्थान के साथ एक्सएमएल भेजता है।

एक XML सत्यापन परिप्रेक्ष्य रूप में लंबे समय के रूप में

  1. यह अच्छी तरह से बनाई है एक्सएमएल मान्य है से
  2. निर्दिष्ट के रूप में यह किसी भी टाइप XML परिभाषा को इस बात की पुष्टि द्वारा xmlns विशेषता
+0

तो सबसे अच्छा अभ्यास एक्सएमएल को अस्वीकार करने के लिए कहता है कि सही (या कोई भी) नामस्थान परिभाषा नहीं है। मैं कैसे जांचूंगा कि प्राप्त किया गया एक्सएमएल दृढ़ता से टाइप किया गया है? – Martin

+0

आप यह देखने के लिए नामस्थान और रूट नोड नाम संयोजन देख सकते हैं कि आपको भेजा गया एक्सएमएल सही प्रकार का था या नहीं। –

+0

क्या सी # में ऐसा करने का एक शानदार तरीका है? – Martin

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)); 
} 
संबंधित मुद्दे