如何使用XmlSerializer将字符串序列化为CDATA？

90

是否可以通过某种属性使用.Net XmlSerializer将字符串序列化为CDATA？

c#  .net  xml-serialization 
— 詹姆斯哈哈维
source
2
关于这两个答案，值得注意的一件事是，CDataContent如果您只阅读XML ，则不需要。XmlSerializer.Deserialize会自动将其转换为文本。
— 克里斯·S

Answers:

62 
[XmlRoot("root")]
public class Sample1Xml
{
    internal Sample1Xml()
    {
    }

    [XmlElement("node")]
    public NodeType Node { get; set; }

    #region Nested type: NodeType

    public class NodeType
    {
        [XmlAttribute("attr1")]
        public string Attr1 { get; set; }

        [XmlAttribute("attr2")]
        public string Attr2 { get; set; }

        [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));
                }

                Content = value[0].Value;
            }
        }
    }

    #endregion
}
— 约翰·桑德斯
source
8
在我看来，这似乎不是最优雅的解决方案。这是唯一可行的方法吗？
— jamesaharvey
1
我认为这是完成此任务的唯一方法，我在其他地方也看到过该主题，并且答案始终相同。菲利普（Philip）的例子更加清晰，但概念相同。我所知道的唯一的另一种方式是实现自己的<a href=" msdn.microsoft.com/en-us/library/...>上表示CDATA内容的一类。
— csharptest.net
我想做同样的事情，因为好像存储字符串一样，因为CDATA似乎意味着更少的处理时间，因为这样我们可以“仅”“按原样”读取/写入字符串。XmlDocument / XmlCDataSection实例的价格是多少？
— tishma 2012年
而且整个属性都在那儿，因此我们能够使域模型类与序列化逻辑细节保持整洁。如果肮脏的方法是唯一的方法，那就太可悲了。
— tishma 2012年
2
菲利普的解决方案在页面的下方，这是一件比较整洁的事情。
— 卡尔
99 
[Serializable]
public class MyClass
{
    public MyClass() { }

    [XmlIgnore]
    public string MyString { get; set; }
    [XmlElement("MyString")]
    public System.Xml.XmlCDataSection MyStringCDATA
    {
        get
        {
            return new System.Xml.XmlDocument().CreateCDataSection(MyString);
        }
        set
        {
            MyString = value.Value;
        }
    }
}

用法：

MyClass mc = new MyClass();
mc.MyString = "<test>Hello World</test>";
XmlSerializer serializer = new XmlSerializer(typeof(MyClass));
StringWriter writer = new StringWriter();
serializer.Serialize(writer, mc);
Console.WriteLine(writer.ToString());

输出：

<?xml version="1.0" encoding="utf-16"?>
<MyClass xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MyString><![CDATA[<test>Hello World</test>]]></MyString>
</MyClass>
— pr0gg3r
source
这只是挽救了我的一天。谢谢。
— 罗伯特
4
//如果您需要空的CDATA，则可以在源值为null的情况下设置默认值，以避免出现异常。 XmlDocument().CreateCDataSection(MyString ?? String.Empty);
— Asereware 2014年
@ pr0gg3r这是否还允许反序列化到同一对象？我遇到了麻烦
— Martin
如何创建CDATA作为文本值（而不是元素），例如<MyClass> <！[CDATA [<test> Hello World </ test>]]> </ MyClass>？
— mko，2015年
1
只需要能够处理空值/空值，而不是输出<emptyfield> <！[CDATA []]> </ emptyfield>
— bluee 2015年
91

除了John Saunders发布的方法之外，您还可以直接使用XmlCDataSection作为类型，尽管它归结为几乎相同的东西：

private string _message;
[XmlElement("CDataElement")]
public XmlCDataSection Message
{  
    get 
    { 
        XmlDocument doc = new XmlDocument();
        return doc.CreateCDataSection( _message);
    }
    set
    {
        _message = value.Value;
    }
}
— 菲利普·里克
source
1
@Philip，这对反序列化有效吗？我一直在看到说明说，setter将收到XmlText值。
— 约翰·桑德斯
1
@John Saunders-实际上，它在反序列化期间会在setter中接收到XmlCharacterData值，这就是在setter中对.Value的调用（我本来是从内存中将它作为ToString（）的，但这是不正确的。）
— Philip Rieck
1
@PhilipRieck如果我们需要在CDataSection周围包装一个自定义对象该怎么办。创建CDataSection接受字符串。
— 齐柏林飞艇2015年
谢谢！最简单的解决方案。对我来说很好。
— AntonioRodríguez19年
42

在要序列化的类中：

public CData Content { get; set; }

和CData类：

public class CData : IXmlSerializable
{
    private string _value;

    /// <summary>
    /// Allow direct assignment from string:
    /// CData cdata = "abc";
    /// </summary>
    /// <param name="value">The string being cast to CData.</param>
    /// <returns>A CData object</returns>
    public static implicit operator CData(string value)
    {
        return new CData(value);
    }

    /// <summary>
    /// Allow direct assignment to string:
    /// string str = cdata;
    /// </summary>
    /// <param name="cdata">The CData being cast to a string</param>
    /// <returns>A string representation of the CData object</returns>
    public static implicit operator string(CData cdata)
    {
        return cdata._value;
    }

    public CData() : this(string.Empty)
    {
    }

    public CData(string value)
    {
        _value = value;
    }

    public override string ToString()
    {
        return _value;
    }

    public System.Xml.Schema.XmlSchema GetSchema()
    {
        return null;
    }

    public void ReadXml(System.Xml.XmlReader reader)
    {
        _value = reader.ReadElementString();
    }

    public void WriteXml(System.Xml.XmlWriter writer)
    {
        writer.WriteCData(_value);
    }
}
— 萨吉斯
source
奇迹般有效。谢谢。
— Leonel Sanches da Silva
3
这个答案值得更多的认可。虽然，自定义CData类型不再具有System.String类型喜欢的那些便捷的内置方法。
— Lionet Chen
好的，然后是第一个答案
— 陈信裕
答案很棒。遗憾的是XmlElement无法在字符串字段上工作，然后您可以添加一个cdata类型，但无论如何...
— jjxtra
完善！谢谢！
— 罗伊
4

就我而言，我使用的是混合字段，有些不是CDATA，至少对我来说，以下解决方案有效。

通过始终读取“值”字段，无论是CDATA还是纯文本，我都可以获取内容。

    [XmlElement("")]
    public XmlCDataSection CDataValue {
        get {
            return new XmlDocument().CreateCDataSection(this.Value);
        }
        set {
            this.Value = value.Value;
        }
    }

    [XmlText]
    public string Value;

迟到总比不到好。

干杯

— Coderookie
source
太棒了-我觉得这个答案为我节省了很多时间！有关信息，我在[Value
— d219
这在操作上与pr0gg3r的答案有何不同？
— 鲁芬
4

我有类似的需求，但需要不同的输出格式-我想要包含CDATA的节点上的属性。我从上述解决方案中得到了一些启发，以创建自己的解决方案。也许将来会对某人有所帮助...

public class EmbedScript
{
    [XmlAttribute("type")]
    public string Type { get; set; }

    [XmlText]
    public XmlNode[] Script { get; set; }

    public EmbedScript(string type, string script)
    {
        Type = type;
        Script = new XmlNode[] { new XmlDocument().CreateCDataSection(script) };
    }

    public EmbedScript()
    {

    }
}

在要序列化的父对象中，我具有以下属性：

    [XmlArray("embedScripts")]
    [XmlArrayItem("embedScript")]
    public List<EmbedScript> EmbedScripts { get; set; }

我得到以下输出：

<embedScripts>
    <embedScript type="Desktop Iframe">
        <![CDATA[<div id="play_game"><iframe height="100%" src="http://www.myurl.com" width="100%"></iframe></div>]]>
    </embedScript>
    <embedScript type="JavaScript">
        <![CDATA[]]>
    </embedScript>
</embedScripts>
— 亚当·黑
source
我需要完全做到这一点。谢谢！！
— Lews Therin
2

此实现可以处理您正在编码的字符串中的嵌套CDATA（基于John Saunders的原始答案）。

例如，假设您想将以下文字字符串编码为CDATA：

I am purposefully putting some <![CDATA[ cdata markers right ]]> in here!!

您可能希望结果输出看起来像这样：

<![CDATA[I am purposefully putting some <![CDATA[ cdata markers right ]]]]><![CDATA[> in here!!]]>

以下实现将遍历字符串，将实例拆分...]]>...为...]]，>...并为每个实例创建单独的CDATA部分。

[XmlRoot("root")]
public class Sample1Xml
{
    internal Sample1Xml()
    {
    }

    [XmlElement("node")]
    public NodeType Node { get; set; }

    #region Nested type: NodeType

    public class NodeType
    {
        [XmlAttribute("attr1")]
        public string Attr1 { get; set; }

        [XmlAttribute("attr2")]
        public string Attr2 { get; set; }

        [XmlIgnore]
        public string Content { get; set; }

        [XmlText]
        public XmlNode[] CDataContent
        {
            get
            {
                XmlDocument dummy = new XmlDocument();
                List<XmlNode> xmlNodes = new List<XmlNode>();
                int tokenCount = 0;
                int prevSplit = 0;
                for (int i = 0; i < Content.Length; i++)
                {
                    char c = Content[i];
                    //If the current character is > and it was preceded by ]] (i.e. the last 3 characters were ]]>)
                    if (c == '>' && tokenCount >= 2)
                    {
                        //Put everything up to this point in a new CData Section
                        string thisSection = Content.Substring(prevSplit, i - prevSplit);
                        xmlNodes.Add(dummy.CreateCDataSection(thisSection));
                        prevSplit = i;
                    }
                    if (c == ']')
                    {
                        tokenCount++;
                    }
                    else
                    {
                        tokenCount = 0;
                    }
                }
                //Put the final part of the string into a CData section
                string finalSection = Content.Substring(prevSplit, Content.Length - prevSplit);
                xmlNodes.Add(dummy.CreateCDataSection(finalSection));

                return xmlNodes.ToArray();
            }
            set
            {
                if (value == null)
                {
                    Content = null;
                    return;
                }

                if (value.Length != 1)
                {
                    throw new InvalidOperationException(
                        String.Format(
                            "Invalid array length {0}", value.Length));
                }

                Content = value[0].Value;
            }
        }
    }
— 伊恩·弗雷泽（Iain Fraser）
source
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.