初步问题

Question

初步问题

我希望serialize List<IXmlSerializable>动态更改IXmlSerializable类的 XmlType （因此我无法使用属性标记来执行此操作）

我＆＃39;我们试图使用 XmlAttributeOverrides 来做到这一点，到目前为止没有成功。

以下是说明问题的示例代码：
IXmlSerializable类（来自MSDN）：

public class Person : IXmlSerializable
{
    // Private state
    private string personName;


    // Constructors
    public Person(string name)
    {
        personName = name;
    }

    public Person()
    {
        personName = null;
    }


    // Xml Serialization Infrastructure
    public void WriteXml(XmlWriter writer)
    {
        writer.WriteString(personName);
    }

    public void ReadXml(XmlReader reader)
    {
        personName = reader.ReadString();
    }

    public XmlSchema GetSchema()
    {
        return (null);
    }


    // Print
    public override string ToString()
    {
        return (personName);
    }
}

测试类（使用控制台输出）：

class Program
{
    static void Main(string[] args)
    {
        List<Person> lPersonList = new List<Person> {
            new Person("First"),
            new Person("Second"),
            new Person("Third")
        };
        XmlAttributeOverrides lOverrides = new XmlAttributeOverrides();
        XmlAttributes lAttributes = new XmlAttributes { XmlType = new XmlTypeAttribute("Employee") };
        lOverrides.Add(typeof(Person), lAttributes);

        XmlSerializer lSerialiser = new XmlSerializer(typeof(List<Person>), lOverrides, null, new XmlRootAttribute("Employees"), null);
        XmlSerializerNamespaces lNamespaces = new XmlSerializerNamespaces();
        lNamespaces.Add("", "");
        lSerialiser.Serialize(Console.Out, lPersonList, lNamespaces);

        System.Console.WriteLine("Enter any key to close.");
        System.Console.ReadKey();
    }
}

这是我想要的：

<Employees>
<Employee>First</Employee>
<Employee>Second</Employee>
<Employee>Third</Employee>
</Employees>

但是我在运行时遇到了这个错误：

System.InvalidOperationException：只能为Person类型指定XmlRoot属性。请使用XmlSchemaProviderAttribute指定架构类型。

注意当我的 Person类未实现IXmlSerializable时，一切正常......

有人可以帮我吗？

选择解决方案（基于@dbc answer）

正如@dbc指出的那样，使用＆＃34;代理＆＃34;上课是做我想做的最简单的方法。但正如我所说，我需要动态更改Person类型，这意味着我无法使用属性标签。
所以我仍然在我的最终设计中使用XmlAttributeOverrides，这里是：

代理List<Person>类（与没有属性标记的@dbc相同）：

public class EmployeesListSurrogate
{
    public List<Person> EmployeeList { get; set; }

    public static implicit operator List<Person>(EmployeesListSurrogate surrogate)
    {
        return surrogate == null ? null : surrogate.EmployeeList;
    }

    public static implicit operator EmployeesListSurrogate(List<Person> employees)
    {
        return new EmployeesListSurrogate { EmployeeList = employees };
    }
}

使用代理人的测试类：

class Program
{
    static void Main(string[] args)
    {
        List<Person> lPersonList = new List<Person> {
            new Person("First"),
            new Person("Second"),
            new Person("Third")
        };

        XmlAttributeOverrides lOverrides = new XmlAttributeOverrides();
        XmlAttributes lEmployeesListAttributes = new XmlAttributes { XmlRoot = new XmlRootAttribute("Employees") };
        lOverrides.Add(typeof(EmployeesListSurrogate), lEmployeesListAttributes);
        XmlAttributes lEmployeeAttributes = new XmlAttributes { XmlElements = { new XmlElementAttribute("Employee") } };
        lOverrides.Add(typeof(EmployeesListSurrogate), "EmployeeList", lEmployeeAttributes);

        XmlSerializer lSerializer = new XmlSerializer(typeof(EmployeesListSurrogate), lOverrides);
        XmlSerializerNamespaces lNamespaces = new XmlSerializerNamespaces();
        lNamespaces.Add("", "");
        lSerializer.Serialize(Console.Out, (EmployeesListSurrogate)lPersonList, lNamespaces);
    }
}

我想以@dbc为由对此结束，您的回答非常有帮助且信息丰富，我已经学到了很多东西。我无法支持你，但我希望社区能做到！

Answer 1

获取所需XML的最简单方法是序列化＆＃34;代理＆＃34;课程如下：

[XmlRoot("Employees")]
public class EmployeesListSurrogate
{
    [XmlElement("Employee")]
    public List<Person> EmployeeList { get; set; }

    public static implicit operator List<Person>(EmployeesListSurrogate surrogate)
    {
        return surrogate == null ? null : surrogate.EmployeeList;
    }

    public static implicit operator EmployeesListSurrogate(List<Person> employees)
    {
        return new EmployeesListSurrogate { EmployeeList = employees };
    }
}

这完全消除了对XmlAttributeOverrides的需求。或者，您可以使用XmlAttributeOverrides和XmlAttributes.XmlElements动态指定EmployeeList的XML名称。

话虽如此，当您尝试将InvalidOperationException应用于同时实现[XmlType]的类型时，IXmlSerializable被抛出的原因是XmlSerializer需要类型名称通过完全不同的机制返回，即XmlSchemaProviderAttribute.MethodName属性中指定的[XmlSchemaProvider]方法。

将[XmlSchemaProvider]应用于IXmlSerializable类型时，XmlSerializer将查找在属性构造函数中指定其名称的类型的公共静态方法，并具有以下签名：< / p>

    public static XmlQualifiedName GetSchemaMethod(XmlSchemaSet xs)
    {
    }

这种方法的目的有两个：

在序列化该类型的实例时，它应该使用预期的架构填充XmlSchemaSet。通过测试，我发现它必须填充有效的。它不能只是留空，否则会抛出异常。

（我不知道XmlSerializer在序列化时对模式实际验证的程度。在通过xsd.exe导出模式信息时也会调用该方法。）
它应返回该类型的XML类型名称。

这似乎是微软抛出您所看到的异常的原因：由于架构属性提供程序应该返回类型名称，因此XmlType属性会发生冲突。

因此，如果我按如下方式修改您的Person课程：

[XmlSchemaProvider("GetSchemaMethod")]
public class Person : IXmlSerializable
{
    // Private state
    private string personName;

    // Constructors
    public Person(string name)
    {
        personName = name;
    }

    public Person()
    {
        personName = null;
    }

    // This is the method named by the XmlSchemaProviderAttribute applied to the type.
    public static XmlQualifiedName GetSchemaMethod(XmlSchemaSet xs)
    {
        string EmployeeSchema = @"<?xml version=""1.0"" encoding=""utf-16""?>
<xs:schema elementFormDefault=""qualified"" xmlns:xs=""http://www.w3.org/2001/XMLSchema"">
  <xs:import namespace=""http://www.w3.org/2001/XMLSchema"" />
  <xs:element name=""Employee"" nillable=""true"" type=""Employee"" />
  <xs:complexType name=""Employee"" mixed=""true"">
  <xs:sequence>
    <xs:any />
  </xs:sequence>
  </xs:complexType>
</xs:schema>";

        using (var textReader = new StringReader(EmployeeSchema))
        using (var schemaSetReader = System.Xml.XmlReader.Create(textReader))
        {
            xs.Add("", schemaSetReader);
        }
        return new XmlQualifiedName("Employee");
    }

    // Xml Serialization Infrastructure
    public void WriteXml(XmlWriter writer)
    {
        writer.WriteString(personName);
    }

    public void ReadXml(XmlReader reader)
    {
        reader.MoveToContent();
        var isEmpty = reader.IsEmptyElement;
        reader.ReadStartElement();
        if (!isEmpty)
        {
            personName = reader.ReadContentAsString();
            reader.ReadEndElement();
        }
    }

    public XmlSchema GetSchema()
    {
        return (null);
    }

    // Print
    public override string ToString()
    {
        return (personName);
    }
}

将您的List<Person>序列化为XML，我得到以下结果：

<ArrayOfEmployee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Employee>First</Employee>
    <Employee>Second</Employee>
    <Employee>Third</Employee>
</ArrayOfEmployee>

如您所见，Person的XML类型名称已成功指定。

但是，您希望通过Person动态覆盖 XmlAttributeOverrides的XML类型名称，而不是将其设置为编译类型。为此，似乎有必要在XmlAttributes内指定XmlSchemaProviderAttribute。不幸的是，在XmlSchemaProvider中找不到XmlAttributes属性。似乎Microsoft从未实现此类功能。因此，如果你想进一步追求这个设计，你需要做一些kludgy：在创建覆盖序列化器时暂时覆盖GetSchemaMethod()的返回。要牢记两件事：

在幕后，XmlSerializer通过创建动态程序集来工作。如果您使用XmlSerializer或new XmlSerializer(Type)构建new XmlSerializer(Type, String)，那么.Net将缓存程序集并在第二次构建序列化程序时重复使用它。

因此，在使用其中任何一个构建序列化程序时尝试暂时覆盖GetSchemaMethod()的返回将失败或产生意外结果。
否则动态程序集不缓存，因此您的代码必须手动缓存序列化程序或严重的资源泄漏。见Memory Leak using StreamReader and XmlSerializer。

在这些情况下，暂时覆盖GetSchemaMethod()的返回可能有效。

所有这些都说明，以下内容产生了您需要的XML：

[XmlSchemaProvider("GetSchemaMethod")]
public class Person : IXmlSerializable
{
    // Private state
    private string personName;

    // Constructors
    public Person(string name)
    {
        personName = name;
    }

    public Person()
    {
        personName = null;
    }

    [ThreadStatic]
    static string personXmlTypeName;

    const string defaultXmlTypeName = "Person";

    static string PersonXmlTypeName
    {
        get
        {
            if (personXmlTypeName == null)
                personXmlTypeName = defaultXmlTypeName;
            return personXmlTypeName;
        }
        set
        {
            personXmlTypeName = value;
        }
    }

    public static IDisposable PushXmlTypeName(string xmlTypeName)
    {
        return new PushValue<string>(xmlTypeName, () => PersonXmlTypeName, val => PersonXmlTypeName = val);
    }

    // This is the method named by the XmlSchemaProviderAttribute applied to the type.
    public static XmlQualifiedName GetSchemaMethod(XmlSchemaSet xs)
    {
        string EmployeeSchemaFormat = @"<?xml version=""1.0"" encoding=""utf-16""?>
            <xs:schema elementFormDefault=""qualified"" xmlns:xs=""http://www.w3.org/2001/XMLSchema"">
              <xs:import namespace=""http://www.w3.org/2001/XMLSchema"" />
              <xs:element name=""{0}"" nillable=""true"" type=""{0}"" />
              <xs:complexType name=""{0}"" mixed=""true"">
              <xs:sequence>
                <xs:any />
              </xs:sequence>
              </xs:complexType>
            </xs:schema>";
        var EmployeeSchema = string.Format(EmployeeSchemaFormat, PersonXmlTypeName);

        using (var textReader = new StringReader(EmployeeSchema))
        using (var schemaSetReader = System.Xml.XmlReader.Create(textReader))
        {
            xs.Add("", schemaSetReader);
        }
        return new XmlQualifiedName(PersonXmlTypeName);
    }

    // Xml Serialization Infrastructure
    public void WriteXml(XmlWriter writer)
    {
        writer.WriteString(personName);
    }

    public void ReadXml(XmlReader reader)
    {
        reader.MoveToContent();
        var isEmpty = reader.IsEmptyElement;
        reader.ReadStartElement();
        if (!isEmpty)
        {
            personName = reader.ReadContentAsString();
            reader.ReadEndElement();
        }
    }

    public XmlSchema GetSchema()
    {
        return (null);
    }

    // Print
    public override string ToString()
    {
        return (personName);
    }
}

public struct PushValue<T> : IDisposable
{
    Action<T> setValue;
    T oldValue;

    public PushValue(T value, Func<T> getValue, Action<T> setValue)
    {
        if (getValue == null || setValue == null)
            throw new ArgumentNullException();
        this.setValue = setValue;
        this.oldValue = getValue();
        setValue(value);
    }

    #region IDisposable Members

    // By using a disposable struct we avoid the overhead of allocating and freeing an instance of a finalizable class.
    public void Dispose()
    {
        if (setValue != null)
            setValue(oldValue);
    }

    #endregion
}

public static class PersonEmployeeListSerializerFactory
{
    static Dictionary<Tuple<string, string>, XmlSerializer> serializers;
    static object padlock = new object();

    static PersonEmployeeListSerializerFactory()
    {
        serializers = new Dictionary<Tuple<string, string>, XmlSerializer>();
    }

    public static XmlSerializer GetSerializer(string rootName, string personName)
    {
        lock (padlock)
        {
            XmlSerializer serializer;
            var key = Tuple.Create(rootName, personName);
            if (!serializers.TryGetValue(key, out serializer))
            {
                using (Person.PushXmlTypeName(personName))
                {
                    var lOverrides = new XmlAttributeOverrides();
                    //var lAttributes = new XmlAttributes();
                    //lOverrides.Add(typeof(Person), lAttributes);

                    serializers[key] = serializer = new XmlSerializer(typeof(List<Person>), lOverrides, new Type[0], new XmlRootAttribute(rootName), null);
                }
            }
            return serializer;
        }
    }
}

然后做

var lSerialiser = PersonEmployeeListSerializerFactory.GetSerializer("Employees", "Employee");

var lNamespaces = new XmlSerializerNamespaces();
lNamespaces.Add("", "");

var sb = new StringBuilder();
using (var writer = new StringWriter(sb))
    lSerialiser.Serialize(writer, lPersonList, lNamespaces);

Console.WriteLine(sb);

但是你可以看到这比使用最初显示的代理更加复杂。

示例fiddle显示两个选项。

C＃XML序列化覆盖IXmlSerializable类的类型

初步问题

选择解决方案（基于@dbc answer）

1 个答案: