Maven自动编译Protocol Buffers

最新推荐文章于 2025-07-12 16:56:32 发布

EatAnApple

最新推荐文章于 2025-07-12 16:56:32 发布

阅读量6.1k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： maven实战文章标签： maven protocol-buffer

本文链接：https://blog.youkuaiyun.com/EatAnApple/article/details/78891717

本文详细介绍了如何在maven项目中解决多平台protoc编译问题、按需编译.proto文件、处理跨模块引用，并提供了一种将protoc下载到本地、编译.proto文件的解决方案，以及如何将生成的java文件加入到source并解决protobuf-API版本冲突。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

本文主要解决maven自动编译.proto文件的问题

难题

多平台protoc：团队中有人使用mac 有人使用windows开发，编译使用的protoc是二进制程序，根据不同操作系统有不同的版本。
按需编译：有一些模块(module)包含有proto目录，需要编译其中的.proto文件。另一些模块不包含proto目录，不需要编译。
跨模块引用：有一些模块需要引用到其他模块的proto目录。

下载protoc到本地

定义全局属性：保持版本和路径一致

<protobuf.input.directory>${project.basedir}/src/main/proto</protobuf.input.directory>
<protobuf.output.directory>src/main/gen-java</protobuf.output.directory>
<protobuf.protoc.path>${settings.localRepository}/protoc</protobuf.protoc.path>
<protobuf.version>3.2.0</protobuf.version>

引用protobuf-API：编译成的.java文件需要依赖这些库文件

<dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java</artifactId>
    <version>${protobuf.version}</version>
</dependency>

识别系统类型：区分Windows/Linux/OS X 不同系统，区分32/64-bit，识别结果会写入到变量里面

<build>
    <extensions>
        <!-- provides os.detected.classifier (i.e. linux-x86_64, osx-x86_64) property -->
        <extension>
            <groupId>kr.motd.maven</groupId>
            <artifactId>os-maven-plugin</artifactId>
            <version>1.4.1.Final</version>
        </extension>
    </extensions>
</build>

自动下载protoc到本地目录

<!-- copy protoc binary into build directory -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <version>2.10</version>
    <executions>
        <execution>
            <id>copy-protoc</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>copy</goal>
            </goals<