Переопределение сериализации C# XML Тип класса IXmlSerializable

Начальный вопрос

Я хочу serialize и List<IXmlSerializable> динамически изменять XmlType класса IXmlSerializable (поэтому я не могу использовать теги атрибутов для этого)

Я пытался использовать 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, использование «суррогатного» класса - это самый простой способ сделать то, что я хочу. Но, как я уже сказал, мне нужно динамически менять тип 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, ваш ответ был очень полезным и информативным, я многому научился. Я не могу проголосовать за вас, но я надеюсь, что сообщество сделает это!


person Thomas WALTER    schedule 30.06.2016    source источник


Ответы (1)


Самый простой способ получить желаемый XML — сериализовать «суррогатный» класс следующим образом:

[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 для динамического указания имени XML для EmployeeList.

При этом причина, по которой выдается InvalidOperationException, когда вы пытаетесь применить [XmlType] к типу, который также реализует IXmlSerializable, заключается в том, что XmlSerializer требует возврата имени типа через совершенно другой механизм, а именно через XmlSchemaProviderAttribute.MethodName, указанный в [XmlSchemaProvider].

Когда [XmlSchemaProvider] применяется к типу IXmlSerializable, XmlSerializer будет искать общедоступный статический метод типа, имя которого указано в конструкторе атрибута и имеет следующую сигнатуру:

    public static XmlQualifiedName GetSchemaMethod(XmlSchemaSet xs)
    {
    }

Цель этого метода двояка:

  1. Он должен заполнить XmlSchemaSet ожидаемой схемой при сериализации экземпляров типа. Проверив, я обнаружил, что он должен быть заполнен чем-то допустимым. Его нельзя просто оставить пустым, иначе будет выброшено исключение.

    (Я не знаю, в какой степени XmlSerializer действительно проверяет соответствие схеме при сериализации. Этот метод также вызывается при экспорте информации о схеме через xsd.exe.)

  2. Он должен возвращать имя типа XML для типа.

    Похоже, именно поэтому Microsoft выдает исключение, которое вы видите: поскольку поставщик атрибутов схемы должен возвращать имя типа, атрибут 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>

Как видите, имя типа XML для Person было успешно указано.

Однако вы хотите динамически переопределить имя типа XML для Person через XmlAttributeOverrides, а не устанавливать его в типе компиляции. Для этого, казалось бы, необходимо указать XmlSchemaProviderAttribute внутри XmlAttributes. К сожалению, внутри XmlAttributes нет свойства XmlSchemaProvider. Похоже, Microsoft никогда не реализовывала такую ​​функциональность. Таким образом, если вы хотите продолжить этот дизайн, вам нужно будет сделать что-то неуклюжее: временно переопределить возврат GetSchemaMethod() при создании сериализатора переопределения. Две вещи, о которых следует помнить:

  1. Под капотом XmlSerializer работает путем создания динамической сборки. Если вы создаете XmlSerializer с new XmlSerializer(Type) или new XmlSerializer(Type, String), то .Net будет кэшировать сборку и повторно использовать ее при создании сериализатора во второй раз.

    Таким образом, попытка временно переопределить возврат GetSchemaMethod() при построении сериализатора с использованием любого из них завершится ошибкой или приведет к неожиданным результатам.

  2. В противном случае динамические сборки не кэшируются, поэтому ваш код должен кэшировать сериализатор вручную, иначе возникнет серьезная утечка ресурсов. См. раздел Утечка памяти с использованием StreamReader и 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, показывающий оба варианта.

person dbc    schedule 02.07.2016