Google Protobuf入门与使用

[toc]

---

Google Protobuf入门与使用

Protobuf是Google的编解码技术，在业界十分流行，经过代码生成工具能够生成不一样语言版本的源代码。

Protobuf代码生成工具与使用

protobuf下载

访问Google的Protobuf项目页须要×××，可是其也把代码放到了Github上，而且提供了不须要编译便可进行使用的版本，地址以下：
Protobuf Github地址。

在学习《Netty权威指南》时，使用的是protobuf 2.x的版本，但因为protobuf具备向前兼容的特性，因此即便下载3.x的版本也是能够使用2.x的功能特性，这里我下载3.5.1的版本，注意protobuf的代码生成工具名为protoc。

使用protoc生成java代码

要使用protoc生成java代码，须要先编写.proto文件，下面使用的是《Netty权威指南》中的例子。

SubscribeReq.proto

syntax = "proto2";
package netty;
option java_package = "cn.xpleaf.protobuf";
option java_outer_classname = "SubscribeReqProto";

message SubscribeReq{
    required int32 subReqID = 1;
    required string userName = 2;
    required string productName = 3;
    repeated string address = 4;
}

SubscribeResp.proto

syntax = "proto2";
package netty;
option java_package = "cn.xpleaf.protobuf";
option java_outer_classname = "SubscribeRespProto";

message SubscribeResp{
    required int32 subReqID = 1;
    required int32 respCode = 2;
    required string desc = 3;
}

注意上面的.proto文件中，指定了语法格式为proto2，即protobuf 2的语法，默认也是使用proto2的语法。

运行脚本生成java代码

$ ./protoc --java_out=./ SubscribeResp.proto
$ ./protoc --java_out=./ SubscribeReq.proto

这样在当前目录下便生成了java代码：

$ tree cn
cn
└── xpleaf
    └── protobuf
        ├── SubscribeReqProto.java
        └── SubscribeRespProto.java

2 directories, 2 files

这样只要将生成的java代码复制到咱们的项目工程中，再导入protobuf的依赖，就能够正常使用protobuf的编解码功能了。

protobuf使用

使用《Netty权威指南》中的例子，代码以下：

TestSubscribeReqProto.java

package cn.xpleaf.demo;

import java.util.ArrayList;
import java.util.List;

import com.google.protobuf.InvalidProtocolBufferException;

import cn.xpleaf.protobuf.SubscribeReqProto;

public class TestSubscribeReqProto {

    /**
     * 编码方法，将SubscribeReqProto.SubscribeReq对象编码为字节数组
     * @param req
     * @return
     */
    private static byte[] encode(SubscribeReqProto.SubscribeReq req) {
        return req.toByteArray();
    }

    /**
     * 解码方法，将字节数组解码为SubscribeReqProto.SubscribeReq对象
     * @param body
     * @return
     * @throws InvalidProtocolBufferException
     */
    private static SubscribeReqProto.SubscribeReq decode(byte[] body) throws InvalidProtocolBufferException{
        return SubscribeReqProto.SubscribeReq.parseFrom(body);
    }

    /**
     * 经过SubscribeReqProto.SubscribeReq的静态方法newBuilder建立SubscribeReqProto.SubscribeReq的
     * Builder实例，经过Builder构建器对SubscribeReq的属性进行设置，对于集合类型，经过addAllxxx()方法
     * 能够将集合对象设置到对应到的属性中，最后经过builder的build方法返回设置好属性的SubscribeReqProto.SubscribeReq对象
     * @return
     */
    private static SubscribeReqProto.SubscribeReq createSubscribeReq(){
        SubscribeReqProto.SubscribeReq.Builder builder = SubscribeReqProto.SubscribeReq.newBuilder();
        builder.setSubReqID(1);
        builder.setUserName("xpleaf");
        builder.setProductName("Netty Book");
        List<String> address = new ArrayList<>();
        address.add("NanJing YuHuaTai");
        address.add("BeiJing LiuLiChange");
        address.add("ShenZhen HongShuLin");
        builder.addAllAddress(address);
        return builder.build();
    }

    public static void main(String[] args) throws InvalidProtocolBufferException {
        // 建立SubscribeReqProto.SubscribeReq对象
        SubscribeReqProto.SubscribeReq req = createSubscribeReq();
        // 输出编码前的SubscribeReqProto.SubscribeReq对象req的值
        System.out.println("Before encode : " + req.toString());
        // 获取解码后的SubscribeReqProto.SubscribeReq对象
        SubscribeReqProto.SubscribeReq req2 = decode(encode(req));
        // 输出解码后的SubscribeReqProto.SubscribeReq对象req2的值
        System.out.println("After decode : " + req.toString());
        // 比较req与req2的值是否相等 --- true说明
        System.out.println("Assert equal : -->" + req2.equals(req));
    }
}

测试

运行结果以下：

Before encode : subReqID: 1
userName: "xpleaf"
productName: "Netty Book"
address: "NanJing YuHuaTai"
address: "BeiJing LiuLiChange"
address: "ShenZhen HongShuLin"

After decode : subReqID: 1
userName: "xpleaf"
productName: "Netty Book"
address: "NanJing YuHuaTai"
address: "BeiJing LiuLiChange"
address: "ShenZhen HongShuLin"

Assert equal : -->true