C# XmlSerializer根元素命名空间前缀缺失问题及解决

最近发现好多开发者都踩过同一个坑——给带命名空间的XML类做序列化时，明明定义了命名空间前缀，结果序列化出来的XML里前缀直接丢了！我之前也碰到过这个问题，现在把解决方案分享给大家。

先看一下大家常写的问题代码：

[XmlRoot(ElementName = "Preadvice", Namespace = "http://www.wibble.com/PreadviceRequest")]
public class Preadvice { }

// 定义命名空间前缀
var XMLNameSpaces = new XmlSerializerNamespaces();
XMLNameSpaces.Add("isd", "http://www.wibble.com/PreadviceRequest");

// 自定义的序列化方法（这里可能存在问题）
public static string SerializeStandard...

问题根源 #

大部分情况下，问题出在自定义序列化方法没有把XmlSerializerNamespaces实例传递给Serialize方法。XmlSerializer不会自动识别你定义的前缀映射，必须在序列化时明确传入这个参数，前缀才会生效。

正确的实现方式 #

修改你的自定义序列化方法，确保传入并使用XmlSerializerNamespaces：

public static string SerializeStandard<T>(T obj, XmlSerializerNamespaces namespaces)
{
    using (var stringWriter = new StringWriter())
    {
        var serializer = new XmlSerializer(typeof(T));
        // 关键：把命名空间前缀映射传给Serialize方法
        serializer.Serialize(stringWriter, obj, namespaces);
        return stringWriter.ToString();
    }
}

调用的时候直接传入我们定义好的前缀映射：

var preAdviceInstance = new Preadvice();
var serializedXml = SerializeStandard(preAdviceInstance, XMLNameSpaces);

额外注意事项 #

• 一定要保证XmlRoot（或内部属性的XmlElement/XmlAttribute）的Namespace和你添加到XmlSerializerNamespaces里的命名空间完全一致，哪怕一个空格或者拼写错误都会导致前缀不生效
• 如果类内部的属性也需要带命名空间前缀，记得给对应的属性标记[XmlElement(Namespace = "xxx")]，同时把前缀和命名空间的映射添加到XmlSerializerNamespaces中

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