关于在Java中如何更简单的使用google protobuf

冷不防 2023-06-21 07:24 5阅读 0赞

protobuf中的.proto文件能很好的统筹交互双方的协议，但为开发带来了一定阻碍。  
在Java里，protobuf使用了immutable（不可变）机制来控制数据的生成源。具体的说，在Java里想要通过protobuf传出一个对象，就要先构造一个该对象的协议文件（.proto文件）的builder对象，通过往这个对象set数据以后，并且调用对象的build方法（由该对象生成一个immutable对象）生成一个可被protobuf解析的对象。到这一步业务层应该可以告一段落，框架层随之会将其序列化为二进制数据，再做接下来的处理。  
也许google是为了防止序列化数据中途被篡改，才用了这套繁杂的步骤，但在开发者眼里这些很可能是多余的。于是我在网上找到了protostuff工具。它能简单的将javabean转化为protobuf的二进制数据，而无需中间的set、build等操作。但protostuff官方并未提供demo。在网上搜了一番以后找到一个示例 https://blog.csdn.net/zhglance/article/details/56017926 ，但实践以后发现输出的二进制数据在遇到含有repeated型的message时无法正常解析。于是我去看了下protostuff的源码，发现它并不是一个单纯的javabean<—>protobuf的编译工具，而是一个包含了其他许多语言、协议的编译工具集合。由于网上没有正确的protostuff使用实例，故在此撰文，希望能对protobuf的使用者带来一点帮助。  
下面贴上部分代码

maven引用：

<dependency>  
            <groupId>io.protostuff</groupId>  
            <artifactId>protostuff-core</artifactId>  
            <version>1.6.0</version>  
        </dependency>  
        <dependency>  
            <groupId>io.protostuff</groupId>  
            <artifactId>protostuff-runtime</artifactId>  
            <version>1.6.0</version>  
        </dependency>  
        <dependency>  
            <groupId>io.protostuff</groupId>  
            <artifactId>protostuff-api</artifactId>  
            <version>1.6.0</version>  
        </dependency>  
  
ProtostuffUtil.java

public class ProtostuffUtil \{

/\*\*  
     \* 序列化  
     \*  
     \* @param obj  
     \* @return  
     \*/  
    public static <T> byte\[\] serializer(T obj) \{  
        @SuppressWarnings("unchecked")  
        Class<T> clazz = (Class<T>) obj.getClass();  
        LinkedBuffer buffer = LinkedBuffer.allocate(LinkedBuffer.DEFAULT\_BUFFER\_SIZE);  
        try \{  
            Schema<T> schema = RuntimeSchema.getSchema(clazz);  
            return ProtobufIOUtil.toByteArray(obj, schema, buffer);  
        \} catch (Exception e) \{  
            e.printStackTrace();  
            throw new IllegalStateException(e.getMessage(), e);  
        \} finally \{  
            buffer.clear();  
        \}  
    \}

/\*\*  
     \* 反序列化  
     \*  
     \* @param data  
     \* @param clazz  
     \* @return  
     \*/  
    public static <T> T deserializer(byte\[\] data, Class<T> clazz) \{  
        try \{  
            T obj = clazz.newInstance();  
            Schema<T> schema = RuntimeSchema.getSchema(clazz);  
            ProtobufIOUtil.mergeFrom(data, obj, schema);  
            return obj;  
        \} catch (Exception e) \{  
            e.printStackTrace();  
            throw new IllegalStateException(e.getMessage(), e);  
        \}  
    \}

\}  
  
这里的Obj可以是和协议相同的简单javabean，例如一个简单的心跳协议：

heartbeat.proto

option java\_package = "proto";  
option java\_outer\_classname = "HeartbeatProto";

message GS2C\_Heartbeat\{  
    optional int64 serverTime = 1; // 服务器时间  
\}  
与之对应的javabean可以是：  
SampleJavabean.java

public class SampleJavabean \{  
    private long serverTime;

public long getServerTime() \{  
        return serverTime;  
    \}

public void setServerTime(long serverTime) \{  
        this.serverTime = serverTime;  
    \}  
\}  
想要发送这个协议，可以

SampleJavabean instance = new SampleJavabean();  
instance.setServerTime(new Date().getTime());  
byte\[\] message = ProtostuffUtil.serializer(instance);  
//发送  
Util.doPost(message);  
想要解析这个协议，可以

//获取请求数据流  
Object message = Util.getRequest(req);

SampleJavabean instance = (SampleJavabean) ProtostuffUtil.deserializer((byte\[\]) message, SampleJavabean.class);  
  
over~~

另外项目中如果协议很多很庞大，自己手写javabean比较累（尤其是中途准备使用protostuff）或者为了避免手写javabean出错，protostuff也提供了一套从.proto文件到javabean的编译器。这个等笔者有空了总结下发出来。  
————————————————  
版权声明：本文为CSDN博主「盯紧你自己」的原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接及本声明。  
原文链接：https://blog.csdn.net/mossss21/article/details/82909403