Go 语言安装及使用 Protocol Buffers

刺骨的言语ヽ痛彻心扉 2024-05-08 07:05 101阅读 0赞

## 安装步骤 ##

在开始之前，我们需要先安装和配置开发环境。

分两个步骤：

*  安装 protoc 工具
 *  安装 protoc-gen-go

### 安装 protoc 工具 ###

在下面这个网址里找到适合你系统的安装包。  
[https://github.com/protocolbuffers/protobuf/releases][https_github.com_protocolbuffers_protobuf_releases]

以win10为例，下载protoc-3.15.5-win64.zip，然后解压，如E:\\mygofile\\路径下。

解压后的文件里有 bin/protoc.exe ，这个 protoc 命令用于编译和生成代码，后面会用到。

#### 配置环境变量 ####

PB\_PATH=E:\\mygofile\\protoc-3.15.5-win64  
PATH=%PB\_PATH%\\bin

#### 在cmd命令行状态下执行protoc ####

如果配置正确则可看见返回信息。

### 安装 protoc-gen-go ###

protoc-gen-go 是 生成 Go 代码的 protocolbuffers 编译器。可以理解为一个编译器插件，配合 protoc 来使用。  
在命令行中执行：

go get -u github.com/golang/protobuf/protoc-gen-go  
这个工具用于生成 基于 Protocol Buffers 的代码。

#### go get失败问题解决 ####

在CMD命令行状态下执行，go env -w GOPROXY=https://goproxy.cn

### 定义.proto文件 ###

创建一个addressbook.proto的文件

syntax = "proto3";
    package tutorial;
    
    import "google/protobuf/timestamp.proto";
    
    message Person {
      string name = 1;
      int32 id = 2;  // Unique ID number for this person.
      string email = 3;
    
      enum PhoneType {
        MOBILE = 0;
        HOME = 1;
        WORK = 2;
      }
    
      message PhoneNumber {
        string number = 1;
        PhoneType type = 2;
      }
    
      repeated PhoneNumber phones = 4;
    
      google.protobuf.Timestamp last_updated = 5;
    }
    
    // Our address book file is just one of these.
    message AddressBook {
      repeated Person people = 1;
    }

#### 运行编译器 ####

protoc -I=E:\mygofile\mygopath\src\grpcDemo --go_out=E:\mygofile\mygopath\src\grpcDemo E:\mygofile\mygopath\src\grpcDemo\addressbook.proto

\-I=指定源目录(您的应用程序的源代码所在的位置——如果不提供值，则使用当前目录)、--go\_out=指定目标目录(您希望生成的代码所在的位置；通常与$SRC\_DIR相同)，以及到您的. proto的路径。

#### 运行报错解决办法 ####

'protoc-gen-go' 不是内部或外部命令，也不是可运行的程序
    或批处理文件。
    --go_out: protoc-gen-go: Plugin failed with status code 1.

此原因是前边go get下来的protoc-gen-go.exe在GOPATH的bin里边，而我们配置的GOPATH与GO的安装bin目录不是同一个目录导致，此时我们可以把GOPATH的bin目录里的protoc-gen-go.exe文件拷贝到GO安装目录的bin文件夹下。

[https_github.com_protocolbuffers_protobuf_releases]: https://links.jianshu.com/go?to=https%3A%2F%2Fgithub.com%2Fprotocolbuffers%2Fprotobuf%2Freleases