C#序列化XML时动态添加字典中的额外元素

嘿，这个需求我之前做类似功能的时候碰到过——默认的XML序列化只会处理类里定义好的固定属性，要动态加不确定数量和名称的元素，得自定义序列化逻辑才行。给你两种亲测好用的方案，按需选：

方案一：实现IXmlSerializable接口（最灵活） #

这是自定义XML序列化逻辑的标准方式，能完全掌控序列化的每一步，刚好适合你这种需要混合固定元素和动态元素的场景。

步骤&代码示例 #

1. 先定义你的主实体类，包含固定的子元素，再加上存额外元素的字典：

public class Element : IXmlSerializable
{
    // 固定的子元素
    public string Subelment1 { get; set; }
    public string Subelement2 { get; set; }

    // 存额外元素的字典
    public Dictionary<string, string> AdditionalElements { get; set; } = new Dictionary<string, string>();

    // IXmlSerializable 接口要求的方法，直接返回null即可
    public XmlSchema GetSchema() => null;

    // 反序列化逻辑（如果需要从XML读回数据的话）
    public void ReadXml(XmlReader reader)
    {
        reader.ReadStartElement("element");
        
        // 读取固定元素
        Subelment1 = reader.ReadElementContentAsString("subelment1", "");
        Subelement2 = reader.ReadElementContentAsString("subelement2", "");

        // 读取剩下的所有动态元素，加到字典里
        while (reader.NodeType != XmlNodeType.EndElement)
        {
            if (reader.NodeType == XmlNodeType.Element)
            {
                var key = reader.LocalName;
                var value = reader.ReadElementContentAsString();
                AdditionalElements[key] = value;
            }
            else
            {
                reader.Read();
            }
        }
        reader.ReadEndElement();
    }

    // 核心：序列化逻辑，先写固定元素，再写字典里的动态元素
    public void WriteXml(XmlWriter writer)
    {
        // 写入固定的子元素
        writer.WriteElementString("subelment1", Subelment1);
        writer.WriteElementString("subelement2", Subelement2);

        // 遍历字典，写入所有额外元素
        foreach (var kvp in AdditionalElements)
        {
            writer.WriteElementString(kvp.Key, kvp.Value);
        }
    }
}

2. 使用示例：

// 创建实例并赋值
var element = new Element
{
    Subelment1 = "text",
    Subelement2 = "text2",
    AdditionalElements = new Dictionary<string, string>
    {
        {"additionalelement1", "element1text"},
        {"additionalelement2", "element2text"}
    }
};

// 序列化到XML
var serializer = new XmlSerializer(typeof(Element));
using var writer = new StringWriter();
serializer.Serialize(writer, element);
var xmlResult = writer.ToString();

这样生成的XML就会是你想要的格式：

text text2 element1text element2text

方案二：用XmlExtensionDataAttribute（更简洁，适合简单场景） #

如果你的需求只是“序列化时把字典里的内容作为额外元素加上”，且不需要太精细的控制，可以用这个属性。不过它的原理是把未知的XML元素存到字节数组，再序列化回去，需要稍微转一下：

代码示例 #

public class Element
{
    public string Subelment1 { get; set; }
    public string Subelement2 { get; set; }

    // 用XmlExtensionData标记，存储额外元素
    [XmlExtensionData]
    public XmlNodeList ExtensionData { get; set; }

    // 辅助方法：把字典转成XmlNodeList
    public void SetAdditionalElements(Dictionary<string, string> elements)
    {
        var doc = new XmlDocument();
        var root = doc.CreateElement("temp");
        foreach (var kvp in elements)
        {
            var elem = doc.CreateElement(kvp.Key);
            elem.InnerText = kvp.Value;
            root.AppendChild(elem);
        }
        ExtensionData = root.ChildNodes;
    }
}

使用的时候先调用SetAdditionalElements把字典转成XmlNodeList，再序列化就行，生成的XML效果和方案一一致。

小提示 #

• 如果你的XML有命名空间，记得在WriteElementString和ReadElementContentAsString里加上对应的命名空间参数，避免序列化后出现多余的命名空间前缀。
• 如果你只需要序列化不需要反序列化，方案一可以只实现WriteXml方法，ReadXml留空或者随便写（但接口要求必须实现）。

内容的提问来源于stack exchange，提问作者waterrabbit