Google PB协议学习记录--一个简单的例子--如何编译.proto文件为.java文件

以你之姓@ 2022-07-15 00:44 104阅读 0赞

步骤一, 书写 .proto 文件，这里直接上google官方实例，并存储为addressbook.proto

package tutorial;
    
    option java_package = "com.example.tutorial";
    option java_outer_classname = "AddressBookProtos";
    
    message Person {
      required string name = 1;
      required int32 id = 2;
      optional string email = 3;
    
      enum PhoneType {
        MOBILE = 0;
        HOME = 1;
        WORK = 2;
      }
    
      message PhoneNumber {
        required string number = 1;
        optional PhoneType type = 2 [default = HOME];
      }
    
      repeated PhoneNumber phone = 4;
    }
    
    message AddressBook {
      repeated Person person = 1;
    }

步骤2、下载.proto文件编译器

到protobuf发布版本的地方[https://github.com/google/protobuf/releases][https_github.com_google_protobuf_releases]下载 protoc-3.1.0-win32.zip并解压

![20161027111946076][]

通过命令行将.proto的文件生成为.java的文件

官网上是这样写的

protoc -I=$SRC\_DIR --java\_out=$DST\_DIR $SRC\_DIR/addressbook.proto

下面直接来看具体操作

1、由于protoc.exe在bin文件夹下，所以先进入该目录

2、执行 protoc.exe --java\_out=./ addressbook.proto 命令

3、在当前目录下就会生成目标文件

![20161027112618237][]

![20161027113024565][]

下面来解释下命令行的意思

#### protoc --proto\_path=IMPORT\_PATH  \--cpp\_out=DST\_DIR  file.proto ####

#### \--java\_out=DST\_DIR ####

#### \--python\_out=DST\_DIR  ####

1.引用文件夹（使用--proto\_path 或者 -I），如果proto文件中需要引用其他文件，在这指定(需要绝对路径，也就是需要完整的路径)

#### IMPORT\_PATH引用的路径：当pb文件里面有import关键字时，会在引用路径里面寻找依赖的文件。如果没有给出，会再当前路径下进行寻找。也可以缩写成 -I ####

2.文件输出文件夹 (--cpp\_out 或者 --java\_out 或者 --python\_out) 根据需要选择需要生成的格式，并且指定文件夹

3.需要编译的pb文件

[https_github.com_google_protobuf_releases]: https://github.com/google/protobuf/releases
[20161027111946076]: /images/20220715/64ccca9908954dc688bfc81cbb7e3eb9.png
[20161027112618237]: /images/20220715/2e5b53873b9c4bf9ae1e9d2d5cd5232c.png
[20161027113024565]: /images/20220715/a5e6d9e5924845d2a8704ea0c1edfe98.png