Protocol Buffer多态

java中有多态的概念，protobuf本身没有多态的概念，但是它有一个扩展的概念。

以聊天消息为例，先看下面这个类图，基类是ChatMessage，子类TextMessage和ImageMessage。

ChatMessage

• id：消息ID
• from：发送者
• to：接收者
• type：消息类型（可能为点对点聊天，或者聊天室聊天）
• contentType：消息内容类型（文本消息、图片消息等）

TextMessage

• content：文本内容

ImageMessage

• url：图片的地址

父类ChatMessage的schema如下，其中声明了一个ContentType枚举，有两个值text和image，分别代表文本和图片，根据content_type可以获得扩展信息。

 package polymorphism;

 option java_package = "polymorphism";
 option java_outer_classname = "BaseChatMessageProtos";

 message ChatMessage {
   optional string id = 1;
   optional string from = 2;
   optional string to = 3;

   enum Type {
     chat = 0;
     groupchat = 1;
     error = 2;
   }

   optional Type type = 4;

   enum ContentType {
     text = 0;
     image = 1;
   }

   optional ContentType content_type = 5;

   extensions 100 to 299;
 }

子类TextMessage和ImageMessage的schema如下

 package polymorphism;

 option java_package = "polymorphism";
 option java_outer_classname = "ConcreteChatMessageProtos";

 import "polymorphism/base_chat_message.proto";

 message TextBody {
   extend ChatMessage {
     optional TextBody body = 100;
   }

   optional string content = 1;
 }

 message ImageBody {
   extend ChatMessage {
     optional ImageBody body = 101;
   }

   optional string url = 1;
 }

根据schema生成的java类，参考protobuftest工程polymorphism包路径下的BaseChatMessageProtos类和ConcreteChatMessageProtos类。

protobuftest工程下载地址：http://pan.baidu.com/s/1jIGWBf4

下面是序列化和反序列化的代码

1-8行：构造文本消息

12行：获得序列化字节数组

14-16行：创建并初始化扩展注册中心

18行：反序列化获得ChatMessage

21-23行：生成contentType和Extension（消息内容扩展描述）的映射关系，方便反序列化时获得扩展信息body

28行：根据contentType获得对应的TextMessage扩展描述，然后获得TextBody中定义的body

         ChatMessage textMessage = ChatMessage.newBuilder()
                 .setId("123")
                 .setFrom("[e-mail]")
                 .setTo("[e-mail]")
                 .setType(Type.chat)
                 .setContentType(ContentType.text)
                 .setExtension(TextBody.body, TextBody.newBuilder().setContent("hello world").build())
                 .build();

         System.out.println("*****before serialize=" + textMessage);

         byte[] bytes = textMessage.toByteArray();

         ExtensionRegistry registry = ExtensionRegistry.newInstance();
         registry.add(ImageBody.body);
         registry.add(TextBody.body);

         ChatMessage deserializedMessage = ChatMessage.parseFrom(bytes, registry);
         System.out.println("*****after deserialize");

         Map<ChatMessage.ContentType, Extension<ChatMessage, ?>> contentType2ExtensionBody = new HashMap<ChatMessage.ContentType, Extension<ChatMessage, ?>>();
         contentType2ExtensionBody.put(ContentType.text, TextBody.body);
         contentType2ExtensionBody.put(ContentType.image, ImageBody.body);

         ContentType contentType = deserializedMessage.getContentType();
         switch (contentType) {
         case text:
             TextBody deserializedTextBody = (TextBody) deserializedMessage.getExtension(contentType2ExtensionBody.get(contentType));
             System.out.println("body=" + deserializedTextBody);
             break;
         case image:
             ImageBody deserializedImageBody = (ImageBody) deserializedMessage.getExtension(contentType2ExtensionBody.get(contentType));
             System.out.println("body=" + deserializedImageBody);
             break;
         default:
             break;
         }

25-37行：根据contentType获取对应扩展信息的body。注意：可以使用多态消除case语句

以后每增加一种新的消息内容类型，在反序列化的时候只需要在contentType和Extenstion（消息内容扩展描述）的映射关系中新增一个映射，然后新增一个获取对应消息内容类型的body的子类，无需修改其他的代码。