C#中实现版本不兼容序列化的最佳实践是什么？

方案1：用BinaryFormatter（最贴近Java serialVersionUID逻辑） #

虽然BinaryFormatter被官方标为过时（仅适合完全信任的本地环境），但它是最省心的实现：

• 给你要缓存的对象类加上[Serializable]属性。
• 直接序列化你的Dictionary集合到文件，反序列化时只要对象结构（字段名、类型、数量）变了，就会自动抛出SerializationException。你只要捕获这个异常，就知道要重建缓存了。

代码示例：

// 序列化缓存
using (var stream = File.Create("cache.bin"))
{
    var formatter = new BinaryFormatter();
    formatter.Serialize(stream, yourCacheDictionary);
}

// 反序列化尝试
try
{
    using (var stream = File.OpenRead("cache.bin"))
    {
        var formatter = new BinaryFormatter();
        yourCacheDictionary = (Dictionary<string, YourObject>)formatter.Deserialize(stream);
    }
}
catch (SerializationException)
{
    // 结构变更或缓存损坏，重建缓存
    yourCacheDictionary = BuildNewCache();
}

注意：如果给字段加了[OptionalField]，BinaryFormatter会兼容旧版本，所以要严格失效就别用这个属性。

方案2：用System.Text.Json（现代安全，可控性强） #

如果不想用过时的API，用Json也很简单：

• 把缓存数据和一个手动维护的版本号打包成一个类，序列化时一起写入文件。
• 反序列化时先校验版本号，不一致就直接重建缓存；就算忘了改版本号，对象结构变了时Json反序列化也会抛JsonException，捕获即可。

代码示例：

// 定义包装类
public class CacheWrapper<T>
{
    public int Version { get; set; } = 1; // 结构变了就改这个数
    public T Data { get; set; }
}

// 序列化
var wrapper = new CacheWrapper<Dictionary<string, YourObject>> { Data = yourCacheDictionary };
File.WriteAllText("cache.json", JsonSerializer.Serialize(wrapper));

// 反序列化
const int CurrentVersion = 1;
try
{
    var json = File.ReadAllText("cache.json");
    var wrapper = JsonSerializer.Deserialize<CacheWrapper<Dictionary<string, YourObject>>>(json);
    if (wrapper?.Version != CurrentVersion)
        throw new InvalidOperationException("版本不匹配");
    yourCacheDictionary = wrapper.Data;
}
catch (Exception)
{
    yourCacheDictionary = BuildNewCache();
}

最简推荐 #

如果就想少写代码，直接用BinaryFormatter的方案，不用手动维护版本号，结构一变反序列化必失败，完全满足你的需求。

内容的提问来源于stack exchange，提问作者Andreas