Serializing an object as UTF-8 XML in .NET

by

No, you can use a StringWriter to get rid of the intermediate MemoryStream. However, to force it into XML you need to use a StringWriter which overrides the Encoding property:

public class Utf8StringWriter : StringWriter
{
    public override Encoding Encoding => Encoding.UTF8;
}

Or if you’re not using C# 6 yet:

public class Utf8StringWriter : StringWriter
{
    public override Encoding Encoding { get { return Encoding.UTF8; } }
}

Then:

var serializer = new XmlSerializer(typeof(SomeSerializableObject));
string utf8;
using (StringWriter writer = new Utf8StringWriter())
{
    serializer.Serialize(writer, entry);
    utf8 = writer.ToString();
}

Obviously you can make Utf8StringWriter into a more general class which accepts any encoding in its constructor – but in my experience UTF-8 is by far the most commonly required “custom” encoding for a StringWriter 🙂

Now as Jon Hanna says, this will still be UTF-16 internally, but presumably you’re going to pass it to something else at some point, to convert it into binary data… at that point you can use the above string, convert it into UTF-8 bytes, and all will be well – because the XML declaration will specify “utf-8” as the encoding.

EDIT: A short but complete example to show this working:

using System;
using System.Text;
using System.IO;
using System.Xml.Serialization;

public class Test
{    
    public int X { get; set; }

    static void Main()
    {
        Test t = new Test();
        var serializer = new XmlSerializer(typeof(Test));
        string utf8;
        using (StringWriter writer = new Utf8StringWriter())
        {
            serializer.Serialize(writer, t);
            utf8 = writer.ToString();
        }
        Console.WriteLine(utf8);
    }


    public class Utf8StringWriter : StringWriter
    {
        public override Encoding Encoding => Encoding.UTF8;
    }
}

Result:

<?xml version="1.0" encoding="utf-8"?>
<Test xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <X>0</X>
</Test>

Note the declared encoding of “utf-8” which is what we wanted, I believe.

More Related Contents:

  1. Using StringWriter for XML Serialization
  2. Proper way to implement IXmlSerializable?
  3. Convert XML String to Object
  4. Generating an Xml Serialization assembly as part of my build
  5. What is the best way to parse (big) XML in C# Code?
  6. XML Serialization and Inherited Types
  7. Serialize Property as Xml Attribute in Element
  8. .net XML Serialization – Storing Reference instead of Object Copy
  9. How to decode string to XML string in C#
  10. How can I serialize internal classes using XmlSerializer?
  11. How to write a comment to an XML file when using the XmlSerializer?
  12. Conditional xml serialization
  13. Suppress Null Value Types from Being Emitted by XmlSerializer
  14. using XmlArrayItem attribute without XmlArray on Serializable C# class
  15. FileMode.Open and FileMode.OpenOrCreate difference when file exists? c# bug?
  16. Generating XML file using XSD file
  17. How do I map XML to C# objects
  18. Convert Dataset to XML
  19. How to rename XML attribute that generated after serializing List of objects
  20. XmlSerializer Performance Issue when Specifying XmlRootAttribute
  21. How can I transform XML into a List or String[]?
  22. Force XDocument to write to String with UTF-8 encoding
  23. How to deserialize only part of an XML document in C#
  24. How do you use XMLSerialize for Enum typed properties in c#?
  25. How can I convert a DataTable to an XML file in C#?
  26. Create XML Nodes based on XPath?
  27. Entity Framework with XML Files [closed]
  28. Serializing Lists of Classes to XML
  29. Read nodes of a xml file in C#
  30. How do I return XML from a Stored Procedure?

Leave a Comment