XML 序列化和反序列化详例代码

  这是一个使用序列化和反序列化的详细例子来操作复杂的XML数据，其中还举例数组和List的使用方法和区别。 

  1
  2using System.Xml;
  3using System.Xml.Serialization;
  4using System.IO;
  5
  6namespace SerializableTest
  7{
  8    
  9
 10    // The XmlRootAttribute allows you to set an alternate name 
 11    // (PurchaseOrder) for the XML element and its namespace. By 
 12    // default, the XmlSerializer uses the class name. The attribute 
 13    // also allows you to set the XML namespace for the element. Lastly,
 14    // the attribute sets the IsNullable property, which specifies whether 
 15    // the xsi:null attribute appears if the class instance is set to 
 16    // a null reference.
 17    
 18    
 19    //[XmlRootAttribute("PurchaseOrder", Namespace = "http://www.cpandl.com", IsNullable = false)]
 20    [XmlRootAttribute("PurchaseOrder")]
 21    [XmlInclude(typeof(OrderedItem))]
 22    public class PurchaseOrder
 23    {
 24        public Address ShipTo;
 25        public string OrderDate;
 26        
 27        // The XmlArrayAttribute changes the XML element name
 28        // from the default of "OrderedItems" to "Items".
 29        [XmlArrayAttribute("Items")]
 30        public OrderedItem[] OrderedItems;        
 31        [XmlArrayAttribute("Items2")]
 32        public List<OrderedItem> OrderedItemList;
 33        
 34        public decimal SubTotal;
 35        public decimal ShipCost;
 36        public decimal TotalCost;
 37    }
 38
 39    public class Address
 40    {
 41        // The XmlAttribute instructs the XmlSerializer to serialize the 
 42        // Name field as an XML attribute instead of an XML element (the 
 43        // default behavior).
 44        [XmlAttribute]
 45        public string Name;
 46        public string Line1;
 47
 48        // Setting the IsNullable property to false instructs the 
 49        // XmlSerializer that the XML attribute will not appear if 
 50        // the City field is set to a null reference.
 51        [XmlElementAttribute(IsNullable = false)]
 52        public string City;
 53        public string State;
 54        public string Zip;
 55    }
 56
 57    public class OrderedItem
 58    {
 59        [XmlAttribute("Name")]
 60        public string ItemName;
 61        public string Description;
 62        public decimal UnitPrice;
 63        public int Quantity;
 64        public decimal LineTotal;
 65
 66        // Calculate is a custom method that calculates the price per item
 67        // and stores the value in a field.
 68        public void Calculate()
 69        {
 70            LineTotal = UnitPrice * Quantity;
 71        }
 72    }
 73
 74    public class Test
 75    {
 76        public static void Main()
 77        {
 78            // Read and write purchase orders.
 79            Test t = new Test();
 80            t.CreatePO("po.xml");
 81            t.ReadPO("po.xml");
 82            Console.Read();
 83        }
 84
 85        private void CreatePO(string filename)
 86        {
 87            // Creates an instance of the XmlSerializer class;
 88            // specifies the type of object to serialize.
 89            XmlSerializer serializer = new XmlSerializer(typeof(PurchaseOrder));
 90            TextWriter writer = new StreamWriter(filename);
 91            PurchaseOrder po = new PurchaseOrder();
 92
 93            // Creates an address to ship and bill to.
 94            Address billAddress = new Address();
 95            billAddress.Name = "Teresa Atkinson";
 96            billAddress.Line1 = "1 Main St.";
 97            billAddress.City = "AnyTown";
 98            billAddress.State = "WA";
 99            billAddress.Zip = "00000";
            // Sets ShipTo and BillTo to the same addressee.
            po.ShipTo = billAddress;
            po.OrderDate = System.DateTime.Now.ToLongDateString();

            // Creates an OrderedItem.
            OrderedItem i1 = new OrderedItem();
            i1.ItemName = "Widget S_1";
            i1.Description = "Small widget";
            i1.UnitPrice = (decimal)5.23;
            i1.Quantity = 3;
            i1.Calculate();

            // Creates an OrderedItem.
            OrderedItem i2 = new OrderedItem();
            i2.ItemName = "Widget S_2";
            i2.Description = "Small widget_2";
            i2.UnitPrice = (decimal)25.23;
            i2.Quantity = 3;
            i2.Calculate();

            // Inserts the item into the array.           
            OrderedItem[] items = { i1,i2 };

            po.OrderedItemList = new List<OrderedItem>();
            po.OrderedItemList.Add(i1);
            po.OrderedItemList.Add(i2);

            po.OrderedItems = items;
            // Calculate the total cost.
            decimal subTotal = new decimal();
            foreach (OrderedItem oi in items)
            {
                subTotal += oi.LineTotal;
            }
            po.SubTotal = subTotal;
            po.ShipCost = (decimal)12.51;
            po.TotalCost = po.SubTotal + po.ShipCost;
            // Serializes the purchase order, and closes the TextWriter.
            serializer.Serialize(writer, po);
            writer.Close();
        }

        protected void ReadPO(string filename)
        {
            // Creates an instance of the XmlSerializer class;
            // specifies the type of object to be deserialized.
            XmlSerializer serializer = new XmlSerializer(typeof(PurchaseOrder));
            // If the XML document has been altered with unknown 
            // nodes or attributes, handles them with the 
            // UnknownNode and UnknownAttribute events.
            serializer.UnknownNode += new
            XmlNodeEventHandler(serializer_UnknownNode);
            serializer.UnknownAttribute += new
            XmlAttributeEventHandler(serializer_UnknownAttribute);

            // A FileStream is needed to read the XML document.
            FileStream fs = new FileStream(filename, FileMode.Open);
            // Declares an object variable of the type to be deserialized.
            PurchaseOrder po;
            // Uses the Deserialize method to restore the object's state 
            // with data from the XML document. */
            po = (PurchaseOrder)serializer.Deserialize(fs);
            // Reads the order date.
            Console.WriteLine("OrderDate: " + po.OrderDate);

            // Reads the shipping address.
            Address shipTo = po.ShipTo;
            ReadAddress(shipTo, "Ship To:");
            // Reads the list of ordered items.
            OrderedItem[] items = po.OrderedItems;
            Console.WriteLine("Items to be shipped:");
            foreach (OrderedItem oi in items)
            {
                Console.WriteLine("\t" +
                oi.ItemName + "\t" +
                oi.Description + "\t" +
                oi.UnitPrice + "\t" +
                oi.Quantity + "\t" +
                oi.LineTotal);
            }
            // Reads the subtotal, shipping cost, and total cost.
            Console.WriteLine(
            "\n\t\t\t\t\t Subtotal\t" + po.SubTotal +
            "\n\t\t\t\t\t Shipping\t" + po.ShipCost +
            "\n\t\t\t\t\t Total\t\t" + po.TotalCost
            );
        }

        protected void ReadAddress(Address a, string label)
        {
            // Reads the fields of the Address.
            Console.WriteLine(label);
            Console.Write("\t" +
            a.Name + "\n\t" +
            a.Line1 + "\n\t" +
            a.City + "\t" +
            a.State + "\n\t" +
            a.Zip + "\n");
        }

        protected void serializer_UnknownNode
        (object sender, XmlNodeEventArgs e)
        {
            Console.WriteLine("Unknown Node:" + e.Name + "\t" + e.Text);
        }

        protected void serializer_UnknownAttribute
        (object sender, XmlAttributeEventArgs e)
        {
            System.Xml.XmlAttribute attr = e.Attr;
            Console.WriteLine("Unknown attribute " +
            attr.Name + "='" + attr.Value + "'");
        }
    }
}