วิธีที่เหมาะสมในการใช้ IXmlSerializable

เมื่อโปรแกรมเมอร์ตัดสินใจที่จะใช้IXmlSerializableสิ่งที่เป็นกฎและแนวทางปฏิบัติที่ดีที่สุดสำหรับการใช้มัน ฉันได้ยินมาว่าGetSchema()ควรกลับมาnullและReadXmlควรย้ายไปองค์ประกอบต่อไปก่อนกลับ มันเป็นเรื่องจริงเหรอ? แล้วWriteXmlมันควรเขียนองค์ประกอบรากสำหรับวัตถุหรือคิดว่ารูทนั้นถูกเขียนไปแล้วหรือไม่? วัตถุลูกควรได้รับการปฏิบัติและเขียนอย่างไร?

นี่คือตัวอย่างของสิ่งที่ฉันมีตอนนี้ ฉันจะอัปเดตเมื่อฉันได้รับคำตอบที่ดี

public class MyCalendar : IXmlSerializable
{
    private string _name;
    private bool _enabled;
    private Color _color;
    private List<MyEvent> _events = new List<MyEvent>();


    public XmlSchema GetSchema() { return null; }

    public void ReadXml(XmlReader reader)
    {
        if (reader.MoveToContent() == XmlNodeType.Element && reader.LocalName == "MyCalendar")
        {
            _name    = reader["Name"];
            _enabled = Boolean.Parse(reader["Enabled"]);
            _color   = Color.FromArgb(Int32.Parse(reader["Color"]));

            if (reader.ReadToDescendant("MyEvent"))
            {
                while (reader.MoveToContent() == XmlNodeType.Element && reader.LocalName == "MyEvent")
                {
                    MyEvent evt = new MyEvent();
                    evt.ReadXml(reader);
                    _events.Add(evt);
                }
            }
            reader.Read();
        }
    }

    public void WriteXml(XmlWriter writer)
    {
        writer.WriteAttributeString("Name",    _name);
        writer.WriteAttributeString("Enabled", _enabled.ToString());
        writer.WriteAttributeString("Color",   _color.ToArgb().ToString());

        foreach (MyEvent evt in _events)
        {
            writer.WriteStartElement("MyEvent");
            evt.WriteXml(writer);
            writer.WriteEndElement();
        }
    }
}

public class MyEvent : IXmlSerializable
{
    private string _title;
    private DateTime _start;
    private DateTime _stop;


    public XmlSchema GetSchema() { return null; }

    public void ReadXml(XmlReader reader)
    {
        if (reader.MoveToContent() == XmlNodeType.Element && reader.LocalName == "MyEvent")
        {
            _title = reader["Title"];
            _start = DateTime.FromBinary(Int64.Parse(reader["Start"]));
            _stop  = DateTime.FromBinary(Int64.Parse(reader["Stop"]));
            reader.Read();
        }
    }

    public void WriteXml(XmlWriter writer)
    {
        writer.WriteAttributeString("Title", _title);
        writer.WriteAttributeString("Start", _start.ToBinary().ToString());
        writer.WriteAttributeString("Stop",  _stop.ToBinary().ToString());
    }
}

XML ตัวอย่างที่สอดคล้องกัน

<MyCalendar Name="Master Plan" Enabled="True" Color="-14069085">
    <MyEvent Title="Write Code" Start="-8589241828854775808" Stop="-8589241756854775808" />
    <MyEvent Title="???" Start="-8589241828854775808" Stop="-8589241756854775808" />
    <MyEvent Title="Profit!" Start="-8589247048854775808" Stop="-8589246976854775808" />
</MyCalendar>

ใช่ GetSchema () ควรคืนค่าเป็นศูนย์

IXmlSerializable.GetSchema วิธีการนี้สงวนไว้และไม่ควรใช้ เมื่อใช้งานอินเตอร์เฟส IXmlSerializable คุณควรส่งคืนการอ้างอิง null (ไม่มีอะไรใน Visual Basic) จากวิธีนี้และหากจำเป็นต้องระบุสกีมาที่กำหนดเองให้ใช้ XmlSchemaProviderAttribute กับคลาสแทน

สำหรับทั้งการอ่านและการเขียนองค์ประกอบของวัตถุได้ถูกเขียนไปแล้วดังนั้นคุณไม่จำเป็นต้องเพิ่มองค์ประกอบด้านนอกในการเขียน ตัวอย่างเช่นคุณสามารถเริ่มอ่าน / เขียนคุณสมบัติในทั้งสอง

สำหรับการเขียน :

การใช้งาน WriteXml ที่คุณระบุควรเขียนการแทนค่า XML ของวัตถุ กรอบงานเขียนองค์ประกอบ wrapper และตำแหน่งตัวเขียน XML หลังจากเริ่มต้น การนำไปใช้ของคุณอาจเขียนเนื้อหารวมถึงองค์ประกอบย่อย กรอบจากนั้นปิดองค์ประกอบ wrapper

และสำหรับการอ่าน :

กระบวนการ ReadXml วิธีต้องสร้างวัตถุของคุณใหม่โดยใช้ข้อมูลที่เขียนโดยวิธีการ WriteXml

เมื่อวิธีนี้เรียกว่าเครื่องอ่านจะอยู่ในตำแหน่งเริ่มต้นขององค์ประกอบที่ล้อมรอบข้อมูลสำหรับประเภทของคุณ นั่นคือก่อนหน้าแท็กเริ่มต้นที่ระบุจุดเริ่มต้นของวัตถุที่เป็นอนุกรม เมื่อวิธีการนี้กลับมามันจะต้องอ่านองค์ประกอบทั้งหมดตั้งแต่ต้นจนจบรวมถึงเนื้อหาทั้งหมด ไม่เหมือนกับเมธอด WriteXml เฟรมเวิร์กไม่ได้จัดการองค์ประกอบ wrapper โดยอัตโนมัติ การดำเนินการของคุณจะต้องทำเช่นนั้น การไม่ปฏิบัติตามกฎการวางตำแหน่งเหล่านี้อาจทำให้รหัสเพื่อสร้างข้อยกเว้นรันไทม์ที่ไม่คาดคิดหรือข้อมูลเสียหาย

ฉันจะยอมรับว่าไม่ชัดเจน แต่มันก็เดือดร้อนลงไปที่ "มันเป็นงานของคุณที่Read()แท็กสิ้นสุดองค์ประกอบของเสื้อคลุม"

ฉันเขียนบทความหนึ่งเรื่องที่มีตัวอย่างเนื่องจากเอกสารของ MSDN นั้นยังไม่ชัดเจนและตัวอย่างที่คุณพบในเว็บนั้นส่วนใหญ่แล้วจะมีการนำไปใช้อย่างไม่ถูกต้อง

ข้อผิดพลาดคือการจัดการสถานที่และองค์ประกอบว่างเปล่านอกเหนือจากสิ่งที่ Marc Gravell พูดถึงแล้ว

http://www.codeproject.com/KB/XML/ImplementIXmlSerializable.aspx

ใช่สิ่งทั้งปวงเป็นเขตที่วางทุ่นระเบิดใช่ไหม? คำตอบของMarc Gravellค่อนข้างครอบคลุม แต่ฉันต้องการเพิ่มในโครงการที่ฉันทำงานเราพบว่ามันค่อนข้างอึดอัดที่จะต้องเขียนองค์ประกอบ XML ภายนอกด้วยตนเอง นอกจากนี้ยังส่งผลให้ชื่อองค์ประกอบ XML ที่ไม่สอดคล้องกันสำหรับวัตถุประเภทเดียวกัน

วิธีการแก้ปัญหาของเราคือการกำหนดของเราเองอินเตอร์เฟซที่มาจากระบบใดระบบหนึ่งซึ่งเพิ่มวิธีการที่เรียกว่าIXmlSerializable WriteOuterXml()อย่างที่คุณสามารถคาดเดาได้วิธีนี้จะเขียนองค์ประกอบนอกแล้วเรียกWriteXml()แล้วเขียนจุดสิ้นสุดขององค์ประกอบ แน่นอน XML ของระบบจะไม่เรียกวิธีนี้ดังนั้นจึงเป็นประโยชน์เฉพาะเมื่อเราทำการซีเรียลไลเซชั่นของเราเองเพื่อที่จะเป็นประโยชน์หรือไม่ในกรณีของคุณ ในทำนองเดียวกันเราได้เพิ่มReadContentXml()วิธีการที่ไม่ได้อ่านองค์ประกอบด้านนอกเพียงเนื้อหาของมัน

หากคุณมี XmlDocument เป็นตัวแทนของชั้นเรียนของคุณหรือชอบวิธี XmlDocument ในการทำงานกับโครงสร้าง XML วิธีที่รวดเร็วและสกปรกในการใช้งาน IXmlSerializable คือการส่งผ่าน xmldoc นี้ไปยังฟังก์ชันต่างๆ

คำเตือน: XmlDocument (และ / หรือ XDocument) เป็นลำดับความสำคัญช้ากว่า xmlreader / นักเขียนดังนั้นหากประสิทธิภาพเป็นข้อกำหนดที่แน่นอนโซลูชันนี้ไม่เหมาะสำหรับคุณ!

class ExampleBaseClass : IXmlSerializable { 
    public XmlDocument xmlDocument { get; set; }
    public XmlSchema GetSchema()
    {
        return null;
    }
    public void ReadXml(XmlReader reader)
    {
        xmlDocument.Load(reader);
    }

    public void WriteXml(XmlWriter writer)
    {
        xmlDocument.WriteTo(writer);
    }
}

การใช้อินเทอร์เฟซถูกครอบคลุมโดยคำตอบอื่น ๆ แต่ฉันต้องการที่จะโยนใน 2 เซ็นต์ของฉันสำหรับองค์ประกอบราก

ฉันได้เรียนรู้ในอดีตเพื่อเลือกที่จะวางองค์ประกอบรากเป็นเมทาดาทา สิ่งนี้มีประโยชน์เล็กน้อย:

• หากมีวัตถุเป็นโมฆะก็ยังสามารถทำให้เป็นอันดับ
• จากจุดยืนในการอ่านโค้ดมันสมเหตุสมผลดี

ด้านล่างนี้เป็นตัวอย่างของพจนานุกรมแบบอนุกรมที่องค์ประกอบรากพจนานุกรมถูกกำหนดในลักษณะนั้น:

using System.Collections.Generic;

[System.Xml.Serialization.XmlRoot("dictionary")]
public partial class SerializableDictionary<TKey, TValue> : Dictionary<TKey, TValue>, System.Xml.Serialization.IXmlSerializable
{
            public virtual System.Xml.Schema.XmlSchema GetSchema()
    {
        return null;
    }

    public virtual void ReadXml(System.Xml.XmlReader reader)
    {
        var keySerializer = new System.Xml.Serialization.XmlSerializer(typeof(TKey));
        var valueSerializer = new System.Xml.Serialization.XmlSerializer(typeof(TValue));
        bool wasEmpty = reader.IsEmptyElement;
        reader.Read();
        if (wasEmpty)
            return;
        while (reader.NodeType != System.Xml.XmlNodeType.EndElement)
        {
            reader.ReadStartElement("item");
            reader.ReadStartElement("key");
            TKey key = (TKey)keySerializer.Deserialize(reader);
            reader.ReadEndElement();
            reader.ReadStartElement("value");
            TValue value = (TValue)valueSerializer.Deserialize(reader);
            reader.ReadEndElement();
            Add(key, value);
            reader.ReadEndElement();
            reader.MoveToContent();
        }

        reader.ReadEndElement();
    }

    public virtual void WriteXml(System.Xml.XmlWriter writer)
    {
        var keySerializer = new System.Xml.Serialization.XmlSerializer(typeof(TKey));
        var valueSerializer = new System.Xml.Serialization.XmlSerializer(typeof(TValue));
        foreach (TKey key in Keys)
        {
            writer.WriteStartElement("item");
            writer.WriteStartElement("key");
            keySerializer.Serialize(writer, key);
            writer.WriteEndElement();
            writer.WriteStartElement("value");
            var value = this[key];
            valueSerializer.Serialize(writer, value);
            writer.WriteEndElement();
            writer.WriteEndElement();
        }
    }

    public SerializableDictionary() : base()
    {
    }

    public SerializableDictionary(IDictionary<TKey, TValue> dictionary) : base(dictionary)
    {
    }

    public SerializableDictionary(IDictionary<TKey, TValue> dictionary, IEqualityComparer<TKey> comparer) : base(dictionary, comparer)
    {
    }

    public SerializableDictionary(IEqualityComparer<TKey> comparer) : base(comparer)
    {
    }

    public SerializableDictionary(int capacity) : base(capacity)
    {
    }

    public SerializableDictionary(int capacity, IEqualityComparer<TKey> comparer) : base(capacity, comparer)
    {
    }

}