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

煙雲
发布: 2025-10-31 18:31:01
原创
279人浏览过
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输出格式,比如更改节点名、忽略字段、设置命名空间等。

标书对比王
标书对比王

标书对比王是一款标书查重工具,支持多份投标文件两两相互比对,重复内容高亮标记,可快速定位重复内容原文所在位置,并可导出比对报告。

标书对比王58
查看详情 标书对比王
  • [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之间的互转,适用于配置文件、数据交换等场景。

以上就是C# XmlSerializer用法详解:对象与xml互转的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

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