Protobuf-net enum обратная совместимость

Question

Я пытался добавить новое значение enum для определенного класса protobuf-serialized в новой версии приложения, а во время тестирования заметил, что предыдущая версия генерирует исключение, учитывая этот новый формат файла :

 
An unhandled exception of type 'ProtoBuf.ProtoException' occurred in protobuf-net.dll 
Additional information: No {enum-type-name} enum is mapped to the wire-value 3 

это довольно очевидно, что это говорит мне, что нет никакого значения перечисления для int значения 3, но я всегда была идея, что 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

Поскольку v1 находится под открытым небом, есть ли некоторые метаданные, которые я могу использовать при сериализации в версии 2, чтобы избежать этой проблемы? Я могу, конечно, избавиться от этой проблемы, переписав v2, чтобы использовать отдельное свойство и оставить значения перечисления неизмененными, но я хотел бы сделать переходы обратно совместимыми, если это возможно.

То, что вы испытываете это Protobuf-сеть ошибка описана здесь protobuf-net - issue #422: Invalid behaviour while deserializing unknown enum value.

Кажется, что это еще не исправлено в соответствии с здесь protobuf-net faulty enum exception (issue 422) need a good workaround (и, конечно, ваше сообщение).

К сожалению, вам необходимо исправить исходный код protobuf-net или использовать обходные пути.

UPDATE: Я проверил код в репозитории 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 2

В вашем классеV1 отсутствует передовая совместимость.

Я бы применил протокол 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 3

Вы можете добавить атрибут DefaultValue к свойству proto member.

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

Чтобы уточнить, как должно быть инициализировано свойство для случая по умолчанию.

Answer 4

Добавление [ProtoContract(EnumPassthru=true)] к вашим перечислениям позволит protobuf-net десериализовать неизвестные значения.

К сожалению, нет способа ретроактивно исправить ваш v1. Вам придется использовать другое свойство.