Over a million developers have joined DZone.

Windows Phone 7 Serialization: XmlSerializer

· Mobile Zone

Currently I am looking for the best solution for object serialization in Windows Phone 7 environment. I will begin my quest with XML Serialization using XmlSerializer Class (popular solution in Silverlight). In this post I will show how to serialize and deserialize objects using XmlSerializer, later I will try to compare several ways of serialization to find out which one is the best.

eugenedotnet windows phone 7 xml serialization with xmlserializer

Additional Information

Creating a sample class

I have created special SampleData class to be serialized and deserialized. It is a very simple class containing only two properties and a constructor declaration for filling down both properties (check code bellow). To control XML generation for a class you can use XmlAttribute, XmlElement, etc. Pay attention that only public properties can be serialized. More information about XML-generation can be found here and here (MSDN website).

public class SampleData
{
    [XmlElement]
    public string ContentText { get; set; }
 
    [XmlElement]
    public List<int> SomeItems { get; set; }
 
    public SampleData()
    {
        ContentText = "some text";
        SomeItems = new List<int>() { 1, 2, 3 };
    }
}

Adding a reference

Keep in mind that XmlSerializer requires System.Xml.Serialization namespace to be added to project. To do so right click the project name and choose Add Reference there. Select System.Xml.Serialization namespace on .NET tab (check image bellow).


eugenedotnet add XML serialization reference

 

Serialization

Both serialization and deserialization processes are very easy to implement. For both operations you will need to create an instance of XmlSerializer class and pass it a type of object for serialization. In addition for serialization you will need a stream object to hold serialized object. To serialize an object simply call Serialize method of XmlSerializer instance. I have created the following method for serialization:

public static void Serialize(Stream streamObject, object objForSerialization)
{
    if (objForSerialization == null || streamObject == null)
        return;
 
    XmlSerializer serializer = new XmlSerializer(objForSerialization.GetType());
    serializer.Serialize(streamObject, objForSerialization);
}

Restrictions

  • Class for serialization must be public
  • Class member for serialization must be public
  • Parameterless constructor for a class


Deserialization

To deserialize object you will need a stream to read previously serialized data and a type of the object. I have also created a sample method for deserialization (code bellow) that returns deserialized object.

public static object Deserialize(Stream streamObject, Type serializedObjectType)
{
    if (serializedObjectType == null || streamObject == null)
        return null;
 
    XmlSerializer serializer = new XmlSerializer(serializedObjectType);
    return serializer.Deserialize(streamObject);
}

Testing serialization and deserialization

I have used the following method to test serialization and deserialization with XmlSerializer. As the result instance of SampleData class after deserialization is exactly the same as the one before the serialization.

public static void TestXMLSerialization()
{
    // serialization
    MemoryStream ms = new MemoryStream();
    XMLSerializerHelper.Serialize(ms, new SampleData());
    ms.Position = 0;
 
    // deserialization
    var sampleData = XMLSerializerHelper.Deserialize(ms, typeof(SampleData));
 
    ms.Close();
}

Here is how serialized instance of SampleData class looks like:

<?xml version="1.0"?>
<SampleData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ContentText>some text</ContentText>
  <SomeItems>1</SomeItems>
  <SomeItems>2</SomeItems>
  <SomeItems>3</SomeItems>
</SampleData>
Topics:

Published at DZone with permission of Jevgeni Tšaikin. See the original article here.

Opinions expressed by DZone contributors are their own.

The best of DZone straight to your inbox.

SEE AN EXAMPLE
Please provide a valid email address.

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.
Subscribe

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}