ProtobufAny.park

Posted 2022-12-15 绝世好阿狸

protobuf中的消息定义需要指定类型，试想一下，如果需要一种通用的类型该怎么办？

protobuf中提供了Any机制，可以让我们在protobuf定义中不指定具体类型，在运行时指定类型进行解析，有点类似编程语言里的泛型思想（姑且这么说吧。。。）

message TestParams1 
    uint32 id = 1;
    string name = 2;


message TestMsg7 
    google.protobuf.Any pass_through = 1;

比如在这个例子里，我们定义了TestMsg7消息类型，里面有一个Any类型的字段，这个字段的类型不需要在pb里指定，运行时指定。

    @Test
    public void test9() throws InvalidProtocolBufferException 
        MyProto.TestMsg7 msg = MyProto.TestMsg7.newBuilder()
                .setPassThrough(Any.pack(
                        MyProto.TestParams1.newBuilder()
                        .setId(1)
                        .setName("ly")
                        .build()
                ))
                .build();

        byte[] data = msg.toByteArray();
        MyProto.TestMsg7 msg1 = MyProto.TestMsg7.parseFrom(data);
        MyProto.TestParams1 params = msg1.getPassThrough().unpack(MyProto.TestParams1.class);
        System.out.println(params);

        MyProto.TestParams2 params2 = msg1.getPassThrough().unpack(MyProto.TestParams2.class);
    

这里首先在msg的pass_through字段了塞了一个TestParams1类型的参数，然后在解析时，使用unpack函数解析。

第一次使用相同的类型unpack，没有问题；第二次使用不同的类型unpack，运行时报错：

com.google.protobuf.InvalidProtocolBufferException: Type of the Any message does not match the given class.

 

小结：

使用Any定义类型无关的字段，运行时指定，需要匹配；

一些需要通用设计的场景可以用，一般用不到；