.Net 序列化(去除默认命名空间,添加编码)

1、序列化注意事项

（1）.Net 序列化是基于对象的。所以只有实例字段呗序列化。静态字段不在序列化之中。

（2）枚举永远是可序列化的。

2、XML序列化时去除默认命名空间xmlns:xsd和xmlns:xsi

       #region 序列化

        /// <summary>
        /// 序列化
        /// </summary>
        /// <param name="type">类型</param>
        /// <param name="obj">对象</param>
        /// <returns></returns>
        public static string Serializer(Type type, object obj)
        {
            var stream = new MemoryStream();
            var xml = new XmlSerializer(type);
            try
            {
                var xns = new XmlSerializerNamespaces();
                xns.Add("", "");
                //序列化对象
                xml.Serialize(stream, obj, xns);
            }
            catch (InvalidOperationException)
            {
                throw;
            }
            stream.Position = 0;
            var sr = new StreamReader(stream);
            var str = sr.ReadToEnd();

            sr.Dispose();
            stream.Dispose();

            return str;
        }

        #endregion 序列化

序列化结果示例：

<?xml version="1.0"?>
<xml>
  <ToUserName>o4m2yt-YsHdwrpYXtir9DGwzh80E</ToUserName>
  <FromUserName>gh_7e832e7ed40f</FromUserName>
  <MsgType>text</MsgType>
  <CreateTime>1463319373</CreateTime>
  <Content>欢迎使咨询</Content>
</xml>

序列化方法可去掉<?xml version="1.0"?> xml声明头：

       #region 序列化

        /// <summary>
        /// 序列化
        /// </summary>
        /// <param name="type">类型</param>
        /// <param name="obj">对象</param>
        /// <returns></returns>
        public static string Serializer(Type type, object obj)
        {
            var settings = new XmlWriterSettings
            {
                Indent = true,
                IndentChars = " ",
                NewLineChars = "\r\n",
                Encoding = Encoding.UTF8,
                OmitXmlDeclaration = true // 不生成声明头
            };

            var stream = new MemoryStream();
            var xml = new XmlSerializer(type);
            try
            {
                using (XmlWriter xmlWriter = XmlWriter.Create(stream, settings))
                {
                    var xns = new XmlSerializerNamespaces();
                    xns.Add(string.Empty, string.Empty);
                    //序列化对象
                      xml.Serialize(xmlWriter, obj, xns);
                    xmlWriter.Close();
                }
            }
            catch (InvalidOperationException)
            {
                throw;
            }
            stream.Position = 0;
            var sr = new StreamReader(stream);
            var str = sr.ReadToEnd();

            sr.Dispose();
            stream.Dispose();

            return str;
        }

        #endregion 序列化

生成结果：

<xml>
 <ToUserName>o4m2yt-YsHdwrpYXtir9DGwzh80E</ToUserName>
 <FromUserName>gh_7e832e7ed40f</FromUserName>
 <MsgType>text</MsgType>
 <CreateTime>1463320560</CreateTime>
 <Content>欢迎使咨询</Content>
</xml>

知识点：

XmlWriterSettings：指定在 XmlWriter.Create 方法创建的 XmlWriter 对象上支持的一组功能。

详情可查询msdn：https://msdn.microsoft.com/zh-cn/library/system.xml.xmlwritersettings(v=vs.110).aspx

3、序列化常用Attribute讲解说明

[XmlRootAttribute("MyCity", Namespace="abc.abc", IsNullable=false)]     // 当该类为Xml根节点时，以此为根节点名称。
public class City

[XmlAttribute("AreaName")]    // 表现为Xml节点属性。<... AreaName="..."/>
public string Name

[XmlElementAttribute("AreaId", IsNullable = false)]    // 表现为Xml节点。<AreaId>...</AreaId>
public string Id

[XmlArrayAttribute("Areas")]    // 表现为Xml层次结构，根为Areas，其所属的每个该集合节点元素名为类名。<Areas><Area ... /><Area ... /></Areas>
public Area[] Areas

[XmlElementAttribute("Area", IsNullable = false)]    // 表现为水平结构的Xml节点。<Area ... /><Area ... />...
public Area[] Areas

[XmlIgnoreAttribute]    // 忽略该元素的序列化。

4、相关的常用Attribute（命名空间System.Xml.Serialization ）

    [XmlRootAttribute("PurchaseOrder", Namespace="http://www.cpandl.com", IsNullable=false)]  // 指定根
     [XmlIgnoreAttribute]                                                                      // 跳过不序列化
     [XmlArrayAttribute("Items")] public OrderedItem[] OrderedItems;                           // 层次序列化: <Items><OrderedItem.../><OrderedItem.../>..</Items>
    [XmlElementAttribute(ElementName="Link", IsNullable=false)] public Link[] Links;          // 平面序列化: <Link ..../><Link .../>...
    [XmlAttribute("Cat")] public string Cat;                                                  // 表现为属性<... Cat=.. />
    [XmlElementAttribute(IsNullable=false)]                                                   // 表现为节点<Cat>..</cat>

5、相关的全部Attribute（命名空间System.Xml.Serialization ）

    XmlAttributes                     表示一个特性对象的集合，这些对象控制 XmlSerializer 如何序列化和反序列化对象。
    XmlArrayAttribute                 指定 XmlSerializer 应将特定的类成员序列化为 XML 元素数组。
    XmlArrayItemAttribute             指定 XmlSerializer 可以放置在序列化数组中的派生类型。
    XmlArrayItemAttributes            表示 XmlArrayItemAttribute 对象的集合。
    XmlAttributeAttribute             指定 XmlSerializer 应将类成员作为 XML 特性序列化。
    XmlChoiceIdentifierAttribute      指定可以通过使用枚举来进一步消除成员的歧义。
    XmlElementAttribute               在 XmlSerializer 序列化或反序列化包含对象时，指示公共字段或属性表示 XML 元素。
    XmlElementAttributes              表示 XmlElementAttribute 的集合，XmlSerializer 将其用于它重写序列化类的默认方式。
    XmlEnumAttribute                  控制 XmlSerializer 如何序列化枚举成员。
    XmlIgnoreAttribute                指示 XmlSerializer 的 Serialize 方法不序列化公共字段或公共读/写属性值。
    XmlIncludeAttribute               允许 XmlSerializer 在它序列化或反序列化对象时识别类型。
    XmlRootAttribute                  控制视为 XML 根元素的属性目标的 XML 序列化。
    XmlTextAttribute                  当序列化或反序列化包含类时，向 XmlSerializer 指示应将此成员作为 XML 文本处理。
    XmlTypeAttribute                  控制当属性目标由 XmlSerializer 序列化时生成的 XML 架构。
    XmlAnyAttributeAttribute          指定成员（返回 XmlAttribute 对象的数组的字段）可以包含任何 XML 属性。
    XmlAnyElementAttribute            指定成员（返回 XmlElement 或 XmlNode 对象的数组的字段）可以包含对象，该对象表示在序列化或反序列化的对象中没有相应成员的所有 XML 元素。
    XmlAnyElementAttributes           表示 XmlAnyElementAttribute 对象的集合。
    XmlAttributeEventArgs             为 UnknownAttribute 事件提供数据。
    XmlAttributeOverrides             允许您在使用 XmlSerializer 序列化或反序列化对象时重写属性、字段和类特性。
    XmlElementEventArgs               为 UnknownElement 事件提供数据。
    XmlNamespaceDeclarationsAttribute 指定目标属性、参数、返回值或类成员包含与 XML 文档中所用命名空间关联的前缀。
    XmlNodeEventArgs                  为 UnknownNode 事件提供数据。
    XmlSerializer                     将对象序列化到 XML 文档中和从 XML 文档中反序列化对象。XmlSerializer 使您得以控制如何将对象编码到 XML 中。
    XmlSerializerNamespaces           包含 XmlSerializer 用于在 XML 文档实例中生成限定名的 XML 命名空间和前缀。
    XmlTypeMapping                    包含从一种类型到另一种类型的映射。

6、xml序列化答疑

（1）需序列化的字段必须是公共的(public)
    （2）需要序列化的类都必须有一个无参的构造函数
    （3）枚举变量可序列化为字符串，无需用[XmlInclude]
    （4）导出非基本类型对象，都必须用[XmlInclude]事先声明。该规则递归作用到子元素
        如导出ArrayList对象，若其成员是自定义的，需预包含处理：
        using System.Xml.Serialization;
        [XmlInclude(typeof(自定义类))]
    （5）Attribute中的IsNullable参数若等于false，表示若元素为null则不显示该元素。
        也就是说：针对值类型（如结构体）该功能是实效的
        若数组包含了100个空间，填充了10个类对象，则序列化后只显示10个节点
        若数组包含了100个空间，填充了10个结构体对象，则序列化后会显示100个节点
    （6）真正无法XML序列化的情况
        某些类就是无法XML序列化的（即使使用了[XmlInclude]）
            IDictionary（如HashTable）
            System.Drawing.Color
            System.Drawing.Font
            SecurityAttribute声明
        父类对象赋予子类对象值的情况
        对象间循环引用
    （7）对于无法XML序列化的对象，可考虑
        使用自定义xml序列化（实现IXmlSerializable接口）
        实现IDictionary的类，可考虑（1）用其它集合类替代；（2）用类封装之，并提供Add和this函数
        某些类型需要先经过转换，然后才能序列化为 XML。如XML序列化System.Drawing.Color，可先用ToArgb()将其转换为整数
        过于复杂的对象用xml序列化不便的话，可考虑用二进制序列化