Protobuf-net 枚举向后兼容

Question

我试图在一个新的应用版本中为某个 protobuf 序列化类添加一个新的枚举值，并且在测试时注意到，鉴于这种新的文件格式，以前的版本会抛出异常：

protobuf-net.dll 中发生了“ProtoBuf.ProtoException”类型的未处理异常 附加信息：没有 {enum-type-name} 枚举映射到线值 3

很明显，它告诉我3 的int 值没有枚举值，但我一直认为Protocol Buffers defaulted to the zero-valued ("default") enum value（如果存在），以防实际枚举值无法映射到。

为了澄清，这可以使用以下示例重现（我有意将反序列化步骤放入不同的类中，以模仿尝试加载新格式的旧应用程序）：

// --- version 1 ---

public enum EnumV1
{
    Default = 0,
    One = 1,
    Two = 2
}

[ProtoContract]
public class ClassV1
{
    [ProtoMember(1)]
    public EnumV1 Value { get; set; }
}



// --- version 2 ---

public enum EnumV2
{
    Default = 0,
    One = 1,
    Two = 2,
    Three = 3 // <- newly added
}

[ProtoContract]
public class ClassV2
{
    [ProtoMember(1)]
    public EnumV2 Value { get; set; }
}

而且下面的代码会失败：

// serialize v2 using the new app
var v2 = new ClassV2() { Value = EnumV2.Three };
var v2data = Serialize(v2);

// try to deserialize this inside the old app to v1
var v1roundtrip = Deserialize<ClassV1>(v2data);

由于 v1 已公开，在 v2 中序列化时是否可以使用一些元数据来避免此问题？当然，我可以通过重写 v2 以使用单独的属性并使枚举值保持不变来摆脱这个麻烦，但如果可能的话，我想让枚举向后兼容。

Answer 1

将 [ProtoContract(EnumPassthru=true)] 添加到您的枚举将允许 protobuf-net 反序列化未知值。

很遗憾，无法追溯修复您的 v1.1 版本。您必须使用不同的属性。

Answer 2

由于 v1 已公开，在 v2 中序列化时是否可以使用一些元数据来避免此问题？当然，我可以通过重写 v2 以使用单独的属性并使枚举值保持不变来摆脱这个麻烦，但如果可能的话，我想让枚举向后兼容。

您遇到的是一个 protobuf-net 错误，此处描述为 protobuf-net - issue #422: Invalid behaviour while deserializing unknown enum value。

根据这里的protobuf-net faulty enum exception (issue 422) need a good workaround（当然还有你的帖子），它似乎还没有修复。

不幸的是，您需要修复protobuf-net 源代码或使用提到的解决方法。

更新：我检查了GitHub 存储库中的代码，并确认问题仍未解决。这是EnumSerializer.cs 内有问题的代码（ISSUE #422 注释是我的）：

public object Read(object value, ProtoReader source)
{
    Helpers.DebugAssert(value == null); // since replaces
    int wireValue = source.ReadInt32();
    if(map == null) {
        return WireToEnum(wireValue);
    }
    for(int i = 0 ; i < map.Length ; i++) {
        if(map[i].WireValue == wireValue) {
            return map[i].TypedValue;
        }
    }
    // ISSUE #422
    source.ThrowEnumException(ExpectedType, wireValue);
    return null; // to make compiler happy
}

Answer 3

您的 ClassV1 缺乏前向兼容性。

我会以序列化/反序列化枚举值的字符串表示的方式实现 Proto 合约。这样您就可以自己处理回退到默认值。 Value 属性不会被序列化/反序列化。

public enum EnumV1
{
    Default = 0,
    One = 1,
    Two = 2
}

public enum EnumV2
{
    Default = 0,
    One = 1,
    Two = 2,
    Three = 3 // <- newly added
}

[ProtoContract]
public class ClassV1
{
    [ProtoMember(1)]
    public string ValueAsString
    {
        get { return Value.ToString(); }
        set
        {
            try
            {
                Value = (EnumV1) Enum.Parse(typeof (EnumV1), value);
            }
            catch (Exception)
            {
                Value = EnumV1.Default;
            }
        }
    }

    public EnumV1 Value { get; set; }
}

[ProtoContract]
public class ClassV2
{
    [ProtoMember(1)]
    public string ValueAsString
    {
        get { return Value.ToString(); }
        set
        {
            try
            {
                Value = (EnumV2)Enum.Parse(typeof(EnumV2), value);
            }
            catch (Exception)
            {
                Value = EnumV2.Default;
            }
        }
    }

    public EnumV2 Value { get; set; }
}

它仍然没有解决在生产环境中存在非前向兼容类的问题。

Answer 4

您可以将 DefaultValue 属性添加到您的 proto 成员属性。

[ProtoContract]
public class ClassV1
{
    [ProtoMember(1), DefaultValue(EnumV1.Default)]
    public EnumV1 Value { get; set; }
}

为了明确在默认情况下应该如何初始化属性。