带条件的 XML 序列化

本文关键字:序列化 XML 条件 | 更新日期: 2023-09-27 18:36:12

我在序列化中有以下类:

[XmlRoot()]
public class XmlExample
{
private NodeA_Elem _nodea;
[XmlElemnt("NodeA")]
public NodeA_Elem NodeA
{
    get
    {
        return _nodea;
    }
    set
    {
        _nodea=value;
    }
}
private NodeB_Elem _nodeb;
[XmlElemnt("NodeB")]
public NodeB_Elem NodeB
{
    get
    {
        return _nodeb;
    }
    set
    {
        _nodeb=value;
    }
}
private NodeC_Elem _nodec;
[XmlElemnt("NodeC")]
public NodeC_Elem NodeC
{
    get
    {
        return _nodec;
    }
    set
    {
        _nodec=value;
    }
}
public class NodeA_Elem
{
    [XmlText()]
    public string value{get;set;}
}
public class NodeB_Elem
{
    [XmlText()]
    public string value{get;set;}
}
public class NodeC_Elem
{
    [XmlText()]
    public string value{get;set;}
}

如果任何类 NodaA、NodeB 或 NodeC 的值属性为空或空,我得到以下结果:

<XmlExample>
   <NodeA/>
   <NodeB/>
   <NodeC/>
</XmlExample>

如果我不设置 value 属性,我必须对这些节点做什么,这些节点看起来不像空节点?

带条件的 XML 序列化

您可以使用

ShouldSerialize* 模式,如下所示:

public bool ShouldSerializeNodeA() {
    return NodeA != null;
}

参考这里:-条件 xml 序列化

更新

使其不可为空:-

[XmlElement(IsNullable = false)]

编辑

早些时候我提到:-

public bool ShouldSerializeNodeA() {
    return NodeB != null;
}

我的错误,应该是这样的:-

public bool ShouldSerializeNodeA() {
    return NodeA != null;
}

还可以使用后缀为 x Specified的布尔属性来指示是否序列化属性。这由使用 xml 的 xml 客户端使用,这些 xml 具有默认值(例如,在 XSD 中使用 default=xxx 指定):

public bool NodeASpecified
{
    get { return _nodea != null && !String.IsNullOrEmpty(_nodea.value); }
}

不要使用任何 Xml 属性标记这些Specified属性。

不相关,但如果您使用了具有默认值和minOccurs=0的 Web 服务,则硬编码*Specified属性以在分部类中true很有用,否则如果值恰好与默认值相同,则根本不会将这些属性发送到该服务。

我添加了一些评论并找到了解决方案。我可以在我的代码中使用 ShouldSerialize 模式。生成的代码为:

[XmlRoot()]
public class XmlExample
{
    private NodeA_Elem _nodea;
    [XmlElemnt("NodeA")]
    public NodeA_Elem NodeA
    {
        get
        {
            return _nodea;
        }
        set
        {
            _nodea=value;
        }
    }
    public bool ShouldSerializeNodeA()
    {
        return !String.IsNullOrEmpty(_nodea.value);
    }
    private NodeB_Elem _nodeb;
    [XmlElemnt("NodeB")]
    public NodeB_Elem NodeB
    {
        get
        {
            return _nodeb;
        }
        set
        {
            _nodeb=value;
        }
    }
    public bool ShouldSerializeNodeB()
    {
        return !String.IsNullOrEmpty(_nodeb.value);
    }
    private NodeC_Elem _nodec;
    [XmlElemnt("NodeC")]
    public NodeC_Elem NodeC
    {
        get
        {
            return _nodec;
        }
        set
        {
            _nodec=value;
        }
    }
    public bool ShouldSerializeNodeC()
    {
        return !String.IsNullOrEmpty(_nodec.value);
    }
}
public class NodeA_Elem
{
    [XmlText()]
    public string value{get;set;}
}
public class NodeB_Elem
{
    [XmlText()]
    public string value{get;set;}
}
public class NodeC_Elem
{
    [XmlText()]
    public string value{get;set;}
}

编辑:

这是我的示例的完整代码:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
namespace Serialization_Example
{
    class Program
    {
        static void Main(string[] args)
        {
            MyXmlDocument document = new MyXmlDocument();
            document.MyExample.NodeA.value = "Value To Node A";
            document.MyExample.NodeC.value = "Value To Node C";
            document.WriteToXml(@"C:'Users'user_Name'Desktop'mydocument.xml");
        }
    }
    [XmlRoot("xmlExample")]
    public class XmlExample
    {
        private NodeA_Elem _nodea;
        [XmlElement()]
        public NodeA_Elem NodeA
        {
            get
            {
                return _nodea;
            }
            set
            {
                _nodea = value;
            }
        }
        public bool ShouldSerializeNodeA()
        {
            return !String.IsNullOrEmpty(_nodea.value);
        }
        private NodeB_Elem _nodeb;
        [XmlElement("NodeB")]
        public NodeB_Elem NodeB
        {
            get
            {
                return _nodeb;
            }
            set
            {
                _nodeb = value;
            }
        }
        public bool ShouldSerializeNodeB()
        {
            return !String.IsNullOrEmpty(_nodeb.value);
        }
        private NodeC_Elem _nodec;
        [XmlElement("NodeC")]
        public NodeC_Elem NodeC
        {
            get
            {
                return _nodec;
            }
            set
            {
                _nodec = value;
            }
        }
        public bool ShouldSerializeNodeC()
        {
            return !String.IsNullOrEmpty(_nodec.value);
        }
        public XmlExample()
        {
            _nodea = new NodeA_Elem();
            _nodeb = new NodeB_Elem();
            _nodec = new NodeC_Elem();
        }
    }
    public class NodeA_Elem
    {
        [XmlText()]
        public string value { get; set; }
    }
    public class NodeB_Elem
    {
        [XmlText()]
        public string value { get; set; }
    }
    public class NodeC_Elem
    {
        [XmlText()]
        public string value { get; set; }
    }
    public class MyXmlDocument
    {
        private XmlExample _myexample;
        public XmlExample MyExample
        {
            get
            {
                return _myexample;
            }
            set
            {
                _myexample = value;
            }
        }
        public void WriteToXml(string path)
        {
            XmlSerializer serializer = new XmlSerializer(typeof(XmlExample));
            XmlWriterSettings settings = new XmlWriterSettings();
            settings.Indent = true;
            settings.Encoding = Encoding.Unicode;
            StringWriter txtwriter = new StringWriter();
            XmlWriter xmlwtr = XmlWriter.Create(txtwriter, settings);
            serializer.Serialize(xmlwtr, MyExample);
            StreamWriter writer = new StreamWriter(path);
            writer.Write(txtwriter.ToString());
            writer.Close();
        }
        public MyXmlDocument()
        {
            _myexample = new XmlExample();
        }
    }
}

如果你编译它,你会看到如果我不设置 NodeB.value 的值,它不会像以前那样生成一个空节点。

相关文章: