C# XML自定义rsm命名空间序列化与反序列化问题解决

核心问题分析 #

你遇到的问题本质是没有统一配置命名空间映射，且未在序列化时显式指定前缀绑定。仅给类加Namespace属性，若未通过XmlSerializerNamespaces关联前缀，序列化器不会自动生成指定前缀，也可能导致嵌套元素的命名空间不统一。

正确模型编写与序列化步骤 #

1. 统一配置类的命名空间 #

给所有需要带rsm前缀的类（包括根类和嵌套类）设置一致的命名空间，通过XmlRoot或XmlType特性指定：

// 根类
[XmlRoot(Namespace = "http://example.com/rsm", ElementName = "RootElement")]
public class RootModel
{
    [XmlElement(Namespace = "http://example.com/rsm")]
    public ChildModel Child { get; set; }
    
    [XmlElement(Namespace = "http://example.com/rsm")]
    public string SomeProperty { get; set; }
}

// 嵌套类
[XmlType(Namespace = "http://example.com/rsm")]
public class ChildModel
{
    [XmlElement(Namespace = "http://example.com/rsm")]
    public int Id { get; set; }
    
    [XmlElement(Namespace = "http://example.com/rsm")]
    public string Name { get; set; }
}

注意：所有需要带rsm前缀的元素，其XmlElement特性的Namespace必须和根类的命名空间完全一致

2. 序列化时显式指定前缀映射 #

使用XmlSerializerNamespaces将命名空间和rsm前缀绑定，这样序列化器会自动生成xmlns:rsm声明，并给所有对应命名空间的元素添加前缀：

public static string SerializeToXml(RootModel model)
{
    var serializer = new XmlSerializer(typeof(RootModel));
    // 创建命名空间映射，绑定rsm前缀到目标命名空间
    var namespaces = new XmlSerializerNamespaces();
    namespaces.Add("rsm", "http://example.com/rsm");
    
    using var writer = new StringWriter();
    // 序列化时传入namespaces参数
    serializer.Serialize(writer, model, namespaces);
    return writer.ToString();
}

3. 反序列化注意事项 #

反序列化时无需额外处理前缀，只要模型的命名空间和XML中的命名空间一致，XmlSerializer会自动识别：

public static RootModel DeserializeFromXml(string xml)
{
    var serializer = new XmlSerializer(typeof(RootModel));
    using var reader = new StringReader(xml);
    return (RootModel)serializer.Deserialize(reader);
}

生成的XML示例 #

执行上述代码后，生成的XML会包含正确的命名空间声明和rsm前缀：

<?xml version="1.0" encoding="utf-16"?>
<rsm:RootElement xmlns:rsm="http://example.com/rsm">
  <rsm:Child>
    <rsm:Id>1</rsm:Id>
    <rsm:Name>TestChild</rsm:Name>
  </rsm:Child>
  <rsm:SomeProperty>TestValue</rsm:SomeProperty>
</rsm:RootElement>

常见误区规避 #

• 不要给不同类设置不同的命名空间，否则前缀无法统一
• 序列化时必须传入XmlSerializerNamespaces，否则即使类设置了Namespace，也只会生成默认的命名空间声明（无前缀）
• 嵌套元素的XmlElement必须显式指定Namespace，否则会继承父元素的命名空间，但部分场景下可能被序列化器忽略

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