C# XmlSerializer和DataContractSerializer有什么区别

XmlSerializer 用于严格匹配 XSD 或跨平台 XML 交换,只序列化 public 成员并支持 XML 属性/命名空间;DataContractSerializer 适用于 WCF 和版本兼容场景,需显式标记 [DataContract]/[DataMember],支持 private 成员和多态。

XmlSerializerDataContractSerializer 都能把 C# 对象转成 XML,但它们根本不是同一类工具——一个讲“结构适配”,一个讲“契约约定”。选错会导致序列化失败、跨平台解析异常、升级后数据读不出来,甚至第三方系统直接拒收。


什么时候必须用 XmlSerializer

当你需要严格匹配某份 XSD、和 Java/PHP 系统交换 XML、或 XML 必须带 xmlns 属性、元素要作为 XML 属性()输出时,XmlSerializer 是唯一靠谱的选择。

  • XmlSerializer 默认只序列化 public 读写属性/字段,不碰 private 成员,也不管你有没有标记 [Serializable](那个是给 BinaryFormatter 用的,加了反而误导自己)
  • 它支持精细控制:[XmlAttribute][XmlElement("EmailAddr")][XmlArray("Phones")][XmlIgnore] 全都生效
  • 生成的 XML 默认带 声明,第三方系统(如 Flex、老版 Java WebService)能直接识别
  • 如果你有现成 XSD,用 xsd.exe 生成的类天然适配它,不用改一行代码
var ser = new XmlSerializer(typeof(User));
using var writer = new StringWriter();
ser.Serialize(writer, new User { Name = "Alice", Id = 42 });
// 输出:Alice42

什么时候该用 DataContractSerializer

在写 WCF 服务、需要版本兼容(比如新增字段不影响旧客户端)、或者想序列化 private 字段、构造函数参数、Dictionary 这类复杂类型时,DataContractSerializer 才是正解。

  • 必须显式标注 [DataContract] 类 + [DataMember] 成员,否则什么都不会序列化(连 public 属性也忽略)
  • 支持 private 字段序列化,支持 KnownType 多态反序列化,支持 null 值保留(XmlSerializer 会直接跳过 null 属性)
  • 默认不输出 XML 声明,且命名空间是 http://schemas.datacontract.org/2004/07/{Namespace},Flex 或 PHP SimpleXML 会报“无法识别命名空间”
  • 数组为空时仍输出空标签:;而 XmlSerializer 直接不写这个节点
var ser = new DataContractSerializer(typeof(User));
using var ms = new MemoryStream();
using var writer = XmlDictionaryWriter.CreateTextWriter(ms);
ser.WriteObject(writer, new User { Name = "Alice" });
// 输出:Alice

常见踩坑点:你以为能混用,其实不能

最典型的是——把 XmlSerializer 生成的 XML 拿去用 DataContractSerializer 反序列化,或者反过来。结果不是抛 InvalidOperationException,就是字段全为默认值(0nullfalse)。

  • XmlSerializer 不认 [DataContract]DataContractSerializer 不认 [XmlElement] —— 它们完全不共享特性体系
  • 第三方库(如 protobuf-net)能同时模拟两者行为,但原生 .NET 运行时里,它们是两套独立引擎,连 XML 命名空间都不同源
  • WCF 默认用 DataContractSerializer,但如果你在 web.config 里配了 binding="basicHttpBinding" 却没关掉 enableWebScript,前端 AJAX 调用可能因缺少 XML 声明而静默失败

简单决策树:先问这三句

你正在对接的 XML 格式是否由别人定死(比如银行接口文档)?→ 用 XmlSerializer

你的对象有 private 字段、继承链、或未来肯定要加字段?→ 用 DataContractSerializer

你压根没得选(比如项目已用 WCF,或必须走 svcutil.exe /serializer:DataContractSerializer)?→ 别挣扎,按契约写 [DataMember]

真正麻烦的从来不是语法,而是当 XML 看似“能跑通”,却在某个字段为 null、某个子类没加 [KnownType]、或者对方系统强制要求 id 是属性而非元素时,才突然崩给你看。