如何使 XmlSerializer.Deserialize 正确处理 DefaultAttribute？

Question

Microsoft XmlSerializer 中似乎存在错误/不一致：如果您的属性标记为 System.ComponentModel.DefaultValue 属性，则不会序列化。很公平 - 这可以被视为一种预期的行为。

问题是反序列化时不尊重相同的属性。下面的代码说明了这个问题。

问题是我怎样才能绕过这个？我可能有数百个业务类在 UI 层（视图）中使用了默认值，因此构造函数中的默认值初始化不是一个选项。它必须是通用的。我可以创建一个全新的默认属性，但这似乎是重复的工作。您是否看到了覆盖 XmlSerializer 行为的方法，或者我应该只使用另一个可以更好地完成工作的序列化程序？

示例代码：

public class DefaultValueTestClass
{
    [System.ComponentModel.DefaultValue(10000)]
    public int Foo { get; set; }
}

[TestMethod]
public void SimpleDefaultValueTest()
{
    // Create object and set the property value TO THE DEFAULT
    var before = new DefaultValueTestClass();
    before.Foo = 10000;
    // Serialize => xml
    var serializer = new System.Xml.Serialization.XmlSerializer(typeof(DefaultValueTestClass));
    string xml;
    using (var stream = new System.IO.StringWriter())
    {
        serializer.Serialize(stream, before);
        xml = stream.ToString();
    }

    // Deserialize the same object
    DefaultValueTestClass after;
    using (var reader = new System.IO.StringReader(xml))
    {
        after = (DefaultValueTestClass)serializer.Deserialize(reader);
    }

    // before.Foo = 10000
    // after.Foo = 0
    Assert.AreEqual(before.Foo, after.Foo);
}

Answer 1

实现默认值是你的工作； [DefaultValue] 只是说“这是默认设置，您无需担心这一点”——它没有应用它。这不仅适用于XmlSerializer，还适用于[DefaultValue] 所属的核心System.ComponentModel API（它驱动PropertyGrid 中的粗体/非粗体等）

基本上：

public class DefaultValueTestClass
{
    public DefaultValueTestClass()
    {
        Foo = 10000;
    }
    [DefaultValue(10000)]
    public int Foo { get; set; }
}

将以您期望的方式工作。如果你想让它序列化它是否是那个特定的值，那么正确的实现是：

public class DefaultValueTestClass
{
    public DefaultValueTestClass()
    {
        Foo = 10000;
    }
    public int Foo { get; set; }
}

如果您想保留[DefaultValue]，但希望它始终序列化，那么：

public class DefaultValueTestClass
{
    [DefaultValue(10000)]
    public int Foo { get; set; }

    [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
    public bool ShouldSerializeFoo() { return true; }
}

其中ShouldSerialize* 是System.ComponentModel 中的另一个模式，可被多个序列化程序识别。

---

这里有一些 UI 代码表明 XmlSerializer 实际上所做的事情与 UI 代码（基于 System.ComponentModel）一直所做的完全相同：

using System.ComponentModel;
using System.Windows.Forms;
static class Program
{
    [System.STAThread]
    static void Main()
    {
        Application.EnableVisualStyles();
        using (var form = new Form())
        using (var grid = new PropertyGrid())
        {
            grid.Dock = DockStyle.Fill;
            var obj = new DefaultValueTestClass
            {   // TODO - try with other numbers to
                // see bold / not bold
                Foo = 10000
            };
            // note in the grid the value is shown not-bold; that is
            // because System.ComponentModel is saying
            // "this property doesn't need to be serialized"
            // - or to show it more explicitly:
            var prop = TypeDescriptor.GetProperties(obj)["Foo"];
            bool shouldSerialize = prop.ShouldSerializeValue(obj);
            // ^^^ false, because of the DefaultValueAttribute
            form.Text = shouldSerialize.ToString(); // win title

            grid.SelectedObject = obj;
            form.Controls.Add(grid);
            Application.Run(form);            
        }
    }
}

public class DefaultValueTestClass
{
    [System.ComponentModel.DefaultValue(10000)]
    public int Foo { get; set; }
}