c# 序列化文件兼容性考虑

Question

自编程序升级后类数据结构有变化，如何让升级后的软件能兼容序列化读取旧版的文件呢？不做任何处理读取旧文件会直接崩溃。
比如class Desk()
{double[] colors;string Names}
序列化为文件a1
升级后变成
class Desk()
{double[] colors;
string Names;
int []numbers}
序列化读取a1报错，因为a1中没有numbers。这种情况要怎么处理。有时候甚至会新增一个类。
那么客户保存的旧版文件，用新版程序打开的时候，按新结构读肯定会报错。要怎么处理呢？

Answer 1

路人甲v01 上午好☀️☀️☀️️
本答案参考ChatGPT-3.5

在升级后的软件中兼容序列化读取旧版文件的问题可以通过以下几种方式解决：

1. 使用版本控制：给序列化的类添加一个版本号属性，在升级后的软件中，可以根据文件中的版本号来判断如何正确地读取旧版文件。如果文件的版本号与当前程序的版本号不匹配，可以执行一些兼容性逻辑。例如，在旧版文件中没有新增的属性时，可以在反序列化后手动为新增的属性赋默认值。

2. 使用可选属性：在序列化的类中，将新添加的属性声明为可选属性（使用[OptionalField]属性标记），这样在反序列化旧版文件时，遇到新增的属性时不会报错，而是将其设为默认值。

3. 自定义序列化/反序列化过程：通过自定义ISerializable接口实现类的序列化和反序列化过程。在升级后的软件中，可以根据旧版文件的结构进行适当的反序列化处理。例如，可以在反序列化方法中判断文件的版本号，然后根据不同的版本号适配不同的对象结构。

下面是使用版本控制的示例代码：

[Serializable]
class Desk : ISerializable
{
    private double[] colors;
    private string name;
    private int[] numbers; // 新增的属性
    
    // 版本号
    private const int CURRENT_VERSION = 2;

    // 构造函数
    public Desk()
    {
        colors = new double[3];
        name = "Default";
        numbers = new int[3];
    }

    // 序列化方法
    public void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        info.AddValue("Colors", colors);
        info.AddValue("Name", name);
        info.AddValue("Numbers", numbers);
        info.AddValue("Version", CURRENT_VERSION);
    }

    // 反序列化方法
    protected Desk(SerializationInfo info, StreamingContext context)
    {
        colors = (double[])info.GetValue("Colors", typeof(double[]));
        name = (string)info.GetValue("Name", typeof(string));

        // 新增属性的处理
        if(info.GetInt32("Version") >= 2)
        {
            numbers = (int[])info.GetValue("Numbers", typeof(int[]));
        }
        else
        {
            numbers = new int[3]; // 默认值
        }
    }
}

这样，在升级后的软件中可以正确读取旧版文件，并且在旧版文件中找不到新增的属性时，可以为其设定默认值，确保程序不会崩溃。