在C#的开发场景中,XML序列化常用于将对象转换为可存储或传输的XML格式,或者将XML数据反序列化为对象实例。默认的序列化规则会按照类的属性名直接生成XML元素,当业务对XML的结构有特殊要求时,开发者往往需要编写大量自定义序列化代码,不仅增加工作量,还容易引入错误。而C#提供的特性机制可以在不改动核心业务逻辑的情况下,灵活调整序列化行为,有效减少手动编码量。

常用XML序列化相关特性
C#的System.Xml.Serialization命名空间下提供了多个用于控制XML序列化的特性,以下是开发中最常用的几个:
- XmlElementAttribute:指定属性序列化为XML元素时的名称、命名空间等参数
- XmlAttributeAttribute:指定属性序列化为XML元素的属性而非子元素
- XmlIgnoreAttribute:标记该属性不参与序列化与反序列化过程
- XmlRootAttribute:指定类作为XML根元素时的名称与命名空间
- XmlArrayAttribute:控制集合类型属性序列化为XML数组的行为
特性控制序列化的基本示例
首先定义一个用户信息类,通过特性配置其序列化规则,避免手动编写序列化逻辑:
using System;
using System.Xml.Serialization;
// 配置根元素名称为UserInfo,命名空间为自定义值
[XmlRoot("UserInfo", Namespace = "http://ippipp.com/user")]
public class User
{
// 指定该属性序列化为名为User_Id的XML元素
[XmlElement("User_Id")]
public int Id { get; set; }
// 指定该属性序列化为XML元素的属性,而非子元素
[XmlAttribute("User_Name")]
public string Name { get; set; }
// 该属性不参与序列化
[XmlIgnore]
public string Password { get; set; }
// 指定集合序列化后的数组元素名称为Order,数组外层元素名称为Orders
[XmlArray("Orders")]
[XmlArrayItem("Order")]
public List<string> OrderList { get; set; }
}
接下来编写序列化的调用代码,无需额外手动处理XML结构:
using System;
using System.Collections.Generic;
using System.IO;
using System.Xml.Serialization;
class Program
{
static void Main()
{
User user = new User
{
Id = 1001,
Name = "张三",
Password = "123456",
OrderList = new List<string> { "订单1", "订单2" }
};
XmlSerializer serializer = new XmlSerializer(typeof(User));
using (StringWriter writer = new StringWriter())
{
serializer.Serialize(writer, user);
string xmlResult = writer.ToString();
Console.WriteLine(xmlResult);
}
}
}
上述代码执行后生成的XML内容如下,完全符合特性配置的规则,Password属性因为标记了XmlIgnore没有出现在结果中:
<?xml version="1.0" encoding="utf-16"?>
<UserInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" User_Name="张三" xmlns="http://ippipp.com/user">
<User_Id>1001</User_Id>
<Orders>
<Order>订单1</Order>
<Order>订单2</Order>
</Orders>
</UserInfo>
特性控制减少错误的优势
如果不使用特性,要实现上述XML结构,开发者需要手动拼接XML字符串或者自定义序列化逻辑,很容易出现以下问题:
- 手动拼接字符串时容易出现标签闭合错误、命名不一致的问题
- 修改XML结构时需要同步修改多处序列化代码,容易出现遗漏
- 集合、特殊类型(如日期、枚举)的序列化逻辑需要额外编写,增加出错概率
而通过特性配置,只需要修改类上的特性参数,序列化逻辑会自动适配,所有序列化相关的规则都集中在类的定义处,可读性和可维护性都大幅提升。
注意事项
使用特性控制XML序列化时需要注意以下几点:
- 需要序列化的类必须有无参构造函数,否则
XmlSerializer会抛出异常 - 只有公共属性和公共字段会被序列化,私有成员无法被特性影响
- 如果同时配置了
XmlElement和XmlAttribute,同一个属性只能选择一种序列化方式 - 反序列化时特性的规则同样生效,不需要额外编写反序列化适配代码
通过合理运用C#的特性机制,开发者可以将XML序列化的规则前置到类定义阶段,避免后续重复的手动编码工作,同时减少因手动处理XML结构带来的各类错误,让序列化逻辑更清晰、更稳定。