Protobuf 结合 Java 快速入门

曾经终败给现在 2021-10-01 09:36 349阅读 0赞

## 什么是 Protobuf？ ##

*  Protobuf 是 Google 开发的一种**数据交换的序列化协议**，性能非常高，大部分 IM 通讯协议都是使用它来传输，例如支付宝、微信等 APP

## 安装 Protobuf ##

### Window 系统 ###

1.  下载需要的安装包：[https://github.com/google/protobuf/releases][https_github.com_google_protobuf_releases]
    
     *  protoc-3.6.0-win32.zip
     *  protobuf-java-3.6.0.zip
2.  将 protoc-3.6.0-win32.zip 中的 protoc.exe 拷贝到 c:\\windows\\system32 中
3.  将 proto.exe 文件拷贝到解压后的 protobuf-java-3.6.0\\src 目录中
4.  在 protobuf-java-3.6.0\\java 目录下执行 mvn package 命令（这一步相当于安装了）
5.  执行 protoc –-version 命令检查是否安装成功

### MAC 系统 ###

*  对于 Mac 系统只需要使用 brew 安装即可

brew install protobuf

## Protobuf 描述文件 ##

> 更详细的描述文件编写可以阅读该篇文章：[https://blog.csdn.net/u011518120/article/details/54604615\#ScalarValueTypes][https_blog.csdn.net_u011518120_article_details_54604615_ScalarValueTypes]

*  **Protobuf 编译器通过描述文件（.proto文件）生成对应于语言的代码，代码中定义了消息类型、获取、设置、编解码序列化等操作**。这也是为什么 Protobuf 支持跨语言传输，因为消息所有端共用一个通用的描述文件

### 定义一个消息类型 ###

*  下面 .proto 文件定义了一个 "搜索请求" 消息格式

syntax = "proto3";  // 指定使用 proto3 语法
    
    option java_package = "com.test";     // 指定包名
    option java_outer_classname = "ProtoBufTest"; // 指定类名
    
    message SearchRequest { 
      string query = 1;     // 指定字段类型为 string，标识号为 1
      int32 page_number = 2;
      int32 result_per_page = 3;
      enum Corpus {         // 枚举类型
        UNIVERSAL = 0;      // 每个枚举类型必须将其第一个类型映射为 0 作为默认值
        WEB = 1;
        IMAGES = 2;
        LOCAL = 3;
        NEWS = 4;
        PRODUCTS = 5;
        VIDEO = 6;
      }
      Corpus corpus = 4;
      repeated Result results = 5;
    }
    
    message Result  {
        ...
    }

*  **标识号:每个字段都有唯一的数字标识号，需要注意的是 \[1,15\] 之内的标识在编码时只占用 1 字节，\[16,2047\] 之内的占用 2 字节，所以应该对那些频繁出现的消息元素预留 \[1,15\] 之内的标识号**

### 导入定义 ###

*  如果要使用的消息类型已在其它 .proto 文件中定义过，则可以通过导入其它 .proto 文件定义来使用它们

import "xxxx/xxx.proto";

### 字段类型 ###

*  字段类型参考如下图

![9434708-87380ecff5ad7324.png][]

[noaSi.png][]

![9434708-1de416c65260d2a2.png][]

[noPaY.png][]

## Java 使用 Protobuf ##

*  编写 gps\_data.proto 描述文件

syntax = "proto3";
    
    option java_package = "com.test"; 
    option java_outer_classname = "GpsDataProto";
    
    message gps_data {
        int64 id = 1;
        string terminalId = 2;
        string dataTime = 3;
        double lon = 4;
        double lat = 5;
        float speed = 6;
        int32 altitude = 7;
        int32 locType = 8;
        int32 gpsStatus = 9;
        float direction = 10;
        int32 satellite = 11;
    }

*  执行下面命令编译生成 Java 代码
    
     *  \-I 后面是 proto 文件所在目录
     *  \--java\_out 后面是 java 文件存放地址
     *  最后一行是 proto 文件名称

protoc -I=src/main/resource/proto --java_out=src/main/java gps_data.proto

*  引入依赖

<dependency>
        <groupId>com.google.protobuf</groupId>
        <artifactId>protobuf-java</artifactId>
        <version>3.5.1</version>
    </dependency>

*  在代码中使用该类

public class Main {
        public static void main(String[] args) {
            System.out.println("===== 构建一个GPS模型开始 =====");
            GpsDataProto.gps_data.Builder gps_builder = GpsDataProto.gps_data.newBuilder();
            gps_builder.setAltitude(1);
            gps_builder.setDataTime("2017-12-17 16:21:44");
            gps_builder.setGpsStatus(1);
            gps_builder.setLat(39.123);
            gps_builder.setLon(120.112);
            gps_builder.setDirection(30.2F);
            gps_builder.setId(100L);
    
            GpsDataProto.gps_data gps_data = gps_builder.build();
            System.out.println(gps_data.toString());
            System.out.println("===== 构建GPS模型结束 =====");
    
            System.out.println("===== gps Byte 开始=====");
            for (byte b : gps_data.toByteArray()) {
                System.out.print(b);
            }
            System.out.println("\n" + "bytes长度" + gps_data.toByteString().size());
            System.out.println("===== gps Byte 结束 =====");
    
            System.out.println("===== 使用gps 反序列化生成对象开始 =====");
            GpsDataProto.gps_data gd = null;
            try {
                gd = GpsDataProto.gps_data.parseFrom(gps_data.toByteArray());
            } catch (InvalidProtocolBufferException e) {
                e.printStackTrace();
            }
            System.out.print(gd.toString());
            System.out.println("===== 使用gps 反序列化生成对象结束 =====");
        }
    }

[https_github.com_google_protobuf_releases]: https://github.com/google/protobuf/releases
[https_blog.csdn.net_u011518120_article_details_54604615_ScalarValueTypes]: https://blog.csdn.net/u011518120/article/details/54604615#ScalarValueTypes
[9434708-87380ecff5ad7324.png]: /images/20210811/dec07345ceb04aaea143378e1a5cdf1f.png
[noaSi.png]: https://simimg.com/i/noaSi
[9434708-1de416c65260d2a2.png]: /images/20210811/62331fcb0a934e0c8c96f547fc23700b.png
[noPaY.png]: https://simimg.com/i/noPaY