0

0

C# 如何实现自定义的xml序列化逻辑

幻夢星雲

幻夢星雲

发布时间:2025-11-25 18:43:02

|

767人浏览过

|

来源于php中文网

原创

实现IXmlSerializable接口可自定义XML序列化逻辑,需提供无参构造函数并实现ReadXml、WriteXml和GetSchema方法,适用于控制字段映射与兼容特定XML结构。

c# 如何实现自定义的xml序列化逻辑

在 C# 中,如果需要实现自定义的 XML 序列化逻辑,可以通过实现 IXmlSerializable 接口来完全控制对象如何被序列化和反序列化为 XML。这种方式适用于标准的 XmlSerializer,允许你自定义字段映射、处理特殊数据格式或兼容已有 XML 结构。

实现 IXmlSerializable 接口

一个类要支持自定义 XML 序列化,需实现 IXmlSerializable 接口,该接口包含三个成员:

  • ReadXml(XmlReader reader):从 XmlReader 中读取数据并还原对象状态
  • WriteXml(XmlWriter writer):将对象数据写入 XmlWriter
  • GetSchema():通常返回 null,因为一般不需要 XSD 支持

red">注意:必须提供无参构造函数,否则 XmlSerializer 反序列化时会失败。

示例:自定义序列化 Person 类

假设有一个 Person 类,希望将其序列化为如下格式:


  Alice
  30

但内部字段命名不同,且想控制输出顺序和格式:

晓象AI资讯阅读神器
晓象AI资讯阅读神器

晓象-AI时代的资讯阅读神器

下载
using System;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Serialization;

public class Person : IXmlSerializable
{
    public string FullName { get; set; }
    public int YearsOld { get; set; }

    // 必须提供无参构造函数
    public Person() { }

    public Person(string name, int age)
    {
        FullName = name;
        YearsOld = age;
    }

    public XmlSchema GetSchema() => null;

    public void ReadXml(XmlReader reader)
    {
        // 读取开始标签 zuojiankuohaophpcnPersonyoujiankuohaophpcn
        reader.ReadStartElement("Person");

        // 读取子元素
        FullName = reader.ReadElementString("Name");
        YearsOld = int.Parse(reader.ReadElementString("Age"));

        // 读取结束标签
        reader.ReadEndElement();
    }

    public void WriteXml(XmlWriter writer)
    {
        writer.WriteElementString("Name", FullName);
        writer.WriteElementString("Age", YearsOld.ToString());
    }
}

使用自定义序列化类

序列化和反序列化的用法与普通类一致:

using System.IO;
using System.Xml.Serialization;

// 序列化
var person = new Person("Bob", 25);
var serializer = new XmlSerializer(typeof(Person));
using (var writer = new StringWriter())
{
    serializer.Serialize(writer, person);
    Console.WriteLine(writer.ToString());
    // 输出包含 zuojiankuohaophpcnNameyoujiankuohaophpcn 和 zuojiankuohaophpcnAgeyoujiankuohaophpcn 的 XML
}

// 反序列化
using (var reader = new StringReader(xmlString))
{
    var restored = (Person)serializer.Deserialize(reader);
    Console.WriteLine($"{restored.FullName}, {restored.YearsOld}");
}

高级场景与注意事项

在更复杂的场景中,可能需要处理嵌套对象、集合、属性、命名空间或条件输出:

  • WriteXml 中可手动写入属性:writer.WriteAttributeString("id", Id.ToString())
  • ReadXml 中可用 reader.MoveToAttribute("attr") 读取属性
  • 避免调用 reader.Read() 过度,防止解析错位
  • 对于复杂结构,建议先调用 reader.ReadStartElement(),再逐项处理,最后 ReadEndElement()
  • 若字段可为空,注意判断 reader.IsStartElement()

基本上就这些。通过实现 IXmlSerializable,你可以精确控制 XML 的生成与解析过程,适合对接遗留系统或特定协议。虽然比用 DataContract 或自动特性复杂,但灵活性更高。不复杂但容易忽略无参构造和读写平衡。

相关专题

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

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

232

2023.09.22

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

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

436

2024.03.01

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

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

1886

2024.04.01

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

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

2087

2024.08.01

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

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

1017

2024.11.28

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1024

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

66

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

450

2025.12.29

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

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

精品课程

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

共94课时 | 7.1万人学习

C 教程
C 教程

共75课时 | 4.1万人学习

C++教程
C++教程

共115课时 | 12.9万人学习

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

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