C#使用XmlSerializer实现复杂XML的序列化与反序列化

Noah

发布时间：2026-10-14| 6人浏览过

原创

介绍在C#开发中，如何利用内置的 XmlSerializer 类和相应的特性（如 [XmlElement]、[XmlAttribute]），将包含多层级结构的XML文件准确转换为C#对象模型，并支持双向转换。重点解决属性映射、集合处理及自定义类型名称等常见问题。

XML与C#对象的映射原理

System.Xml.Serialization.XmlSerializer 是 .NET 框架中用于 XML 数据交换的核心组件。它遵循一个基本规则：XML 的结构直接由 C# 类的结构和相关特性定义。要将 XML 成功反序列化，必须确保目标类的命名空间和成员特性与 XML 文档严格匹配。

关键特性说明

[XmlElement]：将类成员映射为 XML 的子元素标签。
[XmlAttribute]：将类成员映射为元素的属性。
[XmlArray]：针对集合（如 List）进行特殊处理，指定包裹集合的子容器名称，避免生成重复的元素标签。
[XmlType]：显式指定类生成的根节点或子节点的名称，防止因 C# 类名与 XML 标签不一致导致的解析失败。

定义复杂数据的C#模型

假设我们有一个 default.xml 配置文件，其内容涉及规则配置。对应的 C# 类需要通过上述特性来描述层级关系：

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

namespace XmlConfigDemo
{
    // 根节点 config
    [XmlRoot("config")]
    public class XmlConfig
    {
        // rules 是一个集合，使用 XmlArray 指定外层包裹名为 "rules"
        [XmlArray("rules")]
        [XmlArrayItem("rule")]
        public List<Rule> Rules { get; set; }
    }

    // 内部节点 rule
    [XmlType("rule")]
    public class Rule
    {
        // name 作为 attribute
        [XmlAttribute]
        public string Name { get; set; }

        // params 集合
        [XmlArray("params")]
        [XmlArrayItem("item")]
        public List<ParamItem> Params { get; set; }
    }

    // item 节点
    [XmlType("item")]
    public class ParamItem
    {
        [XmlAttribute]
        public string name { get; set; }
        
        [XmlAttribute]
        public string type { get; set; }
        
        [XmlAttribute]
        public string pattern { get; set; }
    }
}

设计要点

名称一致性：虽然 C# 规范建议使用 PascalCase（如 Name），但 XML 常使用 camelCase（如 name）。当两者不一致时，可使用 [XmlAttribute] 显式指定字符串参数，例如 [XmlAttribute("name")]。
空值处理：XmlSerializer 对 null 集合处理较为敏感，初始化 List 或在反序列化后检查是否为 null 是良好的实践。

执行序列化和反序列化操作

以下是通用的工具类方法，分别用于将对象写入文件和从文件读取对象。

第1步：实现反序列化方法

目的是将 XML 文件转换为内存中的 C# 对象。

public static T DeserializeFromXml<T>(string filePath)
{
    if (!System.IO.File.Exists(filePath))
        throw new FileNotFoundException($"未找到文件: {filePath}");

    using (var reader = new System.IO.StreamReader(filePath))
    {
        var serializer = new System.Xml.Serialization.XmlSerializer(typeof(T));
        return (T)serializer.Deserialize(reader);
    }
}

调用示例：

var config = DeserializeFromXml<XmlConfig>("default.xml");
Console.WriteLine(config.Rules[0].Name); // 输出: namea

第2步：实现序列化方法

目的是将修改后的 C# 对象保存回 XML 文件。

public static void SerializeToXml<T>(string filePath, T obj)
{
    if (obj == null) throw new ArgumentNullException(nameof(obj));

    using (var writer = new System.IO.StreamWriter(filePath))
    {
        var serializer = new System.Xml.Serialization.XmlSerializer(typeof(T));
        serializer.Serialize(writer, obj);
    }
}