XmlSerializer通过特性实现自定义XML序列化:一、XmlRootAttribute控制根元素名称、命名空间和空值行为;二、XmlElementAttribute定制字段/属性的元素名、顺序与类型;三、XmlAttributeAttribute将成员转为XML属性;四、XmlArrayAttribute与XmlArrayItemAttribute规范集合序列化结构;五、XmlIgnoreAttribute排除指定成员。

C#中的XmlSerializer类用于将对象序列化为XML格式,或从XML反序列化为对象。当默认的序列化行为无法满足需求时,可通过特性(Attribute)自定义XML元素名称、命名空间、是否忽略属性、控制集合序列化方式等。以下是实现自定义XML序列化格式的多种方法:
一、使用XmlRootAttribute指定根元素
XmlRootAttribute用于控制序列化后XML文档根元素的名称、命名空间和是否为可空。它作用于类声明上,影响整个序列化输出的顶层结构。
1、在类定义上方添加[XmlRoot("Product")],将根元素名设为Product。
2、添加[XmlRoot(Namespace = "http://example.com/inventory")]以指定XML命名空间。
3、添加[XmlRoot(IsNullable = false)]确保根元素不生成xsi:nil="true"属性。
二、使用XmlElementAttribute控制字段/属性的XML表示
XmlElementAttribute用于定制类中某个公共字段或属性在XML中对应的元素名称、顺序、数据类型及是否为必需项。它可精确控制每个成员的序列化外观。
1、在属性上标注[XmlElement("ProductName")],使该属性序列化为而非默认的属性名。
2、添加[XmlElement(ElementName = "Price", DataType = "decimal")]显式声明数据类型,影响XSD生成和解析兼容性。
3、使用[XmlElement(Order = 2)]设定该元素在XML中的出现顺序,确保Price出现在ProductName之后。
三、使用XmlAttributeAttribute将成员序列化为XML属性
XmlAttributeAttribute使字段或属性不再作为子元素,而是作为父元素的XML属性输出,适用于ID、版本号、状态码等元数据类信息。
1、在字段上添加[XmlAttribute("id")],使其序列化为中的id属性。
2、对布尔类型成员应用[XmlAttribute("isActive")],序列化结果为isActive="true"或isActive="false"。
3、若需属性值为空字符串时仍保留该属性,无需额外设置;XmlSerializer默认输出所有标记为XmlAttribute的成员,即使其值为null或空字符串(对于引用类型需配合DefaultValueAttribute避免输出)。
四、使用XmlArrayAttribute和XmlArrayItemAttribute定制集合序列化
默认情况下,List
1、对List属性添加[XmlArray("TagGroup")],外层生成节点。
2、在相同属性上叠加[XmlArrayItem("Tag")],使每个字符串项变为而非默认的。
3、若集合包含多态类型,可在[XmlArrayItem(typeof(DerivedClass), ElementName = "Derived")]中注册派生类映射,否则反序列化时会因类型未知而抛出InvalidOperationException。
五、使用XmlIgnoreAttribute排除成员序列化
XmlIgnoreAttribute用于完全跳过某个公共字段或属性,使其不出现在生成的XML中。适用于临时计算字段、敏感信息或与当前XML Schema无关的成员。
1、在密码字段上添加[XmlIgnore],确保Password属性不会被写入XML。
2、对只读属性(仅有get访问器)默认不参与序列化,但若显式添加了[XmlElement],则必须同时加[XmlIgnore]才能禁用——XmlSerializer仅序列化可读可写的公共成员,且特性优先级高于默认规则。
3、若某属性需在特定条件下忽略,不能动态控制XmlIgnore;此时应改用实现IXmlSerializable接口的方式进行完全自定义。










