C#使用BinaryFormatter類、ISerializable接口、XmlSerializer類進(jìn)行序列化和反序列化

更新時(shí)間：2022年09月11日 14:06:02 作者：Darren Ji

這篇文章介紹了C#使用BinaryFormatter類、ISerializable接口、XmlSerializer類進(jìn)行序列化和反序列化的方法，文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

序列化是將對(duì)象轉(zhuǎn)換成字節(jié)流的過(guò)程，反序列化是把字節(jié)流轉(zhuǎn)換成對(duì)象的過(guò)程。對(duì)象一旦被序列化，就可以把對(duì)象狀態(tài)保存到硬盤(pán)的某個(gè)位置，甚至還可以通過(guò)網(wǎng)絡(luò)發(fā)送給另外一臺(tái)機(jī)器上運(yùn)行的進(jìn)程。本篇主要包括:

使用BinaryFormatter類進(jìn)行序列化和反序列化

使用ISerializable接口自定義序列化過(guò)程

使用XmlSerializer類進(jìn)行序列化和反序列化

使用BinaryFormatter類進(jìn)行序列化和反序列化

首先把需要序列化的類打上[Serializable]特性，如果某個(gè)字段不需要被序列化，就打上[NonSerialized]特性。

    [Serializable]
    public class Meeting
    {
        public string _name;
        [NonSerialized]
        public string _location;
        public Meeting(string name, string location)
        {
            this._name = name;
            this._location = location;
        }
    }

對(duì)象序列化后需要一個(gè)載體文件，以下的Meeting.binary文件用來(lái)存儲(chǔ)對(duì)象的狀態(tài)。

        static void Main(string[] args)
        {
            Meeting m1 = new Meeting("年終總結(jié)","青島");
            Meeting m2;
            //先序列化
            SerializedWithBinaryFormatter(m1,"Meeting.binary");
            m2 = (Meeting) DeserializeWithBinaryFormatter("Meeting.binary");
            Console.WriteLine(m2._name);
            Console.WriteLine(m2._location  ?? "_location字段沒(méi)有被序列化");
            Console.ReadKey();
        }
        //序列化
        static void SerializedWithBinaryFormatter(object obj, string fileName)
        {
            //打開(kāi)文件寫(xiě)成流
            Stream streamOut = File.OpenWrite(fileName);
            BinaryFormatter formatter = new BinaryFormatter();
            //把對(duì)象序列化到流中
            formatter.Serialize(streamOut, obj);
            //關(guān)閉流
            streamOut.Close();
        }
        //反序列化
        static object DeserializeWithBinaryFormatter(string fileName)
        {
            //打開(kāi)文件讀成流
            Stream streamIn = File.OpenRead(fileName);
            BinaryFormatter formatter = new BinaryFormatter();
            object obj = formatter.Deserialize(streamIn);
            streamIn.Close();
            return obj;
        }

Meeting.binary文件在bin/debug文件夾中。

使用ISerializable接口自定義序列化過(guò)程

如果想對(duì)序列化的過(guò)程有更多的控制，應(yīng)該使用ISerializable接口，通過(guò)它的GetObjectData方法可以改變對(duì)象的字段值。

    [Serializable]
    public class Location : ISerializable
    {
        public int x;
        public int y;
        public string name;
        public Location(int x, int y, string name)
        {
            this.x = x;
            this.y = y;
            this.name = name;
        }
        protected Location(SerializationInfo info, StreamingContext context)
        {
            x = info.GetInt32("i");
            y = info.GetInt32("j");
            name = info.GetString("k");
        }
        public void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            info.AddValue("i", x + 1);
            info.AddValue("j", y + 1);
            info.AddValue("k", name + "HELLO");
        }
    }

以上，不僅要實(shí)現(xiàn)接口方法GetObjectData，還需要提供對(duì)象的重載構(gòu)造函數(shù)，從SerializationInfo實(shí)例中獲取值。

在客戶端：

            Location loc1 = new Location(1,2,"qingdao");
            Location loc2;
            //序列化
            SerializedWithBinaryFormatter(loc1, "Location.binary");
            loc2 = (Location) DeserializeWithBinaryFormatter("Location.binary");
            Console.WriteLine(loc2.x);
            Console.WriteLine(loc2.y);
            Console.WriteLine(loc2.name);
            Console.ReadKey();

以上，使用BinaryFormatter類進(jìn)行序列化和反序列化，存儲(chǔ)的文件格式是二進(jìn)制的，例如，打開(kāi)Meeting.binary文件，我們看到：

有時(shí)候，我們希望文件的格式是xml。

使用XmlSerializer類進(jìn)行序列化和反序列化

XmlSerializer類進(jìn)行序列化的存儲(chǔ)文件是xml格式。用XmlSerializer類進(jìn)行序列化的類不需要打上[Serializable]特性。

    public class Car
    {
        [XmlAttribute(AttributeName = "model")]
        public string type;
        public string code;
        [XmlIgnore]
        public int age;
        [XmlElement(ElementName = "mileage")]
        public int miles;
        public Status status;
        public enum Status
        {
            [XmlEnum("使用中")]
            Normal,
            [XmlEnum("修復(fù)中")]
            NotUse,
            [XmlEnum("不再使用")]
            Deleted
        }
    }

在客戶端：

            //打開(kāi)寫(xiě)進(jìn)流
            Stream streamOut = File.OpenWrite("Car.xml");
            System.Xml.Serialization.XmlSerializer x = new XmlSerializer(car1.GetType());
            //序列化到流中
            x.Serialize(streamOut, car1);
            streamOut.Close();
            //打開(kāi)讀流
            Stream streamIn = File.OpenRead("Car.xml");
            //反序列化
            Car car2 = (Car) x.Deserialize(streamIn);
            Console.WriteLine(car2.type);
            Console.WriteLine(car2.code);
            Console.WriteLine(car2.miles);
            Console.WriteLine(car2.status);
            Console.ReadKey();

運(yùn)行，打開(kāi)bin/debug中的Car.xml文件如下：

<?xml version="1.0"?>
<Car xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" model="sedan">
  <code>001</code>
  <mileage>1000</mileage>
  <status>使用中</status>
</Car>

類名Car成了xml的根節(jié)點(diǎn)
打上[XmlAttribute(AttributeName = "model")]特性的字段變成了根節(jié)點(diǎn)的屬性，AttributeName為屬性別名
枚舉項(xiàng)可打上[XmlEnum("使用中")]特性

如果一個(gè)類中包含集合屬性，比如以下的Department類包含一個(gè)類型List<Employee>的集合屬性Employees。

   public class Department
    {
        public Department()
        {
            Employees = new List<Employee>();
        }
        public string Name { get; set; }
        [XmlArray("Staff")]
        public List<Employee> Employees { get; set; }
    }
    public class Employee
    {
        public string Name { get; set; }
        public Employee()
        {
            
        }
        public Employee(string name)
        {
            Name = name;
        }
    }

在客戶端：

    class Program
    {
        static void Main(string[] args)
        {
            var department = new Department();
            department.Name = "銷售部";
            department.Employees.Add(new Employee("張三"));
            department.Employees.Add(new Employee("李四"));
            XmlSerializer serializer = new XmlSerializer(department.GetType());
            //打開(kāi)寫(xiě)進(jìn)流
            Stream streamOut = File.OpenWrite("Department.xml");
            serializer.Serialize(streamOut, department);
            streamOut.Close();
        }
    }

查看bin/debug中的Department.xml文件。

<?xml version="1.0"?>
<Department xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>銷售部</Name>
  <Staff>
    <Employee>
      <Name>張三</Name>
    </Employee>
    <Employee>
      <Name>李四</Name>
    </Employee>
  </Staff>
</Department>

總結(jié)：