如何为 IXmlSerializable 类型添加命名空间前缀

Question

我有以下class定义

[XmlRoot(ElementName = "person",Namespace = "MyNamespace")]
public class Person : IXmlSerializable
{
    public string FirstName { get; set; }
    [XmlNamespaceDeclarations]
    public XmlSerializerNamespaces Namespaces
    {
        get
        {
            var xmlSerializerNamespaces = new XmlSerializerNamespaces();
            xmlSerializerNamespaces.Add("My", "MyNamespace");
            return xmlSerializerNamespaces;
        }
    }

    public string LastName { get; set; }

    public XmlSchema GetSchema()
    {
        return null;
    }

    /// <exception cref="NotSupportedException"/>
    public void ReadXml(XmlReader reader)
    {
        throw new NotSupportedException();
    }

    public void WriteXml(XmlWriter writer)
    {
        writer.WriteElementString("firstName",FirstName);
        writer.WriteElementString("lastName", LastName);
    }
}

我想用 MyNamespace 的 My: 前缀序列化它，所以当我调用代码时

var xmlSerializer = new XmlSerializer(typeof(Person));
var person = new Person
            { FirstName = "John",LastName = "Doe"};            
xmlSerializer.Serialize(Console.Out, person, person.Namespaces);

我希望得到以下输出：

<?xml version="1.0" encoding="ibm850"?>
<My:person xmlns:My="MyNamespace">
    <My:firstName>John</My:firstName>
    <My:lastName>Doe</My:lastName>
</My:person>

但我得到的不是它，而是以下输出：

<?xml version="1.0" encoding="ibm850"?>
<person xmlns="MyNamespace">
  <firstName>John</firstName>
  <lastName>Doe</lastName>
</person>

我知道当我使用 SerializableAttribute 属性而不是从 IXmlSerializable 继承时，写前缀是有效的，但是我的 class该项目要复杂得多，我不能使用默认的 XmlSerializer。

Answer 1

试试下面的方法。

public void WriteXml(XmlWriter writer)
{
    writer.WriteAttributeString("xmlns", "my", null, "MyNamespace");
    writer.WriteElementString("firstName", FirstName);
    writer.WriteElementString("lastName", LastName);
}

Answer 2

是否需要使用XmlSerializer？如果没有，请尝试以下代码：

Person.cs

添加新方法：

public void Serialize(XmlWriter writer)
{
    writer.WriteStartDocument();
    writer.WriteStartElement("My", "Person", "MyNamespace");
    writer.WriteElementString("My", "FirstName", "MyNamespace", FirstName);
    writer.WriteElementString("My", "LastName", "MyNamespace", LastName);
    writer.WriteEndElement();
    writer.WriteEndDocument();
}

用法

var person = new Person { FirstName = "John", LastName = "Doe" };
person.Serialize(new XmlTextWriter(Console.Out));

Answer 3

XmlSerializer 类型不提供任何开箱即用的功能来处理此问题。
如果您真的需要使用 XmlSerializer，您最终会得到一个自定义的 XmlSerializer 实现，它不太开放扩展。出于这个原因，下面的实现更像是一个概念证明，只是为了给你一个想法或一个起点。
为简洁起见，我省略了任何错误处理，只关注您问题中的 Person class 。要处理任何嵌套的复杂属性，仍有一些工作要做。

由于 Serialize 方法不是 virtual 我们必须隐藏它们。主要思想是将所有重载定向到具有自定义实现的单个重载。

由于自定义，我们必须在 Person class 中通过指定 xml 为其属性编写 xml 元素时更加明确要应用的命名空间。

下面的代码

PrefixedXmlSerializer xmlSerializer = new PrefixedXmlSerializer(typeof(Person));
Person person = new Person { 
    FirstName = "John", 
    LastName = "Doe" 
    };
xmlSerializer.Serialize(Console.Out, person, person.Namespaces);

结果

<My:person xmlns:My="MyNamespace">
    <My:firstName>John</My:firstName>
    <My:lastName>Doe</My:lastName>
</My:person>

这一切是否可以接受，由你来决定。
最后，<My:person xmlns:My="MyNamespace"> 等于 <person xmlns="MyNamespace">.

人

[XmlRoot(ElementName = "person", Namespace = NAMESPACE)]
public class Person : IXmlSerializable
{
    private const string NAMESPACE = "MyNamespace";

    public string FirstName { get; set; }

    [XmlNamespaceDeclarations]
    public XmlSerializerNamespaces Namespaces
    {
        get
        {
            var xmlSerializerNamespaces = new XmlSerializerNamespaces();
            xmlSerializerNamespaces.Add("My", NAMESPACE);                
            return xmlSerializerNamespaces;
        }
    }

    public string LastName { get; set; }

    public XmlSchema GetSchema()
    {
        return null;
    }

    /// <exception cref="NotSupportedException"/>
    public void ReadXml(XmlReader reader)
    {
        throw new NotSupportedException();
    }   

    public void WriteXml(XmlWriter writer)
    {
        // Specify the xml namespace.
        writer.WriteElementString("firstName", NAMESPACE, FirstName);
        writer.WriteElementString("lastName", NAMESPACE, LastName);
    }
}

PrefixedXmlSerializer

public class PrefixedXmlSerializer : XmlSerializer
{
    XmlRootAttribute _xmlRootAttribute;


    public PrefixedXmlSerializer(Type type) : base(type)
    {
        this._xmlRootAttribute = type.GetCustomAttribute<XmlRootAttribute>();        
    }


    public new void Serialize(TextWriter textWriter, Object o, XmlSerializerNamespaces namespaces)
    {
        // Out-of-the-box implementation.
        XmlTextWriter xmlTextWriter = new XmlTextWriter(textWriter);
        xmlTextWriter.Formatting = Formatting.Indented;
        xmlTextWriter.Indentation = 2;

        // Call the shadowed version. 
        this.Serialize(xmlTextWriter, o, namespaces, null, null);
    }


    public new void Serialize(XmlWriter xmlWriter, Object o, XmlSerializerNamespaces namespaces, String encodingStyle, String id)
    {
        // Lookup the xml namespace and prefix to apply.
        XmlQualifiedName[] xmlNamespaces = namespaces.ToArray();                                
        XmlQualifiedName xmlRootNamespace =
            xmlNamespaces
                .Where(ns => ns.Namespace == this._xmlRootAttribute.Namespace)
                .FirstOrDefault();

        // Write the prefixed root element with its xml namespace declaration.
        xmlWriter.WriteStartElement(xmlRootNamespace.Name, this._xmlRootAttribute.ElementName, xmlRootNamespace.Namespace);            

        // Write the xml namespaces; duplicates will be taken care of automatically.
        foreach (XmlQualifiedName xmlNamespace in xmlNamespaces)
        {
            xmlWriter.WriteAttributeString("xmlns", xmlNamespace.Name , null, xmlNamespace.Namespace);
        }

        // Write the actual object xml.
        ((IXmlSerializable)o).WriteXml(xmlWriter);

        xmlWriter.WriteEndElement();       
    }
}

如何为 IXmlSerializable 类型添加命名空间前缀

How to add namespace prefix for IXmlSerializable type

xml-serialization

prefix

xml-namespaces

ixmlserializable