.NET 序列化在不同框架版本之间的稳定性

Question

我正在开发的一个项目需要在关闭之前序列化数据结构，并在再次启动时从该序列化数据恢复其状态。

去年，我们正在为 .NET 1.1 进行构建，并遇到了一个棘手的问题，

• 我们的代码在 .NET 2.0 上运行，
• 客户使用某些软件进行升级，该软件以某种方式将 1.1 设置为默认值，
• 我们的代码在 .NET 1.1 上运行，并且无法反序列化其存储状态

这个特定问题已通过禁止特定软件升级而“解决”，并且现在不应该成为问题，因为我们的目标是 .NET 2.0 框架（因此我们不可能在 1.1 上运行）。

这种序列化在 2.0 和更新的框架之间再次发生不兼容变化的可能性有多大？ 如果我们使用 将代码修复为 2.0.50727，那么 2.0.50727.1434 和 2.0.50727.nnnn（未来的某个版本）之间发生更改的可能性有多大？ 被序列化的数据结构是来自标准类库的数组、映射、字符串等。

此外，即使在进一步升级 .NET 后，是否也能保证始终安装 2.0.50727 框架？ 欢迎指向 Microsoft 文档。

Answer 1

框架版本之间发生变化的可能性很低（但不是零！）。 目的是您应该能够使用二进制序列化和远程处理在运行不同框架版本的客户端和服务器之间进行通信。 .NET 1.x 和 2.0 之间的不兼容性是一个错误 有可用的补丁。

然而，二进制序列化还有其他问题，特别是对正在序列化的结构的版本控制的支持很差。 从您描述的用例来看，Xml 序列化是显而易见的选择：如果您不介意对 .NET 3.x 的依赖，DataContractSerializer 比 XmlSerializer 更灵活。

您无法保证 .NET Framework 2.0 将始终安装在未来版本的 Windows 上。 但我确信 Microsoft 将努力确保大多数 .NET 2.0 应用程序在 .NET 4.x 及更高版本上运行不变。 我对此没有任何参考：任何此类承诺在任何情况下都仅真正适用于下一版本的 Windows (Windows 7)。

Answer 2

经验法则通常是：XML 序列化应该能够在新的框架版本中生存，因此可以长期存储，但二进制序列化不能（因此只能是暂时的）。

Answer 3

你使用什么序列化器？ 在许多方面，像 XmlSerializer 或 DataContractSerializer 这样的序列化器可以缓冲许多细节，并提供更简单的可扩展性选项。
在某些时候，新的 CLR 版本无疑是必要的 - 所以我认为没有人可以对 2.0.50727 做出任何保证； 不过，短期内你应该是安全的。 我希望减少重大更改...

[更新了另一个回复的注释]

如果您出于空间/性能原因需要二进制格式，那么另一个选择是使用不同的二进制序列化器。 例如，protobuf-net 适用于所有 .NET 变体*，但二进制文件格式（由 Google 制定）是跨平台兼容的（Java、C++ 等）——使其非常便携、快速且小巧。

*=我还没有在微框架上尝试过，但是CF、Silverlight、Mono、.NET 2.0等都支持。

Answer 4

如果兼容性是一个问题，ISerialized界面可能是您正在寻找的解决方案。 此界面使您可以更好地控制项目的序列化方式。 有关详细信息，请尝试这篇 msdn 上的文章。

Answer 5

我有两件事要添加到其他答案中......

首先，使用自定义 SerializationBinder 可以帮助您解决导入遗留序列化数据的许多困难。

其次，我认为必须为任何持久数据编写广泛的单元测试。 我总是特别做两个测试：

1. 往返测试 - 你能序列化和反序列化你的对象并得到完全相同的东西吗？
2. 旧版导入测试 - 确保您拥有从应用程序的每个发布版本导出的序列化数据版本。 导入数据并检查一切是否按预期返回。

Answer 6

理论上，XML 应该始终可以在不同版本的 .NET Framework/.NET Core/.NET 之间移植。 但规则总有例外。

例如，如果您以 XML 格式移动 System.Data.DataTable，并且如果其中一些数据表包含 System.Guid 类型的列，那么您'很可能会带来惊喜！ 请考虑以下示例代码：

using System;
using System.Data;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Serialization;

public class Program
{
    internal static string SerializeToXml<T>(T input)
    {
        var writerSettings = new XmlWriterSettings()
        {
            Encoding = new UTF8Encoding(false),
            Indent = true
        };
        using (var stream = new MemoryStream())
        using (var writer = XmlWriter.Create(stream, writerSettings))
        {
            (new XmlSerializer(typeof(T))).Serialize(writer, input);
            return Encoding.UTF8.GetString(stream.ToArray());
        }
    }

    public static void Main()
    {
        var dt = new DataTable("Name");
        dt.Columns.Add("Example", typeof(Guid));
        Console.WriteLine(SerializeToXml(dt));
    }
}

与大多数其他系统类型不同，System.Guid 获取列定义中包含的特定于版本的 msdata:DataType 属性，并且会抛出 System.InvalidOperationException：当不兼容的运行时尝试反序列化列时，包装 System.ArgumentException：列需要有效的 DataType 的 XML 文档 (.., ...) 中存在错误。

.NET Framework 4.7.2 输出：

<?xml version="1.0" encoding="utf-8"?>
<DataTable>
  <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Name" msdata:UseCurrentLocale="true">
      <xs:complexType>
        <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element name="Name">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="Example" msdata:DataType="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" type="xs:string" minOccurs="0" />
              </xs:sequence>
            </xs:complexType>
          </xs:element>
        </xs:choice>
      </xs:complexType>
    </xs:element>
  </xs:schema>
  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" />
</DataTable>

.NET Core 3.1 输出：（是的，它输出版本 4.0.0.0）

<?xml version="1.0" encoding="utf-8"?>
<DataTable>
  <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Name" msdata:UseCurrentLocale="true">
      <xs:complexType>
        <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element name="Name">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="Example" msdata:DataType="System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e" type="xs:string" minOccurs="0" />
              </xs:sequence>
            </xs:complexType>
          </xs:element>
        </xs:choice>
      </xs:complexType>
    </xs:element>
  </xs:schema>
  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" />
</DataTable>

.NET 5 输出：

.NET 5
<?xml version="1.0" encoding="utf-8"?>
<DataTable>
  <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Name" msdata:UseCurrentLocale="true">
      <xs:complexType>
        <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element name="Name">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="Example" msdata:DataType="System.Guid, System.Private.CoreLib, Version=5.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e" type="xs:string" minOccurs="0" />
              </xs:sequence>
            </xs:complexType>
          </xs:element>
        </xs:choice>
      </xs:complexType>
    </xs:element>
  </xs:schema>
  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" />
</DataTable>

.NET 6 输出：

<?xml version="1.0" encoding="utf-8"?>
<DataTable>
  <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Name" msdata:UseCurrentLocale="true">
      <xs:complexType>
        <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element name="Name">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="Example" msdata:DataType="System.Guid, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e" type="xs:string" minOccurs="0" />
              </xs:sequence>
            </xs:complexType>
          </xs:element>
        </xs:choice>
      </xs:complexType>
    </xs:element>
  </xs:schema>
  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" />
</DataTable>

.NET 7 输出：

<?xml version="1.0" encoding="utf-8"?>
<DataTable>
  <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Name" msdata:UseCurrentLocale="true">
      <xs:complexType>
        <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element name="Name">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="Example" msdata:DataType="System.Guid, System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e" type="xs:string" minOccurs="0" />
              </xs:sequence>
            </xs:complexType>
          </xs:element>
        </xs:choice>
      </xs:complexType>
    </xs:element>
  </xs:schema>
  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" />
</DataTable>

Answer 7

您不必使用 XML 即可获得更高的灵活性和版本控制。

我使用了 Simon Hewitt 的开源库，请参阅优化.NET 中的序列化 - 第 2 部分，而不是默认的 .NET 序列化。 它提供了一些自动化功能，但本质上您可以控制序列化和反序列化的信息流。 对于版本控制，可以首先序列化（文件）版本
反序列化时间以及解释信息流的方式取决于版本。

做起来很简单，尽管由于明确的原因而有些乏味
序列化/反序列化。

作为奖励，它的速度提高了 20-40 倍，并且对于大型数据集占用的空间更少（但对于您的情况来说可能并不重要）。