0

0

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

幻夢星雲

幻夢星雲

发布时间:2025-12-20 04:25:09

|

823人浏览过

|

来源于php中文网

原创

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

c#的datacontractserializer怎么用 wcf数据契约

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 或文件流)。

ImgGood
ImgGood

免费在线AI照片编辑器

下载
  • 必须确保类型已标记 [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)

相关专题

更多
c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

231

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

436

2024.03.01

java多态详细介绍
java多态详细介绍

本专题整合了java多态相关内容,阅读专题下面的文章了解更多详细内容。

15

2025.11.27

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1878

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2085

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

998

2024.11.28

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1878

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2085

2024.08.01

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

8

2026.01.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
极客学院Java8新特性视频教程
极客学院Java8新特性视频教程

共17课时 | 3.8万人学习

C# 教程
C# 教程

共94课时 | 6.8万人学习

C 教程
C 教程

共75课时 | 4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号