How to Serialize List?

Question

I have Class A. Class B and Class C are part of Class A.

Class A 
{

//Few Properties of Class A

List<typeof(B)> list1 = new List<typeof(B)>()

List<typeof(C)> list2 = new List<typeof(C)>()

Nsystem NotSystem { get; set; } // Enum Property Type

}

public enum Nsystem {
    A = 0,
    B = 1,
    C = 2
}

I want to Serialize Class A and want to produce XML with it; I also want to serialize list1 and list2 and also the Enum...

What is a good approach to Serialize this XML because I need the functionality of converting an Object into XML and XML into an Object ...

What are some good options to do this? Thanks

BrokenGlass · Accepted Answer · 2011-02-15T19:04:54.687

You could use the XMLSerializer:

var aSerializer = new XmlSerializer(typeof(A));
StringBuilder sb = new StringBuilder();
StringWriter sw = new StringWriter(sb);
aSerializer.Serialize(sw, new A()); // pass an instance of A
string xmlResult = sw.GetStringBuilder().ToString();

For this to work properly you will also want xml annotations on your types to make sure it is serialized with the right naming, i.e.:

public enum NSystem { A = 0, B = 1, C = 2 }

[Serializable]
[XmlRoot(ElementName = "A")]
Class A 
{
 //Few Properties of Class A
 [XmlArrayItem("ListOfB")]
 List<B> list1;

 [XmlArrayItem("ListOfC")]
 List<C> list2;

 NSystem NotSystem { get; set; } 
}

Edit:

Enum properties are serialized by default with the name of the property as containing XML element and its enum value as XML value, i.e. if the property NotSystem in your example has the value C it would be serialized as

<NotSystem>C</NotSystem>

Of course you can always change the way the property is serialized by doing a proper annotation, i.e using [XmlAttribute] so it's serialized as an attribute, or [XmlElement("Foobar")] so it's serialized using Foobar as element name. More extensive documentation is available on MSDN, check the link above.

This is not C#, it doesn't exists a syntax that accepts "Enum eventType e;" — as-cii, Feb 15 '11 at 16:13
@AS-CII fixed that, I had copied that from OP's question without double checking — BrokenGlass, Feb 15 '11 at 16:19
Sorry I did typo for Enum syntax should be NSystem NotSystem { get; set; } where NSystem is Enum type and public enum NSystem { A = 0, B = 1, C = 2 } How can I serialize/Deserialize Enum type Property in C# — Ocean, Feb 15 '11 at 17:50

Andrew_STOP_RU_WAR_IN_UA · Answer 2 · 2020-02-21T23:55:05.203

Easiest way: to do BINARY serialization of any object (Images also and lot of other data!) with IO error catching.

To the class that we need to serialize we need to add [Serializable]

[Serializable]//this like
public class SomeItem
{}

Serialization wrapper:

public static class Serializator
{
    private static BinaryFormatter _bin = new BinaryFormatter();

    public static void Serialize(string pathOrFileName, object objToSerialise)
    {
        using (Stream stream = File.Open(pathOrFileName, FileMode.Create))
        {
            try 
            {
                _bin.Serialize(stream, objToSerialise);
            }
            catch (SerializationException e) 
            {
                Console.WriteLine("Failed to serialize. Reason: " + e.Message);
                throw;
            }
        }
    }

    public static T Deserialize<T>(string pathOrFileName) 
    {
        T items;

        using (Stream stream = File.Open(pathOrFileName, FileMode.Open))
        {
            try 
            {
                items = (T) _bin.Deserialize(stream);
            }
            catch (SerializationException e) 
            {
                Console.WriteLine("Failed to deserialize. Reason: " + e.Message);
                throw;
            }
        }

        return items;
    }
}

and using of the solution:

List<SomeItem> itemsCollected; //list with some data

Serializator.Serialize("data.dat", itemsCollected); // trying to serialise


var a = Serializator.Deserialize<%dataType%>("%dataPath%");

var a = Serializator.Deserialize<List<SomeItem>>("data.dat");
// trying to DeSerialize; 
// And important thing that you need to write here 
// correct data format instead of List<SomeItem>

in case of error was occured, error will be written to the console.

although the answer doesn't mention you still have to add the [Serializable] attribute to the class of the object you want to serialize. — wecky, Jul 26 '19 at 08:05

score 3 · Answer 3 · answered Jan 19 '17 at 10:20

    public IList<Object> Deserialize(string a_fileName)
    {
        XmlSerializer deserializer = new XmlSerializer(typeof(List<Object>));

        TextReader reader = new StreamReader(a_fileName);

        object obj = deserializer.Deserialize(reader);

        reader.Close();

        return (List<Object>)obj;
    }

    public void Serialization(IList<Object> a_stations,string a_fileName)
    {
        XmlSerializer serializer = new XmlSerializer(typeof(List<Object>));

        using (var stream = File.OpenWrite(a_fileName))
        {
            serializer.Serialize(stream, a_stations);
        }
    }

ibrahim_ragab · Answer 4 · 2013-03-24T14:21:40.343

1

you can use this

 [XmlArray("array_name")]
 [XmlArrayItem("Item_in_array")]
 public List<T> _List;

edited Mar 24 '13 at 14:21

answered Mar 22 '13 at 21:44

ibrahim_ragab

11
2

score 0 · Answer 5 · answered Mar 22 '13 at 22:38

Do you need to use XML as the representation? You may want to consider binary representations as well, which are usually faster and more compact. You have the BinaryFormatter that comes built in, or even better you can use protocol buffers that is blazing fast and super compact. If you need XML you may want to think whether you want to support some kind of interoperability with other languages and technologies or even platforms. If it is only C# to c# both the XmlSerializer for Xml or the BinaryFormatter are fine. If you are going to interact with Javascript you may consider using JSON (You can try JSON.NET. Also, if you want to support Windows Phone or other more constrained devices you, it may just be easier to use the XmlSerializer that works anywhere.

Finally, you may prefer to just have a common infrastructure and support many serialization mechanisms and transports. Microsoft offers a wonderful (albeit a bit slow) solution in WCF. Perhaps if you say more about your system's requirements, it will be easier to suggest an implementation. The good thing is that you have plenty of options.

score 0 · Answer 6 · answered May 13 '16 at 16:13

As cloudraven suggested, you could use binary representations. While looking for solutions I came upon this link. Basically, you mark your A class as [Serializable], and the same goes for your B and C classes. Then you might use functions such as these ones to Serialize and Deserialize

score -1 · Answer 7 · answered Feb 15 '11 at 15:59

JAXB is the best I ever used.

http://www.oracle.com/technetwork/articles/javase/index-140168.html

From XML:

QuestionEntity obj = null;
try {
    JAXBContext ctx = JAXBContext.newInstance(QuestionEntity.class);
    Unmarshaller unmarshaller = ctx.createUnmarshaller();
    obj = (QuestionEntity) unmarshaller.unmarshal(new StreamSource(new StringReader(xml)));
} catch (JAXBException e) {
    e.printStackTrace();
}

To XML:

JAXBContext ctx = JAXBContext.newInstance(TestEntity.class);
Marshaller marshaller = ctx.createMarshaller();
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
StringWriter stringWriter = new StringWriter();
marshaller.marshal(this, stringWriter);
return stringWriter.toString();

that looks very cool, but this is a C# question not Java. I didn't see a .Net version at the link you provided, did I miss something? — Doctor Jones, Feb 15 '11 at 16:03

How to Serialize List?

7 Answers7

Linked

Related