Question

我知道ShouldSerialize *模式和* Specified模式以及它们如何工作，但两者之间有什么区别吗？

当某些事情应该有条件地序列化时，是否有任何“陷阱”使用一种方法而不是另一种方法？

此问题仅针对XmlSerializer的使用情况，但也欢迎有关此主题的一般信息。

关于这个主题的信息很少，所以可能是因为它们执行完全相同的目的而且它是一种风格选择。然而，看起来奇怪的是.NET实现者会通过反射来分析类，并查找其中一个/两个模式来确定生成的序列化程序的行为，因为它会减慢序列化程序的生成速度，除非它只是一个向后兼容性工件。

编辑：对于那些不熟悉这两种模式的人，如果*Specified属性或ShouldSerialize*方法返回true，那么该属性将被序列化。

public string MyProperty { get; set; }

//*Specified Pattern
[XmlIgnore]
public bool MyPropertySpecified { get{ return !string.IsNullOrWhiteSpace(this.MyProperty); } }

//ShouldSerialize* Pattern
public bool ShouldSerializeMyProperty()
{
     return !string.IsNullOrWhiteSpace(this.MyProperty);
}

Answer 1

{propertyName}Specified模式的目的记录在XML Schema Binding Support: MinOccurs Attribute Binding Support中。它被添加以支持XSD架构元素，其中包括：

涉及 <element> 元素。
minOccurs 为零。
maxOccurs 属性指示单个实例。
数据类型转换为值类型。

在这种情况下，xsd.exe /classes将自动生成（或者您可以手动生成）与schema元素同名的属性和{propertyName}Specified boolean get / set属性，用于跟踪是否该元素在XML中遇到，应该序列化为XML。如果遇到该元素，{propertyName}Specified设置为true，否则设置为false。因此，反序列化的实例可以确定该属性是否在原始XML中未设置（而不是显式设置为其默认值）。

还为模式生成实现了逆。如果使用与上述模式匹配的一对属性定义C＃类型，则使用xsd.exe生成相应的XSD文件，将相应的minOccurrs添加到模式中。例如，给定以下类型：

public class ExampleClass
{
    [XmlElement]
    public decimal Something { get; set; }

    [XmlIgnore]
    public bool SomethingSpecified { get; set; }
}

将生成以下架构，反之亦然：

<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ExampleClass" nillable="true" type="ExampleClass" />
  <xs:complexType name="ExampleClass">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="1" name="Something" type="xs:decimal" />
    </xs:sequence>
  </xs:complexType>
</xs:schema>

请注意，虽然xsd.exe仅记录为自动为值类型属性生成{propertyName}Specified属性，但XmlSerializer将在手动用于引用类型属性时遵循该模式。

您可能会问，为什么xsd.exe在这种情况下不会绑定到Nullable<T>？也许是因为：

Nullables用于支持xsi:nil="true"属性。见Xsi:nil Attribute Binding Support。
直到.Net 2.0才引入Nullables，所以为此目的使用它们可能为时已晚？

您需要了解此模式，因为xsd.exe有时会自动为您生成它，但是属性与其Specified属性之间的交互很奇怪且容易产生错误。您可以填写类中的所有属性，然后序列化为XML并丢失所有内容，因为您还没有将相应的Specified属性设置为true。这个“问题”不时出现在这里，例如， this question或this one also。

使用此模式的另一个“问题”是，如果您需要使用不支持此模式的序列化程序序列化您的类型，可能希望在序列化期间手动禁止此属性的输出，并且可能需要在反序列化期间手动设置它。由于每个序列化程序可能都有自己的自定义机制来抑制属性（或根本没有机制！），这样做会随着时间的推移变得越来越繁重。

（最后，我有点惊讶你的MyPropertySpecified在没有setter的情况下成功运行。我似乎回想起.Net 2.0的一个版本，其中缺少{propertyName}Specified setter会导致异常但是它在以后的版本中不再可重复，我没有2.0测试。所以这可能是第三个问题。）

Properties in Windows Forms Controls: Defining Default Values with the ShouldSerialize and Reset Methods中记录了对ShouldSerialize{PropertyName}()方法的支持。正如您所看到的，文档位于MSDN的Windows窗体部分而不是XmlSerializer部分，因此它实际上是半隐藏功能。我不知道为什么支持这种方法和Specified属性都存在于XmlSerializer中。 .Net 1.1中引入了ShouldSerialize，而我相信在.Net 2.0中添加了MinOccurs绑定支持，因此早期的功能可能并不完全满足需求（或品尝xsd.exe开发团队？

因为它不是属性的方法，所以它缺少{propertyName}Specified模式的“陷阱”。它在实践中似乎也更受欢迎，并已被其他序列化程序采用，包括：

Json.NET
protobuf-net（声称supports both patterns。）

那么，使用哪种模式？

如果xsd.exe自动为您生成{propertyName}Specified属性，或者您的类型需要跟踪XML文件中是否出现特定元素，或者您需要自动生成的XSD为了表明某个值是可选的，请使用此模式并注意“陷阱”。
否则，请使用ShouldSerialize{PropertyName}()模式。它的陷阱较少，可能得到更广泛的支持。

Answer 2

为了添加@dbc的详细答案，我遇到了在派生类中管理序列化的问题。在我的情况下，我有一个基类和一个派生类，其中Prop属性被覆盖。

public class BaseClass
{
    public virtual string Prop {get; set;}
}

public class Derived: BaseClass
{
    public string Comp1 {get; set;}
    public string Comp2 {get; set;}
    public override string Prop {get => Comp1 + Comp2; set {}}
}

由于计算了派生类中的Prop属性，对于Derived类，我想序列化Comp1和Comp2但不是Prop。事实证明，在XmlIgnore类中的Prop属性上设置Derived属性不起作用，并且Prop仍然是序列化的。

我还尝试在ShouldSerializeProp类中添加PropSpecified方法和Derived属性，但都不起作用。我尝试设置断点以查看它们是否被调用而它们不是。

事实证明，XmlSerializer正在查看原始类，其中Prop属性首次出现在类层次结构中，以决定是否序列化属性。为了能够控制派生类中的序列化，首先我必须在virtual ShouldSerializeProp类中添加Base。

public class Base
{
    .....
    public virtual bool ShouldSerializeProp() {return true;}
}

然后我可以覆盖ShouldSerializeProp类中的Derived并返回false。

public class Derived: Base
{
    .....
    public override bool ShouldSerializeProp() {return false;}
}

此模式允许不同的派生类从它们序列化的父类中选择哪些属性。希望这可以帮助。

ShouldSerialize （）vs 指定的条件序列化模式

2 个答案:

ShouldSerialize *（）vs *指定的条件序列化模式

2 个答案:

ShouldSerialize （）vs 指定的条件序列化模式