使用数据协定序列化程序序列化IXmlSerializable对象时，如何控制根元素的名称空间和名称？

Question

我有一个实现IXmlSerializable的类型，我正在使用DataContractSerializer序列化。 将其序列化为XML文档的根元素时，如何控制根元素的名称空间和名称？

说我有以下类型：

public partial class PersonDTO : IXmlSerializable
{
    public string Name { get; set; }

    #region IXmlSerializable Members

    public System.Xml.Schema.XmlSchema GetSchema()
    {
        return null;
    }

    public void ReadXml(System.Xml.XmlReader reader)
    {
        Name = reader["name"];
        if (!reader.IsEmptyElement)
            reader.Skip();
        reader.Read();
    }

    public void WriteXml(System.Xml.XmlWriter writer)
    {
        writer.WriteAttributeString("name", Name);
    }

    #endregion
}

如果我以DataContractSerializer作为我的根对象来序列化它， DataContractSerializer得到：

<PersonDTO name="John Doe" xmlns="http://schemas.datacontract.org/2004/07/MyClrNamespace" />

我希望根名称为<Person> ，而根名称空间为"http://www.MyCompany.com" ，因此我尝试添加[DataContract]如下所示：

[DataContract(Name = "Person", Namespace = "http://www.MyCompany.com")]
public partial class PersonDTO : IXmlSerializable
{
}

但是，当我这样做时， DataContractSerializer引发异常，说明类型'PersonDTO'不能为IXmlSerializable并具有DataContractAttribute属性 ：

System.Runtime.Serialization.InvalidDataContractException occurred
  Message="Type 'PersonDTO' cannot be IXmlSerializable and have DataContractAttribute attribute."
  Source="System.Runtime.Serialization"
  StackTrace:
       at System.Runtime.Serialization.XmlDataContract.XmlDataContractCriticalHelper..ctor(Type type)
       at System.Runtime.Serialization.XmlDataContract..ctor(Type type)
       at System.Runtime.Serialization.DataContract.DataContractCriticalHelper.CreateDataContract(Int32 id, RuntimeTypeHandle typeHandle, Type type)
       at System.Runtime.Serialization.DataContract.DataContractCriticalHelper.GetDataContractSkipValidation(Int32 id, RuntimeTypeHandle typeHandle, Type type)
       at System.Runtime.Serialization.DataContract.GetDataContract(RuntimeTypeHandle typeHandle, Type type, SerializationMode mode)
       at System.Runtime.Serialization.DataContractSerializer.get_RootContract()

我知道可以在手动序列化时通过使用DataContractSerializer(Type type, String rootName, String rootNamespace)构造函数来修改根名称和名称空间：

var person = new PersonDTO { Name = "John Doe", };

var serializer = new DataContractSerializer(typeof(PersonDTO), "Person", @"http://www.MyCompany.com");
var sb = new StringBuilder();
using (var textWriter = new StringWriter(sb))
using (var xmlWriter = XmlWriter.Create(textWriter))
{
    serializer.WriteObject(xmlWriter, person);
}
Console.WriteLine(sb);
// Outputs <Person name="John Doe" xmlns="http://www.MyCompany.com" />

但是，有什么方法可以通过属性自动执行此操作吗？

Answer 1

可以通过以下两种方式之一使用属性来完成此操作。

首先 （令人惊讶的是）如果将旧XmlSerializer的[XmlRoot]属性应用到该类型， DataContractSerializer将使用其中指定的名称空间和名称作为根数据协定名称空间和名称：

[XmlRoot("Person", Namespace = "http://www.MyCompany.com")]
public partial class PersonDTO : IXmlSerializable
{
}

生成以下XML：

<Person name="John Doe" xmlns="http://www.MyCompany.com" />

但是，此解决方案仅适用于根元素名称。 如果尝试序列化此类对象的数组或通用列表，则使用未修改的名称空间和名称：

<ArrayOfPersonDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyClrNamespace">
  <PersonDTO name="John Doe" />
</ArrayOfPersonDTO>

其次 ，更强大的是， [XmlSchemaProvider]属性可用于指定静态方法，该方法返回该类型的数据协定名称，名称空间和架构：

[XmlSchemaProvider("GetSchemaMethod")]
public partial class PersonDTO : IXmlSerializable
{
    // This is the method named by the XmlSchemaProviderAttribute applied to the type.
    public static XmlQualifiedName GetSchemaMethod(XmlSchemaSet xs)
    {
        // Fill in a plausible schema for the type if necessary.
        // 
        // While DataContractSerializer will not use the returned schema set, 
        // svcutil.exe will use it to generate schemas.  XmlSerializer also
        // seems to require it to be initialized to something plausible if you
        // are serializing your types with both serializers.
        string personSchema = @"<xs:schema xmlns:tns=""http://www.MyCompany.com"" elementFormDefault=""qualified"" targetNamespace=""http://www.MyCompany.com"" xmlns:xs=""http://www.w3.org/2001/XMLSchema"">
  <xs:element name=""Person"" nillable=""true"" type=""tns:Person"" />
  <xs:complexType name=""Person"">
    <xs:attribute name=""name"" type=""xs:string"" />
  </xs:complexType>
</xs:schema>";
        using (var textReader = new StringReader(personSchema))
        using (var schemaSetReader = System.Xml.XmlReader.Create(textReader))
        {
            xs.Add("http://www.MyCompany.com", schemaSetReader);
        }
        // Return back the namespace and name to be used for this type.
        return new XmlQualifiedName("Person", "http://www.MyCompany.com");
    }
}

这样做的好处是，不仅将修改根名称和名称空间，而且还将修改数组，泛型集合和其他泛型中使用的数据协定名称：

<ArrayOfPerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.MyCompany.com">
  <Person name="John Doe" />
</ArrayOfPerson>

笔记：

• DataContractSerializer仅使用架构提供者方法返回的XmlQualifiedName 。 但是，如果您打算使用svcutil.exe为您的类型生成XSD或使用XmlSerializer序列化您的类型，则需要在XmlSchemaSet xs填写合理的内容。 （然后，生成的XSD将反映返回的架构。）