C#自定义XML序列化过程 如何处理复杂对象以避免错误

来源:这里教程网 时间:2026-02-21 17:32:01 作者:

在C#中进行XML序列化时,复杂对象常因类型不兼容、循环引用或不可序列化成员导致异常。通过自定义序列化过程,可以有效控制这些情况,避免

InvalidOperationException
NotSupportedException
等错误。

使用 XmlSerializer 控制序列化行为

XmlSerializer 是处理XML序列化的常用类,但默认行为对某些类型(如接口、抽象类、泛型集合)支持有限。要避免错误,需显式控制序列化逻辑。

为属性添加 [XmlElement][XmlAttribute][XmlIgnore],排除无法序列化的字段 对集合类型使用 [XmlArray][XmlArrayItem] 明确指定元素结构 [Serializable] 标记类(虽非必须,但有助于识别)

示例:

[XmlRoot("Person")]
public class Person
{
    [XmlElement("Name")]
    public string Name { get; set; }
    [XmlIgnore]
    public Dictionary<string, object> Metadata { get; set; } // 字典不能直接序列化
    [XmlArray("Friends")]
    [XmlArrayItem("Friend")]
    public List<Person> Friends { get; set; } // 支持嵌套对象
}

处理循环引用和深度嵌套

当对象图中存在循环引用(如 A 引用 B,B 又引用 A),XmlSerializer 会抛出栈溢出或无限递归异常。

手动打破引用链,序列化前将循环属性设为 null 使用中间DTO(数据传输对象)模型,仅包含必要层级结构 实现 IXmlSerializable 接口,完全控制读写过程

实现 IXmlSerializable 示例:

public class Person : IXmlSerializable
{
    public string Name { get; set; }
    public Person Spouse { get; set; } // 可能导致循环
    public XmlSchema GetSchema() => null;
    public void ReadXml(XmlReader reader)
    {
        reader.ReadStartElement();
        Name = reader.ReadElementContentAsString("Name", "");
        // 不读取 Spouse 避免循环
        reader.ReadEndElement();
    }
    public void WriteXml(XmlWriter writer)
    {
        writer.WriteElementString("Name", Name);
        // 不写入 Spouse,防止无限嵌套
    }
}

序列化不可直接支持的类型

DateTimeOffsetTimeSpan、委托、接口等类型无法被直接序列化。

添加“代理”属性,将复杂类型转为字符串或基础类型 使用 [XmlIgnore] 忽略原属性,通过 ShouldSerialize{PropertyName} 控制条件序列化

示例:处理 TimeSpan

public class Schedule
{
    [XmlIgnore]
    public TimeSpan Duration { get; set; }
    [XmlElement("Duration")]
    public string DurationString
    {
        get => Duration.ToString();
        set => Duration = TimeSpan.Parse(value);
    }
    public bool ShouldSerializeDuration() => false; // 禁用自动序列化
}

验证与调试技巧

在运行前检测潜在问题可大幅减少运行时错误。

序列化前检查对象是否为 null 对大型对象图分步测试,确认每一层可序列化 捕获 InvalidOperationException 并输出类型名辅助定位 使用 XmlSerializer.CanDeserialize 方法预判能力

基本序列化代码模板:

var serializer = new XmlSerializer(typeof(Person));
using (var writer = new StringWriter())
{
    try
    {
        serializer.Serialize(writer, person);
        string xml = writer.ToString();
    }
    catch (InvalidOperationException ex)
    {
        // 输出 ex.InnerException 查看根本原因
        Console.WriteLine(ex.InnerException?.Message);
    }
}

基本上就这些。关键是理解哪些类型受支持、主动规避风险点,并在必要时接管整个序列化流程。

相关推荐