Windows下，ProtoBuf在Eclipse/java中的安装、配置与使用

雨点打透心脏的1/2处 2022-02-27 02:00 657阅读 0赞

# 零：写在前面 #

protobuf是netty中用于解决粘包问题的一种方案。这种方案使用的是netty的基于协议传输的思想。netty的基础与粘包问题的几种解决方法会在后续给出。进入正题。

# 一：下载protobuf #

protobuf有几个渠道可以下载，比如这个[源码版][Link 1]   再比如这个[直接就能用的exe版  ][exe_]都是下了就能用系列

还有maven版本。下面会针对后两种分别解释

# 二：配置与使用 #

### 2.1：以命令行方式生成java文件 ###

我使用的是64位、3.7.0版本。exe文件位置如下图所示

![20190326165807475.png][]

使用cmd工具查看当前protobuf的版本，命令为“protoc --version”或“protoc.exe --version”如下图所示。

![20190326165909783.png][]

如果能看到上图的结果，说明proto可以使用了。

若执行异常，可能是环境变量的问题。配置方式如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhcmtkcmFnb25raW5n_size_16_color_FFFFFF_t_70][]

再给出一个测试的.proto文件样例

//协议版本
    syntax = "proto3";
    //生成的类所处的层级
    option java_package = "com.lw.proto";
    //是否需要將生成的类拆分为多个
    option java_multiple_files = true;
    
    //第一个类名称为FileBean，乃是实体bean。
    message FileBean {
        bytes file = 1;
        string fileName = 2;
        int32 opt = 6;
        bytes fileLength = 15;
    }
    
    //第二个类的名称为FileDeal，我将它用作操作FileBean类。但是在这里不需要对两个类做关联性操作。属性包含如下所示
    message FileDeal {
        bytes dealType = 1;
    
        string dealResult = 5;
        FileBean bean = 9;
    }

以命令行方式，通过.proto生成java文件。命令格式如下

![20190326182908678.png][]

其中“目标地址”指的是输出文件的位置。

比如，我的目标位置为 E:\\protoDir\\childPath，那么生成后的文件的全路径为E:\\protoDir\\childPath\\com\\lw\\proto

其中，com\\lw\\proto是.proto文件中java\_package属性定义的。

生成的结果见下图

![20190326185148191.png][]

### 2.2：在java类生成java文件 ###

在java工程中导入maven配置。下载对应的protobuf的jar包。

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

导入成功后，可以创建一个测试类进行测试，代码如下

package com.test;
    
    import java.io.IOException;
    
    public class ProtoBufGenerateTest {
    
    	public static void main(String[] args) throws IOException {
    		// TODO Auto-generated method stub
    		String strCmd = "E:\\protoc-3.7.0-win64\\bin\\protoc.exe " +
    	//			" -I=E:\\protoDir\\ --java_out=E:\\protoDir\\childPath\\  E:\\protoDir\\protoPath\\demo.proto";
    			"-I=./src/main/java --java_out=./src/main/java/ ./src/main/java/com/proto/demo.proto";
     
            Runtime.getRuntime().exec(strCmd);
    	}
    
    }

上面的例子中，对于路径我有两种写法。上面一种被注释掉的是绝对路径写法。下一种是工程中的相对路径写法。

注：导入proto的jar包的作用，不是用来编译.proto文件生成java类，而是用来识别编译出的java文件的。

所以编译生成的工作还是需要protoc.exe实现的。

# 三：感想与问题 #

3.1：貌似在windows 10环境下，32位版本的protoc.exe与64的沒有什麼区别。都能使用

3.2：我当前使用的是3.7.0版本，但是用它生成的java类会有报错。原因在于好多方法中都带着不必要的@Override注解。

解决方法只要删掉这些注解即可。或者换成低版本的3.5.1就完全没有问题。

我对比了两个版本的，文件内容中没有较大的出入，区别就是在于3.7.0的那些无效注解。

最后附上代码

[https://github.com/darkbearking/ProtoJavaSimple.git][https_github.com_darkbearking_ProtoJavaSimple.git]

[Link 1]: https://github.com/protocolbuffers/protobuf/releases
[exe_]: https://github.com/protocolbuffers/protobuf/releases/download/v3.7.0/protoc-3.7.0-win64.zip
[20190326165807475.png]: /images/20220227/1dc4c397887e41fe894f9f633b68d7b3.png
[20190326165909783.png]: /images/20220227/deb21aebfedc40ce89096bbf3608df6b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhcmtkcmFnb25raW5n_size_16_color_FFFFFF_t_70]: /images/20220227/985880ec5c5747978ba4c80a213feafd.png
[20190326182908678.png]: /images/20220227/190ede371f4a440e807805285e788dd8.png
[20190326185148191.png]: /images/20220227/c3086874445948fa87517722fb7d535a.png
[https_github.com_darkbearking_ProtoJavaSimple.git]: https://github.com/darkbearking/ProtoJavaSimple.git