questions/45766597/c-deserialize-xml-with-xmlserializer-where-xmlelement-names-differ-but-have-sa

CSharp · Console

/Program.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Serialization;
using System.Xml;
using System.IO;
using System.Diagnostics;
using System.Collections.ObjectModel;
using System.Threading;
using System.ComponentModel;
using System.Xml.Linq;
using System.Reflection;
using System.Data;
using System.Xml.Schema;
using System.Text.RegularExpressions;
using System.Net;
using System.Xml.XPath;
using System.Globalization;
using System.ComponentModel.DataAnnotations;
using System.Collections;
using System.Runtime.InteropServices;
using System.Runtime.Serialization;

// https://stackoverflow.com/questions/45766597/c-deserialize-xml-with-xmlserializer-where-xmlelement-names-differ-but-have-sa

    [XmlRoot("Objects", Namespace = "http://foo")]
    public class DeactivationsXml
    {
        [XmlElement("Group")]
        public DeactivationsGroup[] Groups { get; set; }
    }

    [Serializable()]
    public class DeactivationsGroup
    {
        public DeactivationsGroup() { this.GroupNames = new Dictionary<string, GroupName>(); }

        [XmlIgnore]
        public Dictionary<string, GroupName> GroupNames { get; set; }

        public int Level { get; set; }

        [XmlAttribute]
        public byte index { get; set; }

        [XmlAnyElement]
        [Browsable(false), EditorBrowsable(EditorBrowsableState.Never), DebuggerBrowsable(DebuggerBrowsableState.Never)]
        public XElement[] XmlGroupNames
        {
            get
            {
                return GroupNames.SerializeToXElements("http://foo");
            }
            set
            {
                if (value == null || value.Length < 1)
                    return;
                foreach (var pair in value.DeserializeFromXElements<GroupName>())
                {
                    GroupNames.Add(pair.Key, pair.Value);
                }
            }
        }
    }

    public class GroupName
    {
        [XmlElement("GroupName")]
        public string Name { get; set; }

        [XmlAttribute]
        public string Attribute { get; set; }
    }

    public static class XmlKeyValueListHelper
    {
        const string RootLocalName = "Root";

        public static XElement [] SerializeToXElements<T>(this IEnumerable<KeyValuePair<string, T>> dictionary, XNamespace ns)
        {
            if (dictionary == null)
                return null;
            ns = ns ?? "";
            var serializer = XmlSerializerFactory.Create(typeof(T), RootLocalName, ns.NamespaceName);
            var array = dictionary
                .Select(p => new { p.Key, Value = p.Value.SerializeToXElement(serializer, true) })
                // Fix name and remove redundant xmlns= attributes.  XmlWriter will add them back if needed.
                .Select(p => new XElement(ns + p.Key, p.Value.Attributes().Where(a => !a.IsNamespaceDeclaration), p.Value.Elements()))
                .ToArray();
            return array;
        }

        public static IEnumerable<KeyValuePair<string, T>> DeserializeFromXElements<T>(this IEnumerable<XElement> elements)
        {
            if (elements == null)
                yield break;
            XmlSerializer serializer = null;
            XNamespace ns = null;
            foreach (var element in elements)
            {
                if (serializer == null || element.Name.Namespace != ns)
                {
                    ns = element.Name.Namespace;
                    serializer = XmlSerializerFactory.Create(typeof(T), RootLocalName, ns.NamespaceName);
                }
                var elementToDeserialize = new XElement(ns + RootLocalName, element.Attributes(), element.Elements());
                yield return new KeyValuePair<string, T>(element.Name.LocalName, elementToDeserialize.Deserialize<T>(serializer));
            }
        }

        public static XmlSerializerNamespaces NoStandardXmlNamespaces()
        {
            var ns = new XmlSerializerNamespaces();
            ns.Add("", ""); // Disable the xmlns:xsi and xmlns:xsd lines.
            return ns;
        }

        public static XElement SerializeToXElement<T>(this T obj)
        {
            return obj.SerializeToXElement(null, NoStandardXmlNamespaces());
        }

        public static XElement SerializeToXElement<T>(this T obj, XmlSerializerNamespaces ns)
        {
            return obj.SerializeToXElement(null, ns);
        }

        public static XElement SerializeToXElement<T>(this T obj, XmlSerializer serializer, bool omitStandardNamespaces)
        {
            return obj.SerializeToXElement(serializer, (omitStandardNamespaces ? NoStandardXmlNamespaces() : null));
        }

        public static XElement SerializeToXElement<T>(this T obj, XmlSerializer serializer, XmlSerializerNamespaces ns)
        {
            var doc = new XDocument();
            using (var writer = doc.CreateWriter())
                (serializer ?? new XmlSerializer(obj.GetType())).Serialize(writer, obj, ns);
            var element = doc.Root;
            if (element != null)
                element.Remove();
            return element;
        }

        public static T Deserialize<T>(this XContainer element, XmlSerializer serializer)
        {
            using (var reader = element.CreateReader())
            {
                object result = (serializer ?? new XmlSerializer(typeof(T))).Deserialize(reader);
                return (T)result;
            }
        }
    }

    public static class XmlSerializerFactory
    {
        // To avoid a memory leak the serializer must be cached.
        // https://stackoverflow.com/questions/23897145/memory-leak-using-streamreader-and-xmlserializer
        // This factory taken from 
        // https://stackoverflow.com/questions/34128757/wrap-properties-with-cdata-section-xml-serialization-c-sharp/34138648#34138648

        readonly static Dictionary<Tuple<Type, string, string>, XmlSerializer> cache;
        readonly static object padlock;

        static XmlSerializerFactory()
        {
            padlock = new object();
            cache = new Dictionary<Tuple<Type, string, string>, XmlSerializer>();
        }

        public static XmlSerializer Create(Type serializedType, string rootName, string rootNamespace)
        {
            if (serializedType == null)
                throw new ArgumentNullException();
            if (rootName == null && rootNamespace == null)
                return new XmlSerializer(serializedType);
            lock (padlock)
            {
                XmlSerializer serializer;
                var key = Tuple.Create(serializedType, rootName, rootNamespace);
                if (!cache.TryGetValue(key, out serializer))
                    cache[key] = serializer = new XmlSerializer(serializedType, new XmlRootAttribute { ElementName = rootName, Namespace = rootNamespace });
                return serializer;
            }
        }
    }

    class TestClass
    {
        public void Parse()
        {
            string xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
        "    <Objects xmlns=\"http://foo\">" +
        "       <Group index=\"1\">" +
        "           <de Attribute=\"a\">" +
        "               <GroupName>ANTRIEB</GroupName>" +
        "           </de>" +
        "           <en Attribute=\"b\">" +
        "               <GroupName>missing translation!</GroupName>" +
        "           </en>" +
        "           <Level>2</Level>" +
        "       </Group>" +
        "       <Group index=\"2\">" +
        "           <de Attribute=\"c\">" +
        "               <GroupName>BREMSEN</GroupName>" +
        "           </de>" +
        "           <Level>3</Level>" +
        "       </Group>" +
        "    </Objects>";

            XmlSerializer serializer = new XmlSerializer(typeof(DeactivationsXml));

            using (TextReader fileStream = new StringReader(xml))
            {
                var result = (DeactivationsXml)serializer.Deserialize(fileStream);

                var newXml = result.GetXml();

				ConsoleAndDebug.WriteLine("Deserialized and re-serialized XML: ");
                ConsoleAndDebug.WriteLine(newXml);
            }
        }
    }

    public class AssertionFailedException : System.Exception
    {
        public AssertionFailedException() : base() { }

        public AssertionFailedException(string s) : base(s) { }
    }

    public static class Assert
    {
        public static void IsTrue(bool value)
        {
            IsTrue(value, "failed");
        }

        public static void IsTrue(bool value, string message)
        {
            if (value == false)
                throw new AssertionFailedException(message ?? "failed");
        }
    }

    public static class ConsoleAndDebug
    {
        public static void WriteLine(object s)
        {
            Console.WriteLine(s);
            Debug.WriteLine(s);
        }
    }

    public static class XmlSerializationHelper
    {
        public static T LoadFromXml<T>(this string xmlString, XmlSerializer serial = null)
        {
            serial = serial ?? new XmlSerializer(typeof(T));
            T returnValue = default(T);
            using (StringReader reader = new StringReader(xmlString))
            {
                object result = serial.Deserialize(reader);
                if (result is T)
                {
                    returnValue = (T)result;
                }
            }
            return returnValue;
        }

        public static string GetXml<T>(this T obj, bool omitStandardNamespaces)
        {
			return obj.GetXml(null, omitStandardNamespaces);
        }
		
        public static string GetXml<T>(this T obj, XmlSerializer serializer = null, bool omitStandardNamespaces = false)
        {
            XmlSerializerNamespaces ns = null;
            if (omitStandardNamespaces)
            {
                ns = new XmlSerializerNamespaces();
                ns.Add("", ""); // Disable the xmlns:xsi and xmlns:xsd lines.
            }			
            using (var textWriter = new StringWriter())
            {
                var settings = new XmlWriterSettings() { Indent = true }; // For cosmetic purposes.
                using (var xmlWriter = XmlWriter.Create(textWriter, settings))
                    (serializer ?? new XmlSerializer(obj.GetType())).Serialize(xmlWriter, obj, ns);
                return textWriter.ToString();
            }
        }
    }
										
	public class Program
	{
		public static void Main()
		{
			Console.WriteLine("Environment version: " + Environment.Version);
			Console.WriteLine();

			new TestClass().Parse();
		}
	}
;