प्रोटोबफ-नेट एनम पिछड़ा संगतता

Question

मैं एक नए ऐप संस्करण में एक निश्चित प्रोटोबफ-सीरियलाइज्ड क्लास के लिए एक नया एनम मान जोड़ने की कोशिश कर रहा था, और परीक्षण करते समय, ध्यान दिया गया कि पिछले संस्करण को एक नया अपवाद फेंक दिया जाएगा, :

 
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 

यह काफी स्पष्ट है कि यह मुझे बता रही है 3 की int मूल्य के लिए कोई enum मूल्य नहीं होता है कि है, लेकिन मैं हमेशा विचार था कि Protocol Buffers defaulted to the zero-valued ("default") enum value (यदि ऐसा मौजूद है), के मामले में है कि एक वास्तविक enum मूल्य मैप नहीं किया जा सका।

स्पष्ट करने के लिए, इस reproduced किया जा सकता है कि निम्न उदाहरण (मैं जानबूझकर एक अलग वर्ग में अक्रमांकन कदम कर रहा हूँ नए प्रारूप लोड करने का प्रयास पुराने एप्लिकेशन को नकल करने के लिए) का उपयोग कर:

// --- 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 के बाद से खुले में बाहर है, वहाँ कुछ मेटाडाटा जब वी 2 में serializing इस समस्या से बचने के लिए मैं उपयोग कर सकते हैं? मैं निश्चित रूप से, एक अलग संपत्ति का उपयोग करने के लिए v2 को फिर से लिखकर इस समस्या से खुद को प्राप्त कर सकता हूं और enum मानों को अनमोडिफाइड छोड़ सकता हूं, लेकिन यदि संभव हो तो मैं पीछे की तरफ संगत बनाना चाहता हूं।

Answer 1

के बाद से v1 खुले में बाहर है, वहाँ कुछ मेटाडाटा जब वी 2 में serializing इस समस्या से बचने के लिए मैं उपयोग कर सकते हैं? मैं निश्चित रूप से, एक अलग संपत्ति का उपयोग करने के लिए v2 को फिर से लिखकर इस समस्या से खुद को प्राप्त कर सकता हूं और enum मानों को अनमोडिफाइड छोड़ सकता हूं, लेकिन यदि संभव हो तो मैं पीछे की तरफ संगत बनाना चाहता हूं।

आप क्या अनुभव कर रहे हैं एक 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 स्रोत कोड को ठीक करने या वर्णित कार्यवाही का उपयोग करने की आवश्यकता है।

अद्यतन: मैंने GitHub भंडार में कोड की जांच की है और यह पुष्टि कर रही है कि समस्या अभी भी तय नहीं है।

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

आपकी कक्षावी 1 में आगे की compatiblity की कमी है।

मैंने प्रोटो अनुबंध को इस तरह से कार्यान्वित किया होगा कि यह enum मूल्य के स्ट्रिंग प्रस्तुति को क्रमबद्ध/deserializes। इस तरह आप अपने द्वारा डिफ़ॉल्ट मूल्य पर फ़ॉलबैक को संभाल सकते हैं। मूल्य संपत्ति को क्रमबद्ध/deserialized नहीं किया जाएगा।

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

आप अपने प्रोटो सदस्य संपत्ति में डिफ़ॉल्ट वैल्यू विशेषता जोड़ सकते हैं।

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

यह स्पष्ट करने के लिए कि डिफ़ॉल्ट मामले के लिए संपत्ति को कैसे प्रारंभ किया जाना चाहिए।

Answer 4

आपके enums में [ProtoContract(EnumPassthru=true)] जोड़ना प्रोटोबफ-नेट को अज्ञात मानों को deserialize करने की अनुमति देगा।

दुर्भाग्यवश, आपके v1 को पूर्ववत करने का कोई तरीका नहीं है। आपको एक अलग संपत्ति का उपयोग करना होगा।