C#中XML序列化实战_C#XmlSerializer教程【基础】

冬伟吖_7385

冬伟吖_7385

2026-05-18

995人浏览

原创

xmlserializer 序列化 poco 类需满足:类有 public 无参构造函数;字段/属性为 public 且可读写;泛型集合须用 list 等具体类型而非接口;通过 [xmlignore]、[xmlelement] 等特性控制序列化行为;首次使用有性能开销,建议缓存实例。

c#中xml序列化实战_c#xmlserializer教程【基础】

XmlSerializer 能直接序列化大多数 POCO 类,但必须满足几个硬性条件,否则运行时抛出 InvalidOperationException 或静默失败。

类必须有无参构造函数才能被 XmlSerializer 处理

XmlSerializer 在反序列化时需要通过反射调用默认构造函数创建实例。如果类只定义了带参数的构造函数,Deserialize 会直接失败,错误信息类似:There was an error reflecting type 'MyClass'。

实操建议:

  • 显式声明一个 public MyClass() { },哪怕内容为空
  • 若使用记录(record)或 C# 12 主构造函数语法,需额外补一个无参构造函数,例如:public Person() : this("", 0) { }
  • 抽象基类、接口、sealed 类本身不构成问题,但它们的子类仍需各自提供无参构造函数

字段和属性必须是 public 才会被默认序列化

XmlSerializer 只处理 public 字段和 public 属性(含 get/set),private、protected、internal 成员均被忽略,且不会报错。

常见错误现象:

  • 序列化后 XML 中缺少预期节点,检查对应字段/属性是否为 private string _name; —— 改成 public string Name { get; set; } 即可
  • 只读属性(如 public string FullName => $"{FirstName} {LastName}";)不会被序列化,除非手动用 [XmlElement] 标记并配合 set(但语义上不合理,建议改用计算字段+额外存储字段)
  • public List<item> Items { get; } = new();</item> 这种只读集合属性无法反序列化(因无 set),应改为 public List<item> Items { get; set; } = new();</item>

数组、List 和嵌套对象能直接序列化,但要注意类型声明方式

XmlSerializer 对泛型集合支持有限:它原生支持 ArrayList、T[]、List<t></t>(.NET Framework 2.0+),但不支持 IList<t></t>、ICollection<t></t> 等接口类型作为属性类型。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

使用场景与参数差异:

  • 用 public Item[] Items { get; set; } 最稳妥,生成 XML 是重复的 <items>...</items> 元素
  • 用 public List<item> Items { get; set; }</item> 也可行,但需确保 Item 类本身可被序列化(含无参构造函数等)
  • 若属性类型是 public IList<item> Items { get; set; }</item>,运行时会抛出 InvalidOperationException:“Cannot serialize interface”——必须改成具体实现类型
  • 嵌套对象无需额外配置,只要其类型满足前述条件(public 属性 + 无参构造函数),XmlSerializer 会自动递归处理

忽略字段、重命名元素、控制空值行为要用特性标注

默认行为往往不够用:比如想跳过某个敏感字段、把 CustomerName 输出为 <name></name>、让 null 值不生成对应 XML 元素。这些都得靠特性。

关键特性与典型用法:

  • 跳过字段:[XmlIgnore] 加在属性上,如 [XmlIgnore] public string ApiKey { get; set; }
  • 重命名元素:[XmlElement("name")] 让属性输出为 <name>xxx</name>;[XmlAttribute("id")] 输出为 <item id="123"></item>
  • 控制 null 行为:[XmlElement(IsNullable = true)] 会让 null 值输出为 <field xsi:nil="true"></field>;设为 false(默认)则完全不输出该元素
  • 指定根节点名:[XmlRoot("customer-list")] 作用于类,影响整个 XML 的最外层标签

注意:[NonSerialized] 对 XmlSerializer 无效,它只对 BinaryFormatter 起作用;同样,[DataContract] 系列特性也不被 XmlSerializer 识别。

最容易被忽略的是:即使所有代码写对了,第一次调用 new XmlSerializer(typeof(MyClass)) 时,.NET 会动态生成临时序列化程序集,这个过程有明显延迟。高频调用场景下建议缓存 XmlSerializer 实例,或用 Sgen.exe 预生成序列化程序集。否则你会在性能分析中看到意外的 JIT 和反射开销。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

952

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

2691

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

845

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2595

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

292

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

369

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

611

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

309

20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习