XmlSerializer: अनावश्यक xsi और xsd नामस्थान हटा दें


132

क्या XmlSerializer को कॉन्फ़िगर करने का कोई तरीका है ताकि वह मूल तत्व में डिफ़ॉल्ट नाम स्थान न लिख सके?

मुझे यह मिलता है:

<?xml ...>
<rootelement xmlns:xsi="..." xmlns:xsd="...">
</rootelement>

और मैं दोनों xmlns घोषणाओं को दूर करना चाहता हूं।

की डुप्लिकेट : XML को xmlns के बिना किसी ऑब्जेक्ट को कैसे सीरियल करें = "..."?

जवाबों:


63

चूंकि डेव ने मुझसे .NET में किसी ऑब्जेक्ट को क्रमांकित करने के लिए सभी xsi और xsd नामस्थानों को स्वीकार करने के लिए अपना उत्तर दोहराने के लिए कहा था , इसलिए मैंने इस पोस्ट को अपडेट किया है और यहां दिए गए लिंक से अपना उत्तर दोहराया है। इस उत्तर में प्रयुक्त उदाहरण वही उदाहरण है जिसका उपयोग अन्य प्रश्न के लिए किया जाता है। इस प्रकार नकल की जाती है, शब्दशः।


Microsoft के प्रलेखन और कई समाधानों को ऑनलाइन पढ़ने के बाद, मैंने इस समस्या का हल खोज लिया है। यह बिल्ट-इन XmlSerializerऔर कस्टम XML क्रमांकन दोनों के माध्यम से काम करता है IXmlSerialiazble

सफेद करने के लिए, मैं उसी MyTypeWithNamespacesXML नमूने का उपयोग करूंगा जिसका उपयोग इस प्रश्न के उत्तर में किया गया है।

[XmlRoot("MyTypeWithNamespaces", Namespace="urn:Abracadabra", IsNullable=false)]
public class MyTypeWithNamespaces
{
    // As noted below, per Microsoft's documentation, if the class exposes a public
    // member of type XmlSerializerNamespaces decorated with the 
    // XmlNamespacesDeclarationAttribute, then the XmlSerializer will utilize those
    // namespaces during serialization.
    public MyTypeWithNamespaces( )
    {
        this._namespaces = new XmlSerializerNamespaces(new XmlQualifiedName[] {
            // Don't do this!! Microsoft's documentation explicitly says it's not supported.
            // It doesn't throw any exceptions, but in my testing, it didn't always work.

            // new XmlQualifiedName(string.Empty, string.Empty),  // And don't do this:
            // new XmlQualifiedName("", "")

            // DO THIS:
            new XmlQualifiedName(string.Empty, "urn:Abracadabra") // Default Namespace
            // Add any other namespaces, with prefixes, here.
        });
    }

    // If you have other constructors, make sure to call the default constructor.
    public MyTypeWithNamespaces(string label, int epoch) : this( )
    {
        this._label = label;
        this._epoch = epoch;
    }

    // An element with a declared namespace different than the namespace
    // of the enclosing type.
    [XmlElement(Namespace="urn:Whoohoo")]
    public string Label
    {
        get { return this._label; }
        set { this._label = value; }
    }
    private string _label;

    // An element whose tag will be the same name as the property name.
    // Also, this element will inherit the namespace of the enclosing type.
    public int Epoch
    {
        get { return this._epoch; }
        set { this._epoch = value; }
    }
    private int _epoch;

    // Per Microsoft's documentation, you can add some public member that
    // returns a XmlSerializerNamespaces object. They use a public field,
    // but that's sloppy. So I'll use a private backed-field with a public
    // getter property. Also, per the documentation, for this to work with
    // the XmlSerializer, decorate it with the XmlNamespaceDeclarations
    // attribute.
    [XmlNamespaceDeclarations]
    public XmlSerializerNamespaces Namespaces
    {
        get { return this._namespaces; }
    }
    private XmlSerializerNamespaces _namespaces;
}

यह सब इस वर्ग के लिए है। अब, कुछ ने XmlSerializerNamespacesअपनी कक्षाओं के भीतर कहीं एक वस्तु होने पर आपत्ति जताई ; लेकिन जैसा कि आप देख सकते हैं, मैंने इसे डिफ़ॉल्ट रूप से डिफ़ॉल्ट निर्माणकर्ता में बंद कर दिया और नामस्थानों को वापस करने के लिए सार्वजनिक संपत्ति को उजागर किया।

अब, जब कक्षा को क्रमबद्ध करने का समय आएगा, तो आप निम्नलिखित कोड का उपयोग करेंगे:

MyTypeWithNamespaces myType = new MyTypeWithNamespaces("myLabel", 42);

/******
   OK, I just figured I could do this to make the code shorter, so I commented out the
   below and replaced it with what follows:

// You have to use this constructor in order for the root element to have the right namespaces.
// If you need to do custom serialization of inner objects, you can use a shortened constructor.
XmlSerializer xs = new XmlSerializer(typeof(MyTypeWithNamespaces), new XmlAttributeOverrides(),
    new Type[]{}, new XmlRootAttribute("MyTypeWithNamespaces"), "urn:Abracadabra");

******/
XmlSerializer xs = new XmlSerializer(typeof(MyTypeWithNamespaces),
    new XmlRootAttribute("MyTypeWithNamespaces") { Namespace="urn:Abracadabra" });

// I'll use a MemoryStream as my backing store.
MemoryStream ms = new MemoryStream();

// This is extra! If you want to change the settings for the XmlSerializer, you have to create
// a separate XmlWriterSettings object and use the XmlTextWriter.Create(...) factory method.
// So, in this case, I want to omit the XML declaration.
XmlWriterSettings xws = new XmlWriterSettings();
xws.OmitXmlDeclaration = true;
xws.Encoding = Encoding.UTF8; // This is probably the default
// You could use the XmlWriterSetting to set indenting and new line options, but the
// XmlTextWriter class has a much easier method to accomplish that.

// The factory method returns a XmlWriter, not a XmlTextWriter, so cast it.
XmlTextWriter xtw = (XmlTextWriter)XmlTextWriter.Create(ms, xws);
// Then we can set our indenting options (this is, of course, optional).
xtw.Formatting = Formatting.Indented;

// Now serialize our object.
xs.Serialize(xtw, myType, myType.Namespaces);

एक बार जब आप ऐसा कर लेते हैं, तो आपको निम्न आउटपुट प्राप्त करने चाहिए:

<MyTypeWithNamespaces>
    <Label xmlns="urn:Whoohoo">myLabel</Label>
    <Epoch>42</Epoch>
</MyTypeWithNamespaces>

मैंने हाल ही में एक प्रोजेक्ट में इस पद्धति का सफलतापूर्वक उपयोग किया है जो कि वेब सेवा कॉल के लिए XML से अनुक्रमित होने वाली कक्षाओं की गहन श्रेणीबद्धता के साथ है। Microsoft का प्रलेखन बहुत स्पष्ट नहीं है कि XmlSerializerNamespacesआपके द्वारा बनाए जाने के बाद , सार्वजनिक रूप से प्रशंसनीय सदस्य के साथ क्या करना है, और बहुत सारे लोग इसे बेकार मानते हैं। लेकिन उनके दस्तावेज़ीकरण का पालन करके और ऊपर दिखाए गए तरीके से इसका उपयोग करके, आप यह अनुकूलित कर सकते हैं कि बिना असमर्थित व्यवहार का सहारा लिए या कार्यान्वयन करके "अपने स्वयं के" क्रमांकन के बिना XmlSerializer XML को अपनी कक्षाओं के लिए कैसे उत्पन्न करता है IXmlSerializable

यह मेरी आशा है कि इस उत्तर को, एक बार और सभी के लिए, मानक xsiऔर xsdनाम स्थान से छुटकारा पाने के लिए कैसे रखा जाएगा XmlSerializer

अद्यतन: मैं सिर्फ यह सुनिश्चित करना चाहता हूं कि मैंने सभी नामस्थानों को हटाने के बारे में ओपी के प्रश्न का उत्तर दिया। ऊपर दिया गया मेरा कोड इसके लिए काम करेगा; मुझे आपको बताने दो कि कैसे। अब, ऊपर के उदाहरण में, आप वास्तव में सभी नामस्थानों से छुटकारा नहीं पा सकते हैं (क्योंकि उपयोग में दो नामस्थान हैं)। कहीं आपके XML डॉक्यूमेंट में, आपको कुछ ऐसा करने की जरूरत नहीं है xmlns="urn:Abracadabra" xmlns:w="urn:Whoohoo। यदि उदाहरण में वर्ग एक बड़े दस्तावेज़ का हिस्सा है, तो कहीं एक नामस्थान के ऊपर (या दोनों) Abracadbraऔर में से किसी एक के लिए घोषित किया जाना चाहिए Whoohoo। यदि नहीं, तो किसी एक या दोनों नामस्थानों के तत्व को किसी प्रकार के उपसर्ग के साथ सजाया जाना चाहिए (आपके पास दो डिफ़ॉल्ट नाम स्थान नहीं हो सकते हैं?)। इसलिए, इस उदाहरण के लिए, Abracadabraडिफ़ॉल्ट नाम स्थान है। मैं अपनी MyTypeWithNamespacesकक्षा के अंदर एक नामस्थान उपसर्ग जोड़ सकता हूँ Whoohooजैसे नामस्थान के लिए :

public MyTypeWithNamespaces
{
    this._namespaces = new XmlSerializerNamespaces(new XmlQualifiedName[] {
        new XmlQualifiedName(string.Empty, "urn:Abracadabra"), // Default Namespace
        new XmlQualifiedName("w", "urn:Whoohoo")
    });
}

अब, मेरी कक्षा की परिभाषा में, मैंने संकेत दिया कि <Label/>तत्व नेमस्पेस में है "urn:Whoohoo", इसलिए मुझे आगे कुछ करने की आवश्यकता नहीं है। जब मैं अब अपने उपर्युक्त क्रमांकन कोड का उपयोग करके वर्ग को अनुक्रमित करता हूं, तो यह आउटपुट है:

<MyTypeWithNamespaces xmlns:w="urn:Whoohoo">
    <w:Label>myLabel</w:Label>
    <Epoch>42</Epoch>
</MyTypeWithNamespaces>

क्योंकि <Label>बाकी दस्तावेज़ से एक अलग नामस्थान में है, यह किसी न किसी नामस्थान के साथ "सजाया" होना चाहिए। ध्यान दें कि अभी भी नाम xsiऔर xsdस्थान नहीं हैं।


इससे दूसरे प्रश्न के लिए मेरा उत्तर समाप्त हो जाता है। लेकिन मैं यह सुनिश्चित करना चाहता था कि मैं बिना किसी नामस्थान का उपयोग किए ओपी के प्रश्न का उत्तर दूं, क्योंकि मुझे लगता है कि मैंने इसे अभी तक संबोधित नहीं किया है। मान लें कि <Label>इस मामले में, बाकी दस्तावेज़ों के समान नामस्थान का हिस्सा है urn:Abracadabra:

<MyTypeWithNamespaces>
    <Label>myLabel<Label>
    <Epoch>42</Epoch>
</MyTypeWithNamespaces>

आपका निर्माणकर्ता ऐसा प्रतीत होता है जैसे यह मेरे पहले कोड उदाहरण में सार्वजनिक संपत्ति के साथ डिफ़ॉल्ट नाम स्थान को पुनः प्राप्त करने के लिए होगा:

// As noted below, per Microsoft's documentation, if the class exposes a public
// member of type XmlSerializerNamespaces decorated with the 
// XmlNamespacesDeclarationAttribute, then the XmlSerializer will utilize those
// namespaces during serialization.
public MyTypeWithNamespaces( )
{
    this._namespaces = new XmlSerializerNamespaces(new XmlQualifiedName[] {
        new XmlQualifiedName(string.Empty, "urn:Abracadabra") // Default Namespace
    });
}

[XmlNamespaceDeclarations]
public XmlSerializerNamespaces Namespaces
{
    get { return this._namespaces; }
}
private XmlSerializerNamespaces _namespaces;

फिर, बाद में, आपके कोड में जो MyTypeWithNamespacesइसे क्रमबद्ध करने के लिए ऑब्जेक्ट का उपयोग करता है, आप इसे ऊपर बताए अनुसार कहेंगे:

MyTypeWithNamespaces myType = new MyTypeWithNamespaces("myLabel", 42);

XmlSerializer xs = new XmlSerializer(typeof(MyTypeWithNamespaces),
    new XmlRootAttribute("MyTypeWithNamespaces") { Namespace="urn:Abracadabra" });

...

// Above, you'd setup your XmlTextWriter.

// Now serialize our object.
xs.Serialize(xtw, myType, myType.Namespaces);

और XmlSerializerआउटपुट में बिना किसी अतिरिक्त नामस्थान के तुरंत ऊपर दिखाए गए एक्सएमएल को वापस थूक देगा:

<MyTypeWithNamespaces>
    <Label>myLabel<Label>
    <Epoch>42</Epoch>
</MyTypeWithNamespaces>

पूर्णता के लिए, शायद आपको इसका सही संदर्भ देने के बजाय यहां सही उत्तर शामिल करना चाहिए, और यह भी, मुझे यह जानने में दिलचस्पी है कि आप कैसे निष्कर्ष निकालते हैं कि यह 'असमर्थित व्यवहार' है।
डेव वान डेन आइंड

1
यह जाँचने के लिए फिर से यहाँ आया, क्योंकि यह सबसे सरल स्पष्टीकरण है जो मैंने पाया है। धन्यवाद @fourpastmidnight
आंद्रे अल्बुकर्क

2
मुझे यह नहीं मिला, आपके अंतिम ओपी के जवाब के लिए, आप अभी भी क्रमिक "कलश: अब्रकदबरा" (निर्माणकर्ता) के दौरान एक नाम स्थान का उपयोग कर रहे हैं, वह अंतिम आउटपुट में क्यों शामिल नहीं है। ओपी का उपयोग नहीं करना चाहिए: XmlSerializerNamespaces EmptyXmlSerializerNamespaces = new XmlSerializerNamespaces (नया [] {XmlQualifiedName.Empty});
डेपार

2
यह सही उत्तर है, हालांकि सबसे अधिक मतदान नहीं हुआ है। मेरे लिए काम नहीं किया था कि भारी बात XmlTextWriter xtw = (XmlTextWriter)XmlTextWriter.Create(ms, xws);मैं द्वारा प्रतिस्थापित किया गया था var xtw = XmlTextWriter.Create(memStm, xws);
लियोनेल सांचेस दा सिल्वा

1
जब से मैंने यह उत्तर लिखा है, कुछ समय हो चुका है। XmlTextWriter.Createरिटर्न (अमूर्त?) XmlWriterउदाहरण है। तो @ Preza8 सही है, आप अन्य- XmlTextWriterविशिष्ट गुण सेट करने की क्षमता खो देंगे (कम से कम, डाउन-कास्टिंग के बिना नहीं), इसलिए, विशिष्ट कलाकारों को XmlTextWriter
चारपश्चिम रात्रि

257
//Create our own namespaces for the output
XmlSerializerNamespaces ns = new XmlSerializerNamespaces();

//Add an empty namespace and empty value
ns.Add("", "");

//Create the serializer
XmlSerializer slz = new XmlSerializer(someType);

//Serialize the object with our own namespaces (notice the overload)
slz.Serialize(myXmlTextWriter, someObject, ns)

24
हम्म् ... तुम लोग विद्रोही हो। यह स्पष्ट रूप से msdn.microsoft.com/en-us/library/… पर कहता है कि आप ऐसा नहीं कर सकते।
राल्फ लावेल

बूल याह! (क्या कहना है कि आप क्या नहीं कर सकते हैं पर काबू पाने के लिए)
GranadaCoder

3
मुझे यकीन नहीं है कि यह "असमर्थित" क्यों है, लेकिन यह वही है जो मैं चाहता था।
डैन बेहार्ड

8
यह उत्तर "xmlns: d1p1" और "xmlns: q1" नामस्थान उत्पन्न करता है। यह क्या है?
लियोनेल सांचेस दा सिल्वा

2
खैर, यह कोड वास्तव में सरल क्रमबद्धता के लिए काम करता है, अन्य नामस्थान परिभाषाओं के बिना। कई नामस्थान परिभाषाओं के लिए, काम का उत्तर स्वीकृत है।
लियोनेल सांचे दा सिल्वा

6

एक विकल्प है - आप क्रमबद्ध किए जाने वाले प्रकार में XmlSerializerNamespaces का सदस्य प्रदान कर सकते हैं । XmlNamespaceDeclarations विशेषता के साथ इसे सजाने । उस सदस्य में नामस्थान उपसर्ग और URI जोड़ें। फिर, कोई भी क्रमांकन जो XmlSerializerNamespaces को स्पष्ट रूप से प्रदान नहीं करता है, आपके द्वारा अपने प्रकार में रखे गए नामस्थान उपसर्ग + URI जोड़े का उपयोग करेगा।

उदाहरण कोड, मान लें कि यह आपका प्रकार है:

[XmlRoot(Namespace = "urn:mycompany.2009")]
public class Person {
  [XmlAttribute] 
  public bool Known;
  [XmlElement]
  public string Name;
  [XmlNamespaceDeclarations]
  public XmlSerializerNamespaces xmlns;
}

तुम यह केर सकते हो:

var p = new Person
  { 
      Name = "Charley",
      Known = false, 
      xmlns = new XmlSerializerNamespaces()
  }
p.xmlns.Add("",""); // default namespace is emoty
p.xmlns.Add("c", "urn:mycompany.2009");

और इसका मतलब यह होगा कि उस उदाहरण का कोई भी क्रमांकन जो उपसर्ग + URI जोड़े के अपने सेट को निर्दिष्ट नहीं करता है, "कलश: mycompany.2009" नामस्थान के लिए "p" उपसर्ग का उपयोग करेगा। यह xsi और xsd नामस्थान को भी छोड़ देगा।

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


1. मुझे अंतर नहीं दिखता है। आप अभी भी XmlSerializerNamespaces के उदाहरण में डिफ़ॉल्ट नामस्थान जोड़ रहे हैं।
डेव वान डे आईंडी

3
2. यह वर्गों को अधिक प्रदूषित करता है। मेरा उद्देश्य कुछ नामस्थानों का उपयोग नहीं करना है, मेरा उद्देश्य नामस्थानों का उपयोग करना नहीं है।
डेव वान डे आईंडी

मैंने इस दृष्टिकोण और XmlSerializerNamespaces को केवल क्रमांकन के दौरान निर्दिष्ट करने के बीच के अंतर के बारे में एक नोट जोड़ा।
चेसो

0

मैं उपयोग कर रहा हूँ:

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

class Program
{
    static void Main(string[] args)
    {
        const string DEFAULT_NAMESPACE = "http://www.something.org/schema";
        var serializer = new XmlSerializer(typeof(Person), DEFAULT_NAMESPACE);
        var namespaces = new XmlSerializerNamespaces();
        namespaces.Add("", DEFAULT_NAMESPACE);

        using (var stream = new MemoryStream())
        {
            var someone = new Person
            {
                FirstName = "Donald",
                LastName = "Duck"
            };
            serializer.Serialize(stream, someone, namespaces);
            stream.Position = 0;
            using (var reader = new StreamReader(stream))
            {
                Console.WriteLine(reader.ReadToEnd());
            }
        }
    }
}

निम्नलिखित XML प्राप्त करने के लिए:

<?xml version="1.0"?>
<Person xmlns="http://www.something.org/schema">
  <FirstName>Donald</FirstName>
  <LastName>Duck</LastName>
</Person>

यदि आप नाम स्थान नहीं चाहते हैं, तो DEFAULT_NAMESPACE को "" सेट करें।


हालाँकि यह सवाल 10 साल से अधिक पुराना है, फिर भी इसका मतलब एक XML निकाय था जिसमें किसी भी तरह के नाम-स्थान की घोषणा नहीं थी।
डेव वान डेन आइंडी

1
अगर मैं किसी ऐसे प्रश्न का उत्तर दूं, जो 10 साल पुराना है, तो यह इसलिए है क्योंकि स्वीकृत उत्तर बाइबल से उसके पूर्ण संस्करण में पढ़ने के लिए लंबा है।
मैक्सेंस

और सबसे अधिक वोट किए गए उत्तर एक दृष्टिकोण (खाली नाम स्थान) को बढ़ावा देते हैं जो अनुशंसित नहीं है।
मैक्सेंस

मैं उसकी मदद नहीं कर सकता। मैं केवल स्वीकृत उत्तर ही दे सकता हूं, जो मुझे विश्वास है कि सबसे सही है।
डेव वान डे आईंड
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.