C#Xml Serializer将列表反序列化为0而不是null

时间:2017-07-27 18:50:44

标签: c# xml serialization xmlserializer

我很担心XmlSerializer在幕后的工作原理。我有一个类将XML反序列化为一个对象。我所看到的是以下两个不是被反序列化的Xml的元素。

[XmlRootAttribute("MyClass", Namespace = "", IsNullable = false)]
public class MyClass
{
    private string comments;
    public string Comments
    {
        set { comments = value; }
        get { return comments; }
    }

    private System.Collections.Generic.List<string> tests = null;
    public System.Collections.Generic.List<string> Tests
    {
        get { return tests; }
        set { tests = value; }
    }
}

让我们以下面的XML为例:

<MyClass>
  <SomeNode>value</SomeNode>
</MyClass>

您注意到测试和评论不属于XML。

当反序列化此XML时,注释为空(这是预期的),而测试是一个计数为0的空列表。

如果有人能向我解释这一点,我将不胜感激。我更喜欢的是,如果XML中缺少<Tests>,那么列表应保持为null,但如果存在(可能为空)节点<Tests />,则应该分配列表。

4 个答案:

答案 0 :(得分:2)

您所观察到的是,引用可修改集合的成员(例如List<T>)会在反序列化开始时由XmlSerializer自动预分配。我不知道有任何记录此行为的地方。它可能与this answer XML Deserialization of collection property with code defaults 中描述的行为有关,这解释了,因为XmlSerializer supports adding to get-only and pre-allocated collections,如果是预先分配的集合包含默认项,然后将反序列化的项附加到其上 - 可能会复制内容。微软可能只是选择在反序列化开始时预分配所有可修改的集合,这是实现它的最简单方法。

该答案的解决方法,即使用代理数组属性,也适用于此。由于无法追加数组,XmlSerializer必须累积所有值,并在反序列化完成时将其设置回来。但是如果从未遇到相关标记,XmlSerializer显然不会开始累积值,因此不会调用数组设置器。这似乎阻止了您不想要的集合的默认预分配:

[XmlRootAttribute("MyClass", Namespace = "", IsNullable = false)]
public class MyClass
{
    private string comments;
    public string Comments
    {
        set { comments = value; }
        get { return comments; }
    }

    private System.Collections.Generic.List<string> tests = null;

    [XmlIgnore]
    public System.Collections.Generic.List<string> Tests
    {
        get { return tests; }
        set { tests = value; }
    }

    [XmlArray("Tests")]
    public string[] TestsArray
    {
        get
        {
            return (Tests == null ? null : Tests.ToArray());
        }
        set
        {
            if (value == null)
                return;
            (Tests = Tests ?? new List<string>(value.Length)).AddRange(value);
        }
    }
}

示例.Net fiddle显示仅在适当时分配Tests

答案 1 :(得分:0)

在Google搜索相同问题后,我们在这里结束。 我们最终要做的是在反序列化之后检查Count == 0,然后将属性手动设置为null;

...
var varMyDeserializedClass = MyXmlSerializer.Deserialize(new StringReader(myInput));
if (varMyDeserializedClass.ListProperty.Count == 0)
{
  varMyDeserializedClass.ListProperty = null;
}
...

这是一种廉价的解决方法,但可以提供预期的结果,并且对于避免重构或重新设计很有用。

答案 2 :(得分:0)

当您将 [System.Xml.Serialization.XmlElement(IsNullable = true)] 应用于属性时,反序列化后 List 将为空。

答案 3 :(得分:0)

另一种可能是使用“magic”“Specified”后缀:

public bool TestsSpecified {get;set;}

如果你有一个序列化的字段/属性XXX和一个布尔属性XXXSpecified,那么bool属性是根据是否设置了主字段/属性来设置的。