XmlSerializer 對象序列化成XML 自定義編碼格式(gb2312)

　　隨着面向服務(SOA)的開發方式的興起，客戶端和服務端之間的消息傳送，很多采用了XML的格式。但是大家在日常的開發中，應該會有這么種體驗，就是組織xml格式的代碼太繁瑣，這篇隨筆也是為了和大家分享下簡便的組織xml字符串的解決方案。

閑話不多說，我們直接上源碼：

（1）自定義的實體類源碼（簡單的序列化我就不在贅述）,大家可以仔細看下這個實體類源碼中包含了好幾個類，然后類之間有着層級調用，這樣的方式就是為了在序列化的時候實現xml元素包含元素的形式；如果想要實現同一個元素並列展示，那么就需要聲明為數組類型 如下的public long[] BlockID { get; set; }

所有要序列化的字段或者類都需要為public

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Serialization;

namespace Message.Entity
{
    [XmlRoot("Message")]//標記根節點的名字 10     public class DYAreaTypeMessage
    {
        public Header Header{ get; set; }
        public Payload Payload { get; set; }
    }

    [Serializable]
    public class Header
    {
        public string Verb { get; set; }
        public string Noun { get; set; }
    }

    [Serializable]
    public class Payload
    {
        public NetworkChangeDetail NetworkChangeDetail { get; set; }
    }

    [Serializable]
    public class DYAreaType
    {
        [XmlElement("BlockID",IsNullable=false)]//如果自己不定義元素的名字 ，那么序列化生成的元素就會變成字段類型的名稱 33         public long[] BlockID { get; set; }//注意(1)該地方是一個數組的形式，不可以用list代替，不然將不能序列化 34     }

    [Serializable]
    public class NetworkChangeDetail
    {
        public DYAreaType DYAreaType
        {
            get;
            set;
        }

        [XmlElement("MessageID",IsNullable=false)]
        public string MessageID
        {
            get;
            set;
        }
        [XmlElement("Buro")]
        public string Buro
        {
            get;
            set;
        }
        [XmlElement("SubBuro")]
        public string SubBuro
        {
            get;
            set;
        }

        [XmlElement("Description")]
        public string Description
        {
            get;
            set;
        }
        [XmlElement("DateTime")]
        public string DateTime
        {
            get;
            set;
        }
    }

（2）序列化實現代碼

　　序列化的實現方法其實很簡單 使用.net提供的XmlSerializer 類就可以了 ，

             XmlSerializer serializer = new XmlSerializer(typeof(類名));
             serializer.Serialize(textWriter,類的實例);//參數說明可查看msdn

但是我們一般會遇到一個一問題就是要 指定xml的編碼格式，這個地方讓我也蛋疼了好一會，后來解決方式是這樣的

 MemoryStream ms = new MemoryStream();//定義一個內存流
 XmlTextWriter textWriter = new XmlTextWriter(ms,Encoding.GetEncoding("gb2312"));//定義輸出的編碼格式

通過以上兩句代碼即可實現自定義編碼格式，然后還有個就是把內存流轉成字符串

　　　　　　　string xmlMessage = Encoding.UTF8.GetString(ms.GetBuffer());

        /// <summary>
        /// 創建消息的xml語句
        /// </summary>
        /// <param name="blockID"></param>
        /// <param name="buro"></param>
        /// <param name="subBuro"></param>
        /// <param name="Description"></param>
        public string CreateMessageXML(long[] blockID, string buro, string subBuro, string Description, long activityID, out bool isSerializer)
        {
            isSerializer = false;
            CISP.Message.Entity.DYAreaTypeMessage dyArea = new CISP.Message.Entity.DYAreaTypeMessage();
            dyArea.Header = new CISP.Message.Entity.Header() { Verb = "Update", Noun = "NetworkChangeDetail" };
            dyArea.Payload = new CISP.Message.Entity.Payload();
            dyArea.Payload.NetworkChangeDetail = new CISP.Message.Entity.NetworkChangeDetail()
            {
                MessageID = activityID.ToString(),
                Buro = buro,
                SubBuro = subBuro,
                Description = Description,
                DateTime = DateTime.Now.ToString("G")
            };

            dyArea.Payload.NetworkChangeDetail.DYAreaType = new CISP.Message.Entity.DYAreaType()
            {
                BlockID = blockID
            };

            MemoryStream ms = new MemoryStream();
           // XmlTextWriter textWriter = new XmlTextWriter(ms, Encoding.GetEncoding("UTF-8"));
            StreamWriter textWriter = new StreamWriter(ms, Encoding.GetEncoding("gb2312"));
            XmlSerializer serializer = new XmlSerializer(typeof(CISP.Message.Entity.DYAreaTypeMessage));
            serializer.Serialize(textWriter, dyArea);

            string xmlMessage = Encoding.UTF8.GetString(ms.GetBuffer());
            isSerializer = true;
            ms.Close();
            textWriter.Close();
            return xmlMessage;
        }

 

 

 （3）最后我們看下結果：

<?xml version="1.0" encoding="gb2312"?>//不知道為何指定為utf8變成了gb2312
<Message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Header>
    <Verb>Update</Verb>
    <Noun>NetworkChangeDetail</Noun>
  </Header>
  <Payload>
    <NetworkChangeDetail>
      <DYAreaType>
        <BlockID>30000299430897</BlockID>
        <BlockID>30000299511558</BlockID>
        <BlockID>30000101714620</BlockID>
        <BlockID>30000211294903</BlockID>
        <BlockID>30000299425996</BlockID>
        <BlockID>30000299425985</BlockID>
      </DYAreaType>
      <MessageID>604186</MessageID>
      <Buro>335100000</Buro>
      <SubBuro>0000145222</SubBuro>
      <Description>fff</Description>
      <DateTime>2013-12-9 13:34:52</DateTime>
    </NetworkChangeDetail>
  </Payload>
</Message>

http://www.cnblogs.com/yukaizhao/archive/2011/07/22/xml-serialization.html 這篇博客中提到以下注意點，僅供參考 沒有去驗證過。

我們在使用XmlSerializer序列化，初始化XmlSerializer對象時最好使用下面兩個構造函數否則會引起內存泄漏。
XmlSerializer(Type)
XmlSerializer.XmlSerializer(Type, object)