Serialize object graph to XML in .Net

How to serialize any data structure to XML? My first idea was XmlSerializer. But then I found out it had some serious drawbacks. Luckily, there is a better option - NetDataContractSerializer.

In .Net, there are a few classes for (de)serialization. This is an overview of their features:


XmlSerializer

  • Cannot serialize circular references.
  • If more objects point to the same object, its copies are created in the xml for each of these references.
  • Has to know all types that could be encountered during serialization in advance - throws an exception on unknown type. Known types are passed in the constructor to XmlSerializer or marked by XmlIncludeAttribute.
  • Generates simple readable xml.

DataContractSerializer
  • Has to know types in advance - like XmlSerializer.
  • Can serialize circular references - construct with preserveObjectReferences = true
  • Used by WCF.
NetDataContractSerializer - better!
  • Serializes object graph properly including circular references.
  • Doesn't have to know types in advance.
  • However, MSDN states that it can be only used in .Net <-> .Net communication, which is ok also for storing object in a file.
  • Generates simple readable xml.
BinarryFormatter
  • Works well, like NetDataContractSerializer.
  • Disadvantage is that it serializes to binary format, which make its unusable e.g. for saving to a file that user could later edit.
  • The output is smallest thanks to the binary format.
SoapFormatter
  • Deprecated. Cannot serialize generic collections
- All serializers need the type to be serialized marked by SerializableAttribute.

kick it on DotNetKicks.com

What does it mean that XmlSerializer has to know all types that could be encountered during serialization in advance?
Imagine that we have two classes: Base and Derived.

[Serializable]

public class Base

{

public string name;

public Base()

{

name = "base instance";

}

}

[Serializable]

public class Derived : Base

{

public Derived left;

public Derived right;

public Derived()

{

}

}


What if we have a reference to Base and we actually don't want to care about the actual type?

Base b = new Derived();

// we only know we are holding reference to Base

// and we don't want to care about the actual type

XmlSerializer ser = new XmlSerializer(typeof(Base));

// serialize

using (FileStream fs = File.Create(AppDomain.CurrentDomain.BaseDirectory + "data.xml"))

{

// XmlSerializer throws an Exception

ser.Serialize(fs, b);

}

// deserialize

using (FileStream fs = File.OpenRead(AppDomain.CurrentDomain.BaseDirectory + "data.xml"))

{

Base baseDeserialized = (Base)ser.Deserialize(fs);

Derived deserialize = baseDeserialized as Derived;

}


XmlSerializer throws an exception, because it encounters an "unknown" type - Derived. We could solve this by passing all the possible derived types in constructor of XmlSerializer or tagging all by XmlIncludeAttribute. This is of course inconvenient if you have a lot of classes. The worst thing is that when you add a derived class, you have to change code elsewhere.
NetDataContractSerializer doesn't have this problem.

The second issue with XmlSerializer is that it cannot serialize complex object graph. What does it mean "to serialize object graph"?

Derived top = new Derived();

top.left = new Derived();

top.left.name = "left son";

top.right = new Derived();

top.right.name = "right son";

top.left.right = new Derived();

// top

// / \

// left right

// \ /

// bottom

top.right.left = top.left.right;

XmlSerializer ser = new XmlSerializer(typeof(Derived));

using (FileStream fs = File.Create(AppDomain.CurrentDomain.BaseDirectory + "data.xml"))

{

ser.Serialize(fs, top);

}

using (FileStream fs = File.OpenRead(AppDomain.CurrentDomain.BaseDirectory + "data.xml"))

{

Derived deserialized = (Derived)ser.Deserialize(fs);

// false - we want true

bool ok = deserialized.left.right == deserialized.right.left;

}


After deserialization,
deserialized.left.right == deserialized.right.left is false, that means the object graph is different. Worse - XmlSerializer cannot serialize circular references at all.
Again, NetDataContractSerializer doesn't have any of these problems.

kick it on DotNetKicks.com

Posted by Martin Konicek on 10:59 PM

208 comments:

«Oldest   ‹Older   201 – 208 of 208   Newer›   Newest»
Anonymous said...

Привет, я Александр! Хочу поделиться своим восторженным отзывом о казино Вавада. Благодаря вавада зеркало рабочее на сегодня мобильная vavadacag1, я обнаружил потрясающий мир азарта онлайн. Уже с первых минут игры меня покорили великолепные слоты и щедрые бонусы. Не могу не отметить простую и быструю регистрацию, что очень удобно. Каждый раз, когда играю в Вавада, приятно осознавать, что мои выигрыши будут выплачены оперативно. Интерфейс казино простой в использовании, что другое говорит за его удобство. Помимо этого, приветственный бонус и фриспины позволяют мне начать игру с крупной суммой. Всем любителям азарта настоятельно рекомендую посетить вавада зеркало рабочее на сегодня мобильная vavadacag1 и насладиться незабываемым опытом игры в казино Вавада.

Anonymous said...

Друганы, я нашел классные картинки и фото по теме Тоби Акацуки арт! Вы не поверите, какой стиль и красота в этих работах. Обязательно зайдите на эту ссылочку тоби акацуки арт, чтобы посмотреть все это великолепие своими глазами. Там целых 33 фото, каждая уникальная и впечатляющая. Уверяю, вам точно понравится, так что не упустите возможность насладиться этими прекрасными художественными работами!

Anonymous said...

Привет! Если ищешь классную открытку на 6 месяцев для маленького мальчика, то точно попал по адресу! Можете бесплатно скачать открыточку по ссылке: Открытка на 6 месяцев ребенку мальчику скачать. Там шикарный дизайн, с няшными рисунками, которые качество просто прёт, а текст на открытке просто милота! Обязательно скачай и порадуй малыша!

Swetha said...

Thank you for your positive feedback! I'm glad you found the article informative and that it effectively communicates the entire concept in detail. Your appreciation is greatly appreciated!click here for more information

Anonymous said...

Привет! Если ты, как и я, обожаешь всякие красивые картинки и фото, то обязательно загляни на эту ссылку! Там настоящая бомба вас ждет - вертикальный фон! У них там огромный выбор разных фотографий с вертикальной композицией. Вот только представь, сколько крутых обоев можно найти на свой компьютер или телефон! Так что не затягивай, бегом тыкать на ссылку и наслаждаться прекрасными фонами!

Anonymous said...

Если у тебя скоро братишка имеет день рождения, то я знаю, что он будет очень доволен, если ты сделаешь ему приятный сюрприз - открытку! Просто отпечатай на глянцевой бумаге открытку с днем рождения для брата от сестры, и уверен, что он засмеется и будет рад. Это просто зачетное решение, которое можно всегда взять и скачать бесплатно открытку с днем рождения брату от сестры на PoZdravlenya.ru. Там ты найдешь много вариантов для любого стиля, ну и необычные поздравления. Так что не жди, иди на сайт и поздравляй своего брата с Днем Рождения стильно и оригинально!

Anonymous said...

Мне нравится экспериментировать со своим образом и искать новые модные решения. Недавно я создала образ с мартинсами и получилось необычно и стильно! Если ты тоже любишь экспериментировать и следить за модными тенденциями, рекомендую пройти по ссылке и посмотреть галерею с луками с мартинсами. Там ты сможешь найти много вдохновения и идей для своих образов. А еще в галерее есть классная статья про рваную филированную челку, которая будет отличным дополнением к твоему образу с мартинсами. Не упусти возможность воплотить модные тренды и создать неповторимый лук!

«Oldest ‹Older   201 – 208 of 208   Newer› Newest»

Post a Comment