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