信息发布→ 登录 注册 退出

C#的DataContractSerializer怎么用 WCF数据契约

发布时间:2025-12-20

点击量:
DataContractSerializer 是 WCF 中配合 [DataContract] 和 [DataMember] 特性实现数据序列化与反序列化的核心类,要求显式标记可序列化成员,支持命名空间、顺序、默认值控制及多态扩展。

DataContractSerializer 是 WCF 中用于序列化和反序列化数据的核心类,专门配合 [DataContract][DataMember] 特性使用,确保类型能被 WCF 正确传输和解析。

定义可序列化的数据契约

[DataContract] 标记类,用 [DataMember] 标记需要参与序列化的字段或属性。不加 [DataMember] 的成员默认不序列化(包括 public 字段)。

示例:

[DataContract]
public class Person
{
    [DataMember]
    public string Name { get; set; }

    [DataMember]
    public int Age { get; set; }

    // 这个不会被序列化
    public string InternalNote { get; set; }

    // 可选:指定名称、顺序、是否必需、是否应忽略
    [DataMember(Name = "ID", Order = 0, IsRequired = true, EmitDefaultValue = false)]
    public int PersonId { get; set; }
}

用 DataContractSerializer 序列化对象到 XML

创建 DataContractSerializer 实例时传入类型;用 WriteObject 写入流(如 MemoryStream 或文件流)。

  • 必须确保类型已标记 [DataContract],否则抛出异常
  • 推荐显式指定命名空间(如 "http://mycompany.com/person"),避免默认命名空间导致互操作问题
  • 若需格式化输出(带缩进),可传入 XmlWriterSettings
var person = new Person { Name = "Alice", Age = 30, PersonId = 101 };

var serializer = new DataContractSerializer(typeof(Person), 
    new DataContractSerializerSettings { 
        PreserveObjectReferences = true // 如需处理循环引用,设为 true
    });

using var stream = new MemoryStream();
using (var writer = XmlDictionaryWriter.CreateTextWriter(stream, Encoding.UTF8))
{
    serializer.WriteObject(writer, person);
}
string xml = Encoding.UTF8.GetString(stream.ToArray());

从 XML 反序列化回对象

ReadObject 方法从流中读取并还原对象。注意流位置需在开头,且 XML 结构必须与契约严格匹配(命名空间、元素名、嵌套层级)。

  • 如果 XML 含未知元素,默认会跳过;可通过 DataContractSerializerSettings.KnownTypes 添加派生类型支持多态
  • 反序列化失败通常因命名空间不一致、元素名拼写错误或类型不匹配,建议先用 XmlDictionaryReader 检查原始 XML
  • 若服务端返回的是带 Envelope 的 SOAP 响应,不能直接用 DataContractSerializer 解析 —— 它只处理纯数据部分
var xmlBytes = Encoding.UTF8.GetBytes(xml);
using var stream = new MemoryStream(xmlBytes);
using (var reader = XmlDictionaryReader.CreateTextReader(stream, new XmlDictionaryReaderSettings()))
{
    var deserialized = (Person)serializer.ReadObject(reader);
}

常见注意事项

WCF 默认使用 DataContractSerializer,但你也可以在绑定或行为中替换为 XmlSerializer(需手动配置)。实际开发中要注意:

  • [DataMember]EmitDefaultValue 设为 false 可让值为默认值(如 0、null)的字段不出现在 XML 中
  • 集合类型推荐用 List 或数组;自定义集合需实现 IList 并标记 [CollectionDataContract]
  • 枚举默认按名称序列化;加 [EnumMember] 可控制别名,或用 [DataContract] + [EnumMember] 禁用未标记项
  • 不要在数据契约中放方法、事件、非公共字段(除非显式标记 [DataMember] 且为 public set)
标签:# 事件  # 如需  # 可通过  # 可选  # 自定义  # 不出  # 的是  # 默认值  # 设为  # 序列化  # http  # stream  # 对象  # public  # 派生类型  # xml  # 多态  # 命名空间  # NULL  # red  # 格式化输出  # c#  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!