XMLWriter vs XMLDictionaryWriter

Question

What's the difference between XMLWriter and XMLDictionaryWriter? In which cases is each one generally used?

Answer 1

XmlWriter is an abstract class used for writing XML documents in a forward-only manner. You use the static Create method to create concrete implementations of the class for use. This method of creating XML documents is useful when you need to quickly create arbitrary XML for whatever use.

XmlDictionaryWriter is an abstrace class used for serialization and deserialization of objects to and from XML. From what I understand, it is used in WCF for serializing objects for moving across the wire. XmlDictionaryWriter can serialize using binary, text or MTOM formats. I would expect you would only use this class if you were specifically needing custom (de)serialization for use over WCF. See also here.

Hope that helps.

Answer 2

XmlWriter is an abstract class of which XmlDictionaryWriter is one of the classes that inherits from it and is itself an abstract class.

I am taking a stab in the dark that you want to use it with the DataContractSerializer or with de/serialization in general. The XmlDictionaryWriter is the base class used by WCF to do its de/serialization.

From that I would deduce that there must be some performance tuning in the XmlDictionaryWriter to make it more performant with WCF de/serialization tasks. In fact if you call the WriteObject(Stream, object) instead of WriteObject(XmlWriter, object) or WriteObject(XmlDictionaryWriter, object) methods it will create an XmlDictionaryWriter for you

public virtual void WriteObject(Stream stream, object graph)
{
    CheckNull(stream, "stream");
    XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(stream, Encoding.UTF8, false);
    this.WriteObject(writer, graph);
    writer.Flush();
}