ShouldSerialize *()vs *指定的条件序列化模式

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

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

此问题特定于XmlSerializer的用法,但也欢迎有关此主题的一般信息。

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

编辑:对于那些不熟悉这两种模式的人,如果*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); } 

{propertyName}Specified模式的目的记录在XML Schema Binding Support:MinOccurs Attribute Binding Support中 。 添加它是为了支持XSD架构元素,其中:

  • 涉及元素。
  • 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; } } 

将生成以下架构,反之亦然:

         

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

你可能会问,为什么在这种情况下xsd.exe没有绑定到Nullable ? 也许是因为:

  • Nullables用于支持xsi:nil="true"属性。 请参阅Xsi:nil属性绑定支持 。
  • 直到.Net 2.0才引入Nullables,所以为此目的使用它们可能为时已晚?

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

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

(最后,我有点惊讶你的MyPropertySpecified没有setter的情况下成功运行。我似乎回想起.Net 2.0的一个版本,其中缺少{propertyName}Specified setter会引发exception。但它不再可重现在以后的版本中,我没有2.0测试。所以这可能是第三个问题。)

Windows窗体控件中的属性中记录了对ShouldSerialize{PropertyName}()方法的支持:使用ShouldSerialize和Reset方法定义默认值 。 正如您所看到的,文档位于MSDN的Windows窗体部分而不是XmlSerializer部分,因此它实际上是半隐藏function。 我不知道为什么在XmlSerializer存在对此方法和Specified属性的支持。 ShouldSerialize是在.Net 1.1中引入的,我相信在.Net 2.0中添加了MinOccurs绑定支持,所以早期的function可能不能完全满足xsd.exe开发团队的需求(或品味)?

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

  • Json.NET
  • protobuf-net (声称支持这两种模式 。)

那么,使用哪种模式?

  1. 如果xsd.exe自动为您生成{propertyName}Specified属性,或者您的类型需要跟踪XML文件中是否出现特定元素,或者您需要自动生成的XSD来指示某个值是可选的,使用这种模式并注意“陷阱”。

  2. 否则,使用ShouldSerialize{PropertyName}()模式。 它的陷阱较少,可能会得到更广泛的支持。

为了添加@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 {}} } 

由于计算了Derived类中的Prop属性,因此对于Derived类,我想序列化Comp1Comp2而不是Prop 。 事实certificate,在Derived类中的Prop属性上设置XmlIgnore属性不起作用,并且Prop无论如何都是序列化的。

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

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

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

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

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

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