C#如何用XmlSerializer处理继承关系

来源:APP编程网作者:樱由罗头衔:网络博主
导读:本期聚焦于小伙伴创作的《C#如何用XmlSerializer处理继承关系》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《C#如何用XmlSerializer处理继承关系》有用,将其分享出去将是对创作者最好的鼓励。

在C#中使用XmlSerializer进行XML序列化时,当存在类的继承关系,直接序列化子类对象会抛出InvalidOperationException异常,提示无法识别子类的类型。这是因为XmlSerializer在序列化时默认只会识别声明时指定的类型,不会自动处理继承体系中的其他类型,此时需要借助XmlInclude属性来告知序列化器需要处理的所有派生类型。

C#如何用XmlSerializer处理继承关系

XmlInclude属性的基本用法

XmlInclude是System.Xml.Serialization命名空间下的一个特性,用于标记在序列化当前类型时,需要一并识别的派生类型。它只能应用在基类上,告知XmlSerializer在序列化基类实例时,如果遇到指定的派生类型,可以按照对应的类型规则进行序列化。

假设我们有一个基类Animal,以及两个派生类DogCat,我们希望能够统一序列化Animal类型的集合,包含不同的派生类实例。

定义基类和派生类

首先在基类上添加XmlInclude特性,指定所有需要支持的派生类型:

using System;
using System.Xml.Serialization;

// 在基类上标记需要支持的派生类型
[XmlInclude(typeof(Dog))]
[XmlInclude(typeof(Cat))]
public class Animal
{
    public string Name { get; set; }
}

public class Dog : Animal
{
    // 狗的特有属性
    public string Breed { get; set; }
}

public class Cat : Animal
{
    // 猫的特有属性
    public int Age { get; set; }
}

执行序列化操作

接下来创建包含不同派生类实例的集合,使用XmlSerializer进行序列化:

using System;
using System.Collections.Generic;
using System.IO;
using System.Xml.Serialization;

class Program
{
    static void Main()
    {
        // 创建包含不同派生类实例的基类集合
        List<Animal> animals = new List<Animal>
        {
            new Dog { Name = "大黄", Breed = "金毛" },
            new Cat { Name = "小白", Age = 2 }
        };

        // 创建XmlSerializer实例,指定序列化类型为基类List<Animal>
        XmlSerializer serializer = new XmlSerializer(typeof(List<Animal>));
        
        // 将序列化结果输出到控制台
        using (StringWriter writer = new StringWriter())
        {
            serializer.Serialize(writer, animals);
            string xmlResult = writer.ToString();
            Console.WriteLine(xmlResult);
        }
    }
}

运行上述代码后,生成的XML会包含每个实例的实际类型信息,例如<Dog><Cat>节点,同时会保留各自的特有属性,序列化过程不会抛出异常。

XmlInclude的注意事项

  • XmlInclude必须应用在基类上,如果应用在派生类上不会生效,无法让序列化器识别该派生类。
  • 如果继承层级较多,比如孙子类继承子类,子类继承基类,那么需要在基类上同时标记子类和孙子类,或者在子类上标记孙子类,但最终序列化器能识别的所有类型都需要通过XmlInclude显式声明。
  • 如果派生类型较多,逐个添加XmlInclude会比较繁琐,也可以通过XmlAttributeOverrides动态指定需要序列化的类型,但XmlInclude是更简洁的静态声明方式,适合类型固定的场景。

反序列化时的处理

添加了XmlInclude之后,反序列化时XmlSerializer会根据XML中的节点名称自动识别对应的类型,不需要额外的配置。例如对上述生成的XML进行反序列化:

using System;
using System.Collections.Generic;
using System.IO;
using System.Xml.Serialization;

class Program
{
    static void Main()
    {
        string xml = @"<?xml version=""1.0"" encoding=""utf-16""?>
<ArrayOfAnimal xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xmlns:xsd=""http://www.w3.org/2001/XMLSchema"">
  <Dog>
    <Name>大黄</Name>
    <Breed>金毛</Breed>
  </Dog>
  <Cat>
    <Name>小白</Name>
    <Age>2</Age>
  </Cat>
</ArrayOfAnimal>";

        XmlSerializer serializer = new XmlSerializer(typeof(List<Animal>));
        using (StringReader reader = new StringReader(xml))
        {
            List<Animal> animals = (List<Animal>)serializer.Deserialize(reader);
            foreach (var animal in animals)
            {
                Console.WriteLine($"类型:{animal.GetType().Name},名称:{animal.Name}");
                if (animal is Dog dog)
                {
                    Console.WriteLine($"品种:{dog.Breed}");
                }
                else if (animal is Cat cat)
                {
                    Console.WriteLine($"年龄:{cat.Age}");
                }
            }
        }
    }
}

反序列化后可以得到正确的派生类实例,并且各自的特有属性也会被正确赋值,不会出现类型丢失的问题。

XmlSerializerC#_XmlIncludeXML序列化继承序列化修改时间:2026-07-11 23:18:12

免责声明:​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰,观点力求客观中立。本站旨在免费分享,内容仅供个人学习、研究或参考使用。若引用了第三方作品,版权归原作者所有。如内容涉及您的权益,请联系我们处理。
内容垂直聚焦
专注技术核心技术栏目,确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计,为用户提供无干扰的纯技术知识沉淀,精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进,构建清晰学习路径,帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈,深入技术细节与实践难点。无论是数据库优化还是服务器配置,均结合真实场景与代码示例进行剖析,致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程,从数据库操作到服务器运维,形成完整闭环,一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性,步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目,显著缩短从学习到实践的距离,快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代,紧跟主流技术发展趋势,为用户提供经久不衰的学习价值。