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));