.net XML-сериализация - хранение ссылки вместо объектной копии - PullRequest
Новая
       9

.net XML-сериализация - хранение ссылки вместо объектной копии

31 голосов
/ 24 октября 2009
  • В приложении .Net / C # у меня есть структуры данных, которые имеют ссылки друг на друга.
  • Когда я сериализую их, .Net сериализует все ссылки с отдельными копиями объектов.
  • В следующем примере я пытаюсь сериализовать в массив 'Person'

  • «Лицо» может иметь ссылку на другого человека. 

    public class Person
{
    public string Name;
    public Person Friend;
}

Person p1 = new Person();
p1.Name = "John";

Person p2 = new Person();
p2.Name = "Mike";

p1.Friend = p2;

Person[] group = new Person[] { p1, p2 };
XmlSerializer ser = new XmlSerializer(typeof(Person[]));
using (TextWriter tw = new StreamWriter("test.xml"))
    ser.Serialize(tw,group );

//above code generates following xml

<ArrayOfPerson>
  <Person>
    <Name>John</Name>
    <Friend>
      <Name>Mike</Name>
    </Friend>
  </Person>
  <Person>
    <Name>Mike</Name>
  </Person>
</ArrayOfPerson>

  • В приведенном выше коде один и тот же объект 'Mike' находится в двух местах, поскольку есть две ссылки на один и тот же объект.

  • При десериализации они становятся двумя разными объектами, что не является точным состоянием при сериализации.
  • Я хочу избежать этого и иметь только копию объекта в сериализованном XML, и все ссылки должны ссылаться на эту копию. После десериализации я хочу вернуть ту же старую структуру данных.
  • Возможно ли это?

Ответы [ 2 ]

33 голосов
/ 24 октября 2009

Это невозможно с XmlSerializer . Этого можно добиться с помощью DataContractSerializer , используя свойство PreserveObjectReferences . Вы можете взглянуть на этот пост , который объясняет детали.

Вот пример кода: 

public class Person
{
    public string Name;
    public Person Friend;
}

class Program
{
    static void Main(string[] args)
    {
        Person p1 = new Person();
        p1.Name = "John";

        Person p2 = new Person();
        p2.Name = "Mike";
        p1.Friend = p2;
        Person[] group = new Person[] { p1, p2 };

        var serializer = new DataContractSerializer(group.GetType(), null, 
            0x7FFF /*maxItemsInObjectGraph*/, 
            false /*ignoreExtensionDataObject*/, 
            true /*preserveObjectReferences : this is where the magic happens */, 
            null /*dataContractSurrogate*/);
        serializer.WriteObject(Console.OpenStandardOutput(), group);
    }
}

Это приводит к следующему XML: 

<ArrayOfPerson z:Id="1" z:Size="2" xmlns="http://schemas.datacontract.org/2004/07/ToDelete" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
    <Person z:Id="2">
        <Friend z:Id="3">
            <Friend i:nil="true"/>
            <Name z:Id="4">Mike</Name>
        </Friend>
        <Name z:Id="5">John</Name>
    </Person>
    <Person z:Ref="3" i:nil="true"/>
</ArrayOfPerson>

Теперь установите PreserveObjectReferences на false в конструкторе, и вы получите это: 

<ArrayOfPerson xmlns="http://schemas.datacontract.org/2004/07/ToDelete" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Person>
        <Friend>
            <Friend i:nil="true"/>
            <Name>Mike</Name>
        </Friend>
        <Name>John</Name>
    </Person>
    <Person>
        <Friend i:nil="true"/>
        <Name>Mike</Name>
    </Person>
</ArrayOfPerson>

Стоит отметить, что созданный таким образом XML не является совместимым и может быть десериализован только с помощью DataContractSerializer (то же самое замечание, что и с BinaryFormatter ).

4 голосов
/ 22 сентября 2016

Вы можете использовать ExtendedXmlSerializer. Вот пример сериализации ссылка на объект и циклическая ссылка

Если у вас есть класс: 

public class Person
{
    public int Id { get; set; }

    public string Name { get; set; }

    public Person Boss { get; set; }
}

public class Company
{
    public List<Person> Employees { get; set; }
}

затем вы создаете объект с круговой ссылкой, например: 

var boss = new Person {Id = 1, Name = "John"};
boss.Boss = boss; //himself boss
var worker = new Person {Id = 2, Name = "Oliver"};
worker.Boss = boss;
var obj = new Company
{
    Employees = new List<Person>
    {
        worker,
        boss
    }
};

Вы должны настроить класс Person в качестве ссылочного объекта: 

var serializer = new ConfigurationContainer().ConfigureType<Person>()
                                             .EnableReferences(p => p.Id)
                                             .Create();

В конце вы можете сериализовать ваш объект: 

var xml = serializer.Serialize(obj);

Вывод xml будет выглядеть так: 

<?xml version="1.0" encoding="utf-8"?>
<Company xmlns="clr-namespace:ExtendedXmlSerializer.Samples.ObjectReference;assembly=ExtendedXmlSerializer.Samples">
  <Employees>
    <Capacity>4</Capacity>
    <Person Id="2">
      <Name>Oliver</Name>
      <Boss Id="1">
        <Name>John</Name>
        <Boss xmlns:exs="https://extendedxmlserializer.github.io/v2" exs:entity="1" />
      </Boss>
    </Person>
    <Person xmlns:exs="https://extendedxmlserializer.github.io/v2" exs:entity="1" />
  </Employees>
</Company>

ExtendedXmlSerializer поддерживает .net 4.5 и .net Core.

...