讲师中心 微信公众号
AI工具推荐 视频效率加速

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

冬伟吖_7385

冬伟吖_7385

发布时间:2026-05-18 15:12:35

|

995人浏览过

|

来源于php中文网

原创

XmlSerializer 序列化 POCO 类需满足:类有 public 无参构造函数;字段/属性为 public 且可读写;泛型集合须用 List<T> 等具体类型而非接口;通过 [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(); 这种只读集合属性无法反序列化(因无 set),应改为 public List<Item> Items { get; set; } = new();

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

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

C#
C#

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

下载

使用场景与参数差异:

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

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

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

关键特性与典型用法:

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

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

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

热门AI工具

更多
切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

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

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

952

2023.08.08

什么是c#
什么是c#

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

2691

2023.08.31

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

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

845

2024.03.13

C#Task用法
C#Task用法

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

2595

2024.03.14

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

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

292

2026.02.03

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

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

369

2026.02.06

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

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

611

2026.03.11

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

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

309

2026.04.13

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

0

2026.10.10

热门下载

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

精品课程

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

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn