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

最新推荐文章于 2021-02-25 02:48:13 发布

原创最新推荐文章于 2021-02-25 02:48:13 发布 · 2.4k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#netty #ProtoBuf

netty 同时被 2 个专栏收录

2 篇文章

订阅专栏

ProtoBuf

1 篇文章

订阅专栏

本文介绍如何使用Protobuf解决Netty中的粘包问题，并提供详细的下载、配置及使用指南，包括生成Java文件的方法。

零：写在前面

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

一：下载protobuf

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

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

二：配置与使用

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

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

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

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

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

再给出一个测试的.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文件。命令格式如下

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

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

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

生成的结果见下图

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实现的。