C# XmlSerializer的已知类型(Known Types)怎么用

来源:站长素材作者:仓本头衔:网络博主
导读:本期聚焦于小伙伴创作的《C# XmlSerializer的已知类型(Known Types)怎么用》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《C# XmlSerializer的已知类型(Known Types)怎么用》有用,将其分享出去将是对创作者最好的鼓励。

在C#的XML序列化场景中,当我们需要序列化一个基类类型的属性,但该属性实际存储的是派生类的实例时,默认的XmlSerializer无法识别派生类的结构,会导致序列化失败或者丢失派生类的特有数据。这时候就需要用到Known Types(已知类型)特性,告诉XmlSerializer需要额外识别哪些类型。

C# XmlSerializer的已知类型(Known Types)怎么用

Known Types的核心作用

XmlSerializer在序列化对象时,只会处理序列化目标类型及其直接关联的类型,对于通过多态赋值进来的派生类,默认不会识别。Known Types的作用就是显式声明XmlSerializer需要额外支持的类型列表,让序列化器能够正确处理这些派生类的序列化和反序列化操作。

配置Known Types的两种方式

1. 使用XmlInclude特性标注基类

这是最常用的方式,直接在基类上通过XmlInclude特性声明需要支持的派生类型,XmlSerializer在序列化基类相关对象时会自动识别这些类型。

示例代码如下:

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

// 基类
[XmlInclude(typeof(Dog))]
[XmlInclude(typeof(Cat))]
public class Animal
{
    public string Name { get; set; }
}

// 派生类Dog
public class Dog : Animal
{
    public string BarkSound { get; set; }
}

// 派生类Cat
public class Cat : Animal
{
    public string MeowSound { get; set; }
}

// 包含基类属性的容器类
public class AnimalShelter
{
    public Animal Resident { get; set; }
}

class Program
{
    static void Main()
    {
        // 创建包含派生类实例的容器对象
        AnimalShelter shelter = new AnimalShelter
        {
            Resident = new Dog
            {
                Name = "小黑",
                BarkSound = "汪汪汪"
            }
        };

        // 序列化操作
        XmlSerializer serializer = new XmlSerializer(typeof(AnimalShelter));
        using (StringWriter writer = new StringWriter())
        {
            serializer.Serialize(writer, shelter);
            string xml = writer.ToString();
            Console.WriteLine("序列化结果:");
            Console.WriteLine(xml);

            // 反序列化操作
            using (StringReader reader = new StringReader(xml))
            {
                AnimalShelter deserializedShelter = (AnimalShelter)serializer.Deserialize(reader);
                if (deserializedShelter.Resident is Dog dog)
                {
                    Console.WriteLine($"反序列化结果:名字{dog.Name},叫声{dog.BarkSound}");
                }
            }
        }
    }
}

2. 构造XmlSerializer时传入已知类型列表

如果不想在基类上添加特性,也可以在创建XmlSerializer实例时,通过构造函数传入需要支持的已知类型数组,这种方式更加灵活,适合动态指定类型的场景。

示例代码如下:

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

// 基类不添加XmlInclude特性
public class Animal
{
    public string Name { get; set; }
}

public class Dog : Animal
{
    public string BarkSound { get; set; }
}

public class Cat : Animal
{
    public string MeowSound { get; set; }
}

public class AnimalShelter
{
    public Animal Resident { get; set; }
}

class Program
{
    static void Main()
    {
        AnimalShelter shelter = new AnimalShelter
        {
            Resident = new Cat
            {
                Name = "小白",
                MeowSound = "喵喵喵"
            }
        };

        // 构造时传入已知类型列表
        Type[] knownTypes = new Type[] { typeof(Dog), typeof(Cat) };
        XmlSerializer serializer = new XmlSerializer(typeof(AnimalShelter), knownTypes);

        using (StringWriter writer = new StringWriter())
        {
            serializer.Serialize(writer, shelter);
            string xml = writer.ToString();
            Console.WriteLine("序列化结果:");
            Console.WriteLine(xml);

            using (StringReader reader = new StringReader(xml))
            {
                AnimalShelter deserializedShelter = (AnimalShelter)serializer.Deserialize(reader);
                if (deserializedShelter.Resident is Cat cat)
                {
                    Console.WriteLine($"反序列化结果:名字{cat.Name},叫声{cat.MeowSound}");
                }
            }
        }
    }
}

两种方式的适用场景对比

我们可以通过下表对比两种配置方式的特点,根据实际需求选择:

配置方式优点缺点适用场景
XmlInclude特性标注配置简单,一次标注全局生效,不需要每次构造序列化器时重复传入需要修改基类代码,不够灵活,新增派生类需要修改基类特性已知所有派生类,且基类代码可修改的场景
构造时传入类型列表不需要修改基类代码,可动态指定类型,灵活性高每次创建XmlSerializer都需要传入类型列表,容易遗漏基类代码不可修改,或需要动态支持不同派生类的场景

注意事项

  • 已知类型需要是基类可访问的派生类,否则XmlSerializer无法加载对应类型。
  • 如果派生类还有自己的派生类,也需要一并加入到已知类型列表中,否则下一级派生类还是无法被识别。
  • 使用XmlInclude特性时,如果多个地方都用到了该基类,只需要标注一次即可,不需要重复标注。

XmlSerializerKnown_TypesC#XML序列化反序列化修改时间:2026-07-10 23:45:33

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