如何防止XmlSerialzer转义“嵌套xml”

本文关键字：嵌套 xml 转义 何防止 XmlSerialzer | 更新日期: 2023-09-27 17:53:05

我正在使用XmlSerializer来序列化/反序列化复杂对象。一个属性包含一个XML字符串，该字符串应该被写入字符串属性中，而不需要反序列化。

示例(在LinqPad中可执行): 

[XmlRoot("RootObject")]
[Serializable]
public class RootClass
{
    [XmlArray("SubObjects")]
    [XmlArrayItem("SubObject")]
    public SubClass[] SubObjecs { get; set;} 
}
[Serializable]
public class SubClass
{
    [XmlElement("XmlConfiguration")]
    public string XmlConfiguration { get; set;}
}
void Main()
{
    var obj = new RootClass()
    {
        SubObjecs = new[]
        {
            new SubClass { XmlConfiguration = "<ConfigurationX>SomeConfiguration1</ConfigurationX>" },
            new SubClass { XmlConfiguration = "<ConfigurationY>SomeConfiguration2</ConfigurationY>" }
        }
    };
    var serializer = new XmlSerializer(typeof(RootClass));
    using (var stream = new MemoryStream())
    {
        serializer.Serialize(stream, obj);
        stream.Position = 0;
        Console.WriteLine(Encoding.UTF8.GetString(stream.GetBuffer()));
    }
}

示例的输出是:

<?xml version="1.0"?>
<RootObject xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <SubObjects>
        <SubObject>
            <XmlConfiguration>&lt;ConfigurationX&gt;SomeConfiguration1&lt;/ConfigurationX&gt;</XmlConfiguration>
        </SubObject>
        <SubObject>
            <XmlConfiguration>&lt;ConfigurationY&gt;SomeConfiguration2&lt;/ConfigurationY&gt;</XmlConfiguration>
        </SubObject>
    </SubObjects>
</RootObject>

XML是一个配置文件，有时以编程方式编写，但主要是由人编写/修改。因此，XmlConfiguration中的XML不应该包含转义字符。

问题:是否有可能防止XmlSerializer转义'<'和'>'字符?如果没有，是否有其他序列化器可以使用?

一个可行的选项是XmlWriter.WriteRaw。然而，如果可能的话，我将避免这种不可靠且不易维护的解决方案。

我在这里发现了一个类似的问题:如何防止XmlSerializer转义<和比;字符。但是这个问题与CDATA[[Content]]有关，对于我的问题没有答案。>

如何防止XmlSerialzer转义“嵌套xml”

如上所述，有一种使用XmlAnyElement属性的解决方案，如下所述:反序列化动态XML

我找到了XmlSerializer和XmlWriter.WriteRaw的混合物。在实现IXmlSerializable时，可以控制XmlSerializer的序列化过程。因此，IXmlSerializable必须只针对需要特殊处理的类实现(这对我来说是OK的):

[Serializable]
public class SubClass : IXmlSerializable
{
    [XmlElement("XmlConfiguration")]
    public string XmlConfiguration { get; set; }
    public void WriteXml(XmlWriter writer)
    {
        writer.WriteStartElement("XmlConfiguration");
        writer.WriteRaw(XmlConfiguration);
        writer.WriteEndElement();
    }
    public void ReadXml(XmlReader reader)
    {
        reader.ReadToDescendant("XmlConfiguration");
        XmlConfiguration = reader.ReadInnerXml();
        reader.ReadEndElement();
    }
    public XmlSchema GetSchema()
    {
        return (null);
    }
}

如果需要CDATA封装，可以使用XmlCDataSection class。您可以使用class作为xml元素的类型。您可以根据需要为每个不同类型的元素更改名称或属性。

public class XmlConfiguration //Or any other class name.
    {
        [XmlAttribute("attr1")]
        public string Attr1 { get; set; } //You don't need this but use if you need attribute.
        [XmlAttribute("attr2")]
        public string Attr2 { get; set; } //Or second one.
        [XmlIgnore]
        public string Content { get; set; }
        [XmlText]
        public XmlNode[] CDataContent
        {
            get
            {
                var dummy = new XmlDocument();
                return new XmlNode[] {dummy.CreateCDataSection(Content)};
            }
            set
            {
                if (value == null)
                {
                    Content = null;
                    return;
                }
                if (value.Length != 1)
                {
                    throw new InvalidOperationException(
                        String.Format(
                            "Invalid array length {0}", value.Length));
                }
                var node0 = value[0];
                var cdata = node0 as XmlCDataSection;
                if (cdata == null)
                {
                    throw new InvalidOperationException(
                        String.Format(
                            "Invalid node type {0}", node0.NodeType));
                }
                Content = cdata.Data;
            }
        }
    }

我在这里找到了答案。点击链接查看完整讨论

相关文章：