如何用XmlSerializer维持同一节点下不同自定义类的原有顺序

问题根源 #

当前类结构把Tab、TabGroup分别放在独立的集合中，XmlSerializer处理时会将同类型元素批量输出，无法保留XML里Tab与TabGroup交叉出现的顺序。

解决方案：使用混合集合+类型标识 #

通过[XmlChoiceIdentifier]特性，将不同类型的元素存入同一个有序集合，同时用枚举标识每个元素的类型，让XmlSerializer能正确识别并保留顺序。

1. 定义类型标识枚举

// 根层级元素类型枚举
public enum TabHierarchyItemType
{
    Tab,
    TabGroup,
    ReportTabs
}

// TabGroup内部元素类型枚举
public enum TabGroupItemType
{
    Tab,
    TabGroup
}

2. 修改XmlTabHierarchy类

替换原有的独立集合为混合集合，关联类型标识：

public class XmlTabHierarchy
{
    public XmlTabHierarchy()
    {
        Items = new List<object>();
        ItemTypes = new List<TabHierarchyItemType>();
    }

    [XmlElement("Tab", typeof(XmlTab))]
    [XmlElement("TabGroup", typeof(XmlTabGroup))]
    [XmlElement("ReportTabs", typeof(XmlReportTab))]
    [XmlChoiceIdentifier("ItemTypes")]
    public List<object> Items { get; set; }

    [XmlIgnore]
    public List<TabHierarchyItemType> ItemTypes { get; set; }
}

3. 修改XmlTabGroup类

同样处理内部的Tab与子TabGroup顺序：

public class XmlTabGroup
{
    public XmlTabGroup()
    {
        Items = new List<object>();
        ItemTypes = new List<TabGroupItemType>();
    }

    [XmlIgnore] public int Order { get; set; }
    [XmlIgnore] public int GroupId { get; set; }
    [XmlAttribute("Name")] public string Group { get; set; }
    [XmlAttribute("Alias")] public string Alias { get; set; }

    [XmlElement("Tab", typeof(XmlTab))]
    [XmlElement("TabGroup", typeof(XmlTabGroup))]
    [XmlChoiceIdentifier("ItemTypes")]
    public List<object> Items { get; set; }

    [XmlIgnore]
    public List<TabGroupItemType> ItemTypes { get; set; }
}

4. 元素遍历与处理

反序列化后，通过类型判断区分集合中的元素：

foreach (var item in hierarchy.Items)
{
    if (item is XmlTab tab)
    {
        // 处理单个Tab逻辑
    }
    else if (item is XmlTabGroup group)
    {
        // 处理TabGroup逻辑，可递归遍历group.Items
    }
    else if (item is XmlReportTab reportTab)
    {
        // 处理ReportTabs逻辑
    }
}

关于ReportTabs的末尾规则 #

反序列化时，XML中末尾的ReportTabs会自动存入Items集合的最后；序列化时，只要保证添加ReportTabs时放在Items的末尾，就能维持该元素在XML中的位置。

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