XmlSerializer 定义默认值

Question

我们有一个包含一些用户设置的 xml 文档。我们刚刚添加了一个新设置（在旧版 xml 文档中找不到），XmlSerializer 自动将其设置为 false。 我尝试了 DefaultValueAttribute 但它不起作用。关于如何使默认值为 true 有什么想法吗？这是代码：

private bool _property = true;
[DefaultValueAttribute(true)]
public bool Property 
{
    get { return _property; }
    set
    {
        if (_property != value)
        {
            _property = value;
            this.IsModified = true;
        }
    }
}

谢谢！

Answer 1

DefaultValue 会影响序列化，就好像在运行时该属性具有与 DefaultValue 所说的值相匹配的值，那么 XmlSerializer 实际上不会将该元素写出（因为它是默认值）。

我不确定它是否会影响读取时的默认值，但在快速测试中似乎不会这样做。在您的场景中，我可能只是将其设置为带有支持字段的属性，并带有字段初始值设定项，使其变为“true”。恕我直言，我比 ctor 方法更喜欢这种方法，因为它将它与您为类定义或未定义的 ctor 解耦，但这是相同的目标。

using System;
using System.ComponentModel;
using System.Xml.Serialization;
using System.IO;

class Program
{
    static void Main(string[] args)
    {
        var serializer = new XmlSerializer(typeof(Testing));

        string serializedString;
        Testing instance = new Testing();
        using (StringWriter writer = new StringWriter())
        {
            instance.SomeProperty = true;
            serializer.Serialize(writer, instance);
            serializedString = writer.ToString();
        }
        Console.WriteLine("Serialized instance with SomeProperty={0} out as {1}", instance.SomeProperty, serializedString);
        using (StringReader reader = new StringReader(serializedString))
        {
            instance = (Testing)serializer.Deserialize(reader);
            Console.WriteLine("Deserialized string {0} into instance with SomeProperty={1}", serializedString, instance.SomeProperty);
        }
        Console.ReadLine();
    }
}

public class Testing
{
    [DefaultValue(true)]
    public bool SomeProperty { get; set; }
}

正如我在评论中提到的，关于 xml 序列化属性的页面 (http://msdn.microsoft.com/en-us/library/83y7df3e.aspx) 声称 DefaultValue 确实会使序列化程序在丢失时设置该值，但在此测试代码中并没有这样做（与上面类似，但只是反序列化 3 个输入）。

using System;
using System.ComponentModel;
using System.Xml.Serialization;
using System.IO;

class Program
{
    private static string[] s_inputs = new[]
    {
        @"<?xml version=""1.0"" encoding=""utf-16""?>
          <Testing xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xmlns:xsd=""http://www.w3.org/2001/XMLSchema"" />",

        @"<?xml version=""1.0"" encoding=""utf-16""?>
          <Testing xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xmlns:xsd=""http://www.w3.org/2001/XMLSchema"">
              <SomeProperty />
          </Testing>",

        @"<?xml version=""1.0"" encoding=""utf-16""?>
          <Testing xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xmlns:xsd=""http://www.w3.org/2001/XMLSchema"">
              <SomeProperty>true</SomeProperty>
          </Testing>",
    };

    static void Main(string[] args)
    {
        var serializer = new XmlSerializer(typeof(Testing));

        foreach (var input in s_inputs)
        {
            using (StringReader reader = new StringReader(input))
            {
                Testing instance = (Testing)serializer.Deserialize(reader);
                Console.WriteLine("Deserialized string \n{0}\n into instance with SomeProperty={1}", input, instance.SomeProperty);
            }
        }
        Console.ReadLine();
    }
}

public class Testing
{
    [DefaultValue(true)]
    public bool SomeProperty { get; set; }
}

Answer 2

无论它如何记录工作，我也没有看到反序列化时分配 DefaultValue。对我来说，解决方案只是在类构造函数中设置默认值并放弃 DefaultValueAttribute。

Answer 3

关于斯科特的最后回复。

当未找到任何元素时，默认构造函数将任何数组属性设置为“null”。我已将该属性设置为新的空数组（因此是空数组的实例），但 XmlSerializer 在进行反序列化时会绕过此设置并将其设置为“null”。

类的示例：

[XmlElement("Dtc")]
public DtcMarketMapping[] DtcMarketMappingInstances
{
    get { return dtcMarketMappingInstances; }
    set { dtcMarketMappingInstances = value; }
}

但是，它可能是特定于数组的内容，并且您的答案对于在类的构造函数中为简单属性设置默认值仍然有效。

不管怎样，谢谢大家的回答。

Answer 4

在构造函数中设置默认值。如果该值存在于文件中，则仅在反序列化期间才会更改该值。

public class MySettingsClass
{
    public MySettingsClass()
    {
        _property = true;
    }

    private bool _property = true;
    public bool Property 
    {
        get { return _property; }
        set
        {
            if (_property != value)
            {
                _property = value;
                this.IsModified = true;
            }
        }
    }
}

Answer 5

DefaultValueAttribute 实际上不会对您正在运行的代码执行任何操作。它（主要）由属性浏览器使用（例如，当您将对象绑定到 PropertyGrid 时）来了解默认值应该是什么，以便当该值不同于默认值时，它们可以执行一些“特殊”操作默认值。这就是 Visual Studio 中的属性网格如何知道何时将值设为粗体（表明它与默认值不同。

XmlSerializer 正在将您的 _property 字段设置为 false 因为这是 bool 的 .NET Framework 默认值。

实现此目的的最简单方法可能是使用默认类构造函数并在其中设置值。