Google Protobuf擴展字段使用

背景說明

Google Protobuf中不支持數據結構的派生關系，因此，如果在存在派生體系的對象中定義數據結構時，通過組合方式對數據結構進行組合，則需要對基類對象提供的通用接口進行重載或在外部進行動態轉型才能達到獲取或設置數據的目的。

因此考慮使用Google Protobuf提供的extension擴展機制解決數據結構之間的不能派生的問題，以此來達到減少重復工作量和便於維護代碼的目的。

使用說明

1. 定義公共數據類型
   

   描述：

   此數據類型為對象派生體系同基類提供的公共數據類型

   示例：

    

   // 公共數據類型
   message BaseDataType
   {
       extensions 100 to max;   //標識此字段可擴展，此處可指定擴展字段的ID有效范圍，to max表示字段范圍至最大值
       optional string BaseField1 = 1;
       optional string BaseField2= 2;
       ...
   } 

2. 定義擴展數據類型
   

   描述：

   此數據類型為對象派生體系中派生類使用的數據類型

   示例：

   message ChildDataType
   {
       extend BaseDataType
       {
           optional ChildDataType ChildData = 100;     // 將子數據類型整體擴展至公共數據中
           optional int32  ExtendValue = 101;          // 擴展具體數據類型
       }
       optional string ChildField1 = 1;
       optional string ChildField2= 2;
       ...
   } 

    

    
3. 初始化數據類型
   

   描述：

   公共數據類型與普通數據類型使用相同，此處僅說明擴展數據類型使用方法

   示例：

    

   // 對象基類
   class BaseClass
   {
       public BaseClass()
       {
            m_pData = new BaseDataType();
       }
   public:
       Message* m_pData;
   };
    
   // 對象派生類
   class ChildClass : public BaseClass
   {
       public ChildClass ()
       {
           BaseDataType * pBaseData = new BaseDataType();
           // 創建愛你擴展數據類型
           ChildDataType* pChildData = pBaseData->MutableExtension(ChildDataType::ChildData);
           //初始化數據
           pChildData-> set_childfield1("123");
           pBaseData->SetExtension(ChildDataType::ExtendValue, 123);
       }
   }; 

    

4. 使用數據類型
   

   描述：

   通過HasExtension、GetExtension、MutableExtension來訪問數據；

   示例：

   // 構造對象訪問擴展數據類型數據
   BaseClass* pBaseObj = new ChildClass();
   BaseDataType* pBaseData = dynamic_cast<BaseDataType*>(pBaseObj->m_pData);
   assert(pBaseData->HasExtension(ChildDataType::ChildData));
   // 獲取擴展數據
   const ChildDataType& childdata = pBaseData->GetExtension(ChildDataType::ChildData);
   int value = pBaseData->GetExtension(ChildDataType::ExtendValue); 

    

5. 數據復制及傳輸

   描述：

   C++代碼中數據復制及傳輸解析與普通數據類型相同，此處僅說明C#代碼中需要注意事項。

   C#中通過ParseFrom進行字節數據轉換時，需要傳入對擴展數據結構的說明信息ExtensionRegistry，否則擴展數據字段將作為未知數據處理。

   示例：

   // 構造擴展數據類型
   ChildDataType.Builder childdata = new ChildDataType.Builder();
   childdata.ChildField1 = "123";
   // 構造公共數據類型
   BaseDataType.Builder basedata = new BaseDataType.Builder();
   basedata.SetExtension(ChildDataType.ChildData,
   childdata.Build());
    
   // 轉換至字節數據數據
   byte[] buf = basedata.Build().ToByteArray();
    
   // 創建擴展字段信息
   ExtensionRegistry registry = ExtensionRegistry.CreateInstance();
   registry.Add(ChildDataType.ChildData);
   registry.Add(ChildDataType.ExtendValue);
    
   // 從字節數據轉換
   BaseDataType basedataCopy = BaseDataType.ParseFrom(buf, registry);
   System.Diagnostics.Debug.Assert(basedataCopy.HasExtension(ChildDataType.ChildData));