0

0

C# XmlSerializer用法详解:对象与xml互转

煙雲

煙雲

发布时间:2025-10-31 18:31:01

|

319人浏览过

|

来源于php中文网

原创

XmlSerializer是C#中用于对象与XML互转的常用工具,需使用System.Xml.Serialization命名空间。首先,类必须为公共且具有无参构造函数,仅序列化公共读写属性。通过示例Person类展示序列化过程:创建XmlSerializer实例,利用StringWriter将对象转为XML字符串,输出包含Name、Age、Email等元素的标准格式。反序列化时,使用StringReader读取XML并还原为对象,要求结构严格匹配,否则抛异常。通过特性可自定义序列化行为:[XmlElement]更改节点名,[XmlAttribute]将属性作为XML属性输出,[XmlIgnore]忽略敏感字段,[XmlRoot]设置根元素名称。集合处理支持List和数组,使用[XmlArray]和[XmlArrayItem]控制容器与项标签。注意Dictionary不被直接支持,避免循环引用,首次序列化因动态生成程序集较慢,建议静态缓存XmlSerializer实例以提升性能。适用于配置文件读写与数据交换场景。

c# xmlserializer用法详解:对象与xml互转

在C#开发中,XmlSerializer 是处理对象与XML之间序列化和反序列化的常用工具。它属于 System.Xml.Serialization 命名空间,使用简单、功能强大,适合将 .NET 对象转换为 XML 格式保存或传输,也支持从 XML 还原为对象。

一、基本用法:对象转XML(序列化)

要将一个对象序列化为XML字符串,需确保类是公共的,并具有无参构造函数。以下是一个示例:

public class Person { public string Name { get; set; } public int Age { get; set; } public string Email { get; set; } }

使用 XmlSerializer 将 Person 实例转为 XML:

using System.IO; using System.Xml.Serialization; Person person = new Person { Name = "张三", Age = 28, Email = "zhangsan@example.com" }; XmlSerializer serializer = new XmlSerializer(typeof(Person)); using (StringWriter writer = new StringWriter()) { serializer.Serialize(writer, person); string xml = writer.ToString(); Console.WriteLine(xml); }

输出结果类似:

<Person> <Name>张三</Name> <Age>28</Age> <Email>zhangsan@example.com</Email> </Person>

二、XML转对象(反序列化)

将之前生成的XML字符串还原为 Person 对象:

string xml = @"<Person><Name>张三</Name><Age>28</Age><Email>zhangsan@example.com</Email></Person>"; XmlSerializer serializer = new XmlSerializer(typeof(Person)); using (StringReader reader = new StringReader(xml)) { Person restored = (Person)serializer.Deserialize(reader); Console.WriteLine($"姓名:{restored.Name},年龄:{restored.Age}"); }

注意:反序列化时传入的XML必须与目标类结构匹配,否则会抛出异常。

三、控制序列化行为:特性(Attributes)

通过添加特性可以自定义XML输出格式,比如更改节点名、忽略字段、设置命名空间等。

Cardify卡片工坊
Cardify卡片工坊

使用Markdown一键生成精美的小红书知识卡片

下载
  • [XmlElement("CustomName")]:指定元素名称
  • [XmlAttribute]:将属性序列化为XML属性而非子元素
  • [XmlIgnore]:跳过该字段/属性
  • [DefaultValue]:默认值不输出到XML
  • [XmlRoot("CustomRoot")]:设置根元素名称

示例:

[XmlRoot("Customer")] public class Person { [XmlElement("FullName")] public string Name { get; set; } [XmlAttribute] public int Age { get; set; } [XmlIgnore] public string Password { get; set; } }

生成的XML如下:

<Customer Age="28"> <FullName>张三</FullName> </Customer>

四、处理集合与数组

XmlSerializer 支持 List、T[] 等集合类型。默认情况下,集合会被包装在一个容器元素中。

public class PeopleList { [XmlArray("Items")] [XmlArrayItem("Person")] public List Persons { get; set; } }

这样生成的XML更清晰:

<PeopleList> <Items> <Person Age="28"><FullName>张三</FullName></Person> <Person Age="30"><FullName>李四</FullName></Person> </Items> </PeopleList>

使用 XmlArrayXmlArrayItem 可以分别控制集合标签和项标签名称。

五、注意事项与常见问题

  • 类必须有公共无参构造函数,否则序列化失败
  • 只支持公共读写属性(Property),不序列化字段(Field)除非特殊处理
  • 泛型集合如 List 支持良好,但 Dictionary 不被直接支持
  • 避免循环引用,XmlSerializer 不支持对象图中存在循环引用
  • 性能方面:首次序列化较慢(因动态生成程序集),可考虑缓存 XmlSerializer 实例

建议创建 XmlSerializer 实例时复用,避免频繁创建影响性能:

private static readonly XmlSerializer _serializer = new XmlSerializer(typeof(Person)); 基本上就这些。掌握 XmlSerializer 的基本用法和特性控制,就能高效实现对象与XML之间的互转,适用于配置文件、数据交换等场景。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1051

2023.08.02

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

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

1949

2024.04.01

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

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

2119

2024.08.01

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

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

1172

2024.11.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1570

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

651

2023.11.24

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 11.4万人学习

C 教程
C 教程

共75课时 | 5.5万人学习

C++教程
C++教程

共115课时 | 22万人学习

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

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