序列化可为空类型的正确方法是什么？

Question

我正在我的一门课程中实现 IXMLSerializable。它包含一些可为 null 的数字属性（int？double？等...）

通过 IXMLSerialized 序列化/序列化这些属性的正确方法是什么？这就是我现在正在做的事情，它有效，但显然不是正确的方法。

void IXmlSerializable.WriteXml(XmlWriter writer)
{
    ...

    if (this._PropName == null)
    {
        writer.WriteElementString("PropName", "NULL");
    }
    else
    {
        writer.WriteElementString("PropName", this._PropName.ToString());
    }
    ...
}

void IXmlSerializable.ReadXml(XmlReader reader)    
{
    string tempStr;
    ...

    reader.ReadStartElement("PropName"); 

    if (tempStr != "NULL")
    {
        this._PropName = double.Parse(tempStr);
    }
    else 
    {
        this._PropName = null;
    }
    ...
}

更新： 有人要求我提供一些背景知识来说明为什么要实现 IXmlSerialized。我正在开发一个建筑设计程序，其中我需要一个代表楼层集合的类。每个楼层都有Floor.Area面积、Floor.Height等属性。然而，楼层的标高是由总和定义的其下方的楼层高度。因此，每当Floor.Height属性发生变化或FloorCollection被修改时，楼层的标高都会被重新计算。

我需要序列化的 FloorCollection 类继承自 BindingList。如果我尝试直接序列化此类，它将序列化楼层集合，但不会序列化类中的任何属性或字段。请参阅我的 关于此的上一篇文章。

现在，我正在尝试添加限制集合中建筑物楼层的最大高度、最大顶部标高和最小底部标高的功能。因此，我使用可为空的双精度数来表示这些限制，其中空值表示不受限制。高程属性可以是正值、负值或零。因此需要有一个替代状态 null，用于标识何时没有限制。

现在我认为，总体来说，使用一个单独的布尔值来标识是否存在标高/高度限制，然后使用一个常规的双精度属性来标识限制（如果启用）是什么，可能会更容易。

Answer 1

您希望始终为属性编写 XML，但如果属性值为 null，您希望包含 xsi:nil="true" 属性。

void IXmlSerializable.WriteXml(XmlWriter writer)
{
    ...

    if (this._PropName == null)
    {
        writer.WriteStartElement("PropName");
        writer.WriteAttributeString("xsi", "nil", "http://www.w3.org/2001/XMLSchema-instance", "true");
        writer.WriteEndElement();
    }
    else
    {
        writer.WriteElementString("PropName", this._PropName.ToString());
    }
    ...
}

您可能还需要编写 xsi:type="xsd:datatype" 属性，其中 xsd 是 http://www.w3.org/2001/XMLSchema 命名空间。这将允许您在反序列化期间读回数据类型，以了解是否（以及如何）转换该值。

Answer 2

如果该元素为空，则省略该元素。

编辑

考虑一下如果您制作了添加属性的新版本会发生什么。如果您随后反序列化旧版本的副本，则包含新属性的新元素将会丢失，因此您应该正确地将属性保留为未初始化，即 null。这是相同的逻辑，扩展到现在时态。

编辑

有关如何告诉 XmlSerializer 在不编写自定义序列化程序的情况下省略 null 属性的信息，请查看 此。另外，考虑到背景信息，虽然我仍然更喜欢省略而不是 xsi:nil，但我现在认为后者是一个可以接受的解决方案。

Answer 3

您可以编写一个 null：

writer.WriteElementString("Test", null);

它只会产生一个类似 的元素，

或者要更具体地了解 null 值，您可以使用 xsi:nil 属性：

const string xsiNs = "http://www.w3.org/2001/XMLSchema-instance";
using (XmlWriter writer = XmlWriter.Create(Console.Out))
{
  writer.WriteStartElement("Test");
  writer.WriteAttributeString("xsi", "nil", xsiNs, "true");
  writer.WriteEndElement();
}

这将导致

Answer 4

void IXmlSerializable.WriteXml(XmlWriter writer)
{
  if (this._Foo == null)
  {
    writer.WriteStartElement("Foo");
    writer.WriteEndElement("Foo");
  }
  else
  {
    writer.WriteElementString("Foo", this._Foo.ToString());
  }
}