一文了解protobuf

Bertha 。 2022-10-22 07:54 264阅读 0赞

**目录**

1、什么是protobuf

2、.proto文件中的关键字：

3、protobuf中的字段类型（message）

3.1 保留字段（reserved）

3.2 枚举（enum）

3.3 别名（alias）

3.4 repeated字段

3.5 使用消息嵌套

3.6 任意类型（Any）

3.7 oneof

3.8 map

4、定义服务（Service）

5、举个栗子

5.1 编写 .proto 模板文件（定义消息类型）

5.2 生成go代码

--------------------

## 1、什么是protobuf ##

Protobuf 即protocol buffers，是一种**轻便高效**的**结构化数据存储格式**，**与语言、平台无关**，可扩展可序列化。protobuf是以**二进制方式存储**的，占用空间小，性能和效率大幅度优于JSON、XML等其他的数据格式，缺点是可读性差。

Protobuf在 **.proto** 定义需要处理的结构化数据，可通过protoc工具，将 **.proto**文件转换为C、Golang、Java、Python等多种语言的代码。

## 2、.proto文件中的关键字： ##

*  syntax 版本号，有"proto3"、"proto2"
 *  package 包名
 *  option go\_package 生成go语言格式文件的路径
 *  message 定义消息
 *  service 定义服务器

## 3、protobuf中的字段类型（message） ##

### 3.1 保留字段（reserved） ###

在更新新功能时可以将某些字段/标识符保留（reserved），这样就不会被重新使用了，protoc会检查。

message A{
        reserved "aaaa","process";
    }

### 3.2 枚举（enum） ###

枚举类型适用于提供一组预定义的值，选择其中一个。如将性别定义为枚举。

message student{
        string name = 1;
        enum Gender {
            FEMALE = 0;
            MALE = 1;
        }
        Gender gender = 2;
        repeated int32 scores = 3;
    }

枚举类型的第一个选项的标识符必须是0，这也是枚举类型的默认值。

### 3.3 别名（alias） ###

别名允许为不同的枚举值赋予相同的标识符，称之为别名，需要打开 allow\_alias 选项。

message EnumAllowAlias {
      enum Status {
        option allow_alias = true;
        UNKOWN = 0;
        STARTED = 1;
        RUNNING = 1;
      }
    }

message中的STARTED 与RUNNING属于相同的标识符。

### 3.4 repeated字段 ###

repeated是protobuf中的一种限定修饰符，用来指定某一个字段可以存放同一个类型的多个数据（可以是0个或者1个），相当于Java中的List。

### 3.5 使用消息嵌套 ###

如定义两个message ，SearchResponse和Result，并在SearchResponse中嵌套引用Result:

message SearchResponse {
      message Result {
        string url = 1;
        string title = 2;
        repeated string snippets = 3;
      }
      repeated Result results = 1;
    }

### 3.6 任意类型（Any） ###

Any可以表示不在 .proto中定义任意的内置类型：

import "google/protobuf/any.proto";
    
    message ErrorStatus {
      string message = 1;
      repeated google.protobuf.Any details = 2;
    }

### 3.7 oneof ###

如果有一条包含许多字段的消息，并且最多同时设置一个字段，可以使用oneof功能来强制执行此行为并节省内存。

设置oneof的任何成员都会自动清除所有其他成员；可以使用case()或者WhichOneof()方法检查Oneof中的哪个值被设置。

message SampleMessage {
      oneof test_oneof {
        string name = 4;
        SubMessage sub_message = 9;
      }
    }

### 3.8 map ###

map中的元素是无序的；从线上解析或合并时，如果有重复的map键，则使用最后看到的键；从文本格式解析map时，如果存在重复的键，解析可能会失败。

message Foo {
        map<string, string> values = 1;
    }

## 4、定义服务（Service） ##

将消息类型用于gRPC系统（Google Remote Procedure Call），可以在 .proto文件中定义RPC服务接口和协议缓冲编译器将使用你选择的语言生成服务接口和存根。

service SearchService {
      rpc Search (SearchRequest) returns (SearchResponse);
    }

## 5、举个栗子 ##

### 5.1 编写 .proto 模板文件（定义消息类型） ###

新建 helloworld.proto：

syntax = "proto3";
    
    package test;
    
    option go_package="./";
    
    message RequestInfo{
    
        string name = 1;
        
    }
    
    message ResponseInfo{
        string message = 1;
    }
    
    service Greeter{
        rpc SaySomething(RequestInfo) returns (ResponseInfo) {}

备注：message字段中等号后面的1代表着成员变量的顺序；

### 5.2 生成go代码 ###

protoc -I . hello.proto --go_out=plugins=grpc:.