如何为带命名空间的XML创建C#类层次并解决反序列化问题

问题背景 #

目标XML片段：

<Root xmlns:c="Ala ma kota">

<!-- 其他节点 -->

        <c:Histogram>
            <Data Width="10" Height="20" />
        </c:Histogram>

<!-- 其他节点 -->

</Root>

反序列化逻辑：从XmlDocument中提取c:Histogram节点，使用其OuterXml作为XmlSerializer的数据源。

最初编写的C#模型类：

[XmlRoot("Histogram", Namespace = "Ala ma kota")]
public class Histogram 
{
    [XmlElement]
    public Data Data { get; set; }
}

[XmlRoot]
public class Data
{
    [XmlAttribute]
    public int Width { get; set; }

    [XmlAttribute]
    public int Height { get; set; }
}

反序列化过程无异常，但Histogram对象的Data属性始终为null。通过XmlSerializer.UnknownNode事件确认，XML中的<Data>元素被识别为未知节点。仅当给Data类添加Namespace = "Ala ma kota"，且XML中<Data>加上c:前缀时，反序列化才能正常完成。

核心疑问 #

1. 若根节点使用带前缀的命名空间，默认命名空间是什么？能否显式定义默认命名空间以正确反序列化内部模型类？
   示例XML：

<Root>      <!-- 默认命名空间为空 -->
  <Data />    <!-- 属于默认命名空间 -->
</Root>

<c:Root xmlns:c="Ala ma kota">  <!-- 命名空间为"Ala ma kota" -->
    <Data />                    <!-- 命名空间为？ -->
</c:Root>

2. 是否可以重新定义模型类，避免在C#中到处添加Namespace = 以及在XML中到处添加c:前缀？
3. 是否可以移除“内部根”元素的命名空间，使反序列化正常工作？

当前临时方案是在<c:Histogram>内新增<Config>元素包裹<Data>，转而反序列化<Config>的子元素，但需要无需额外XML结构修改的解决方案。

针对性解答与方案 #

疑问1解答 #

• 当根节点仅声明带前缀的命名空间（如<c:Root xmlns:c="Ala ma kota">），默认命名空间仍为空字符串。此时无前缀的<Data>元素属于默认空命名空间，和父节点的带前缀命名空间不匹配，导致反序列化无法识别。
• 若能修改XML结构，可显式设置默认命名空间，例如将根节点改为<Root xmlns="Ala ma kota" xmlns:c="Ala ma kota">，这样所有无前缀元素都会继承默认命名空间。若无法修改XML，则需在代码层面适配。

疑问2解答 #

可以通过两种方式避免重复设置命名空间：

方案1：指定序列化器的默认命名空间

创建XmlSerializer时传入目标命名空间，让所有未显式设置命名空间的模型成员自动匹配该命名空间：

// 创建序列化器时指定默认命名空间为"Ala ma kota"
var serializer = new XmlSerializer(typeof(Histogram), "Ala ma kota");
// 反序列化节点的OuterXml
var histogram = (Histogram)serializer.Deserialize(new StringReader(histogramNode.OuterXml));

调整后的模型类：

[XmlRoot("Histogram", Namespace = "Ala ma kota")]
public class Histogram 
{
    [XmlElement] // 自动使用序列化器的默认命名空间
    public Data Data { get; set; }
}

// 无需设置XmlRoot，直接用XmlType统一指定类型对应的命名空间（可选）
[XmlType(Namespace = "Ala ma kota")]
public class Data
{
    [XmlAttribute]
    public int Width { get; set; }

    [XmlAttribute]
    public int Height { get; set; }
}

方案2：显式指定子元素的空命名空间

如果XML中的<Data>确实属于空命名空间，可在模型类中给Data属性指定空命名空间，匹配XML结构：

[XmlRoot("Histogram", Namespace = "Ala ma kota")]
public class Histogram 
{
    // 显式指定Data元素属于空命名空间
    [XmlElement(Namespace = "")]
    public Data Data { get; set; }
}

public class Data
{
    [XmlAttribute]
    public int Width { get; set; }

    [XmlAttribute]
    public int Height { get; set; }
}

疑问3解答 #

可以通过修改XmlNode的命名空间属性，让内部元素的命名空间与模型匹配：

XmlNode histogramNode = ...; // 获取到的c:Histogram节点
// 遍历子元素，修改其命名空间为空（或与父节点一致）
foreach (XmlNode child in histogramNode.ChildNodes)
{
    if (child.NodeType == XmlNodeType.Element)
    {
        ((XmlElement)child).SetAttribute("xmlns", "");
    }
}
// 使用修改后的节点OuterXml反序列化
var serializer = new XmlSerializer(typeof(Histogram));
var histogram = (Histogram)serializer.Deserialize(new StringReader(histogramNode.OuterXml));

这种方式无需修改原始XML文件结构，仅在内存中调整节点属性即可适配反序列化。

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