1.1. protobuf 代码生成
在创建好.proto协议**文件之后,就需要按照好了对应版本的 protoc.exe工具。 protoc.exe工具是生成Java文件的工具软件。 安装的方法,前面已经讲了。
这里需要提示一下版本。Java 的maven 配置文件中 proto 包的版本,和 .proto文件的版本, 以及生成java 代码的protoc.exe的版本,三者需要一致。
1.1.1. 使用命令生成
下面开始生成 消息的 Java代码。 需要用到下面的指令:
protoc.exe --java_out=输出的Java文件路径名称 .proto文件路径名称
例如:
protoc.exe --java_out=./src/main/java/ ./proto/ProtoMsg.proto
输入完之后,回车即可在目标目录看到已经生成好的Java文件,然后将该文件放到项目中该文件指定的路径下即可。
本案例的工程中,以及给大家准备好了.bat windows 的命令文件,在 .bat 目录 下执行.bat 文件即可。 .bat 文件如下:
d:
cd D:\crazymakercircleJava\nettydemo\chatcommon
protoc.exe --java_out=./src/main/java/ ./proto/ProtoMsg.proto
使用的时候,注意调整为实际的目录。
1.1.2. 命令生成代码的两个大坑
1.1.2.1. 大坑一:可劲儿提示没有协议版本
使用protoc.exe指令生成java代码时,提示没有设置协议版本。错误如下:
D:\crazymakercircleJava\nettydemo\chatcommon>protoc.exe --java_out=./src/main/java/ ./proto/ProtoMsg.proto
[libprotobuf WARNING T:\src\github\protobuf\src\google\protobuf\compiler\parser.cc:562] No syntax specified for the proto file: proto/ProtoMsg.proto. Please use 'syntax = "proto2";' or 'syntax = "proto3";' to specify a syntax version. (Defaulted to proto2 syntax.)
实际上,协议版本是已经设置好了的。
1.1.2.2. 大坑二: 没有生成Java代码
通过切换到老的protobuf代码生成器版本,比方说2.6.1 ,这时候,会没有错误提示了。
但是,新的问题来了,在代码生成的目标目录下,就是看不到生成Java代码。说明代码还是没有生成成功。
爬出这两个大坑,会浪费大量的时间。
1.1.3. 使用Maven插件生成Java代码
其实,天无绝人之路。
一条更好的路等着你来。这就是maven插件。
使用protobuf-maven-plugin,可以非常方便的生成Java代码。
插件的配置如下:
org.xolstice.maven.plugins
protobuf-maven-plugin
0.5.0
true
${project.basedir}/proto/protoConfig
${project.build.sourceDirectory}
false
${project.build.directory}/protoc-temp
${project.basedir}/proto/protobin/protoc3.6.1.exe
compile
test-compile
插件的配置项中,需要配置的内容如下:
(1)protoSourceRoot : protobuf 协议文件的路径
(2)outputDirectory :java 文件的目标路径
(3)protocExecutable : protobuf 代码生成工具的路径
配置好之后,执行插件的compile命令, Java代码就利索的生成了。