如何将Proto生成的GRPC Java代码打包为可分发的Maven构件？

1. 搭建独立Maven项目结构 #

• 新建空Maven项目，将所有proto文件统一放在src/main/proto目录下（自定义路径可后续在插件中配置）
• 无需手动编写Java代码，所有代码由插件自动生成并编译

2. 配置pom.xml核心内容 #

基础依赖与插件配置 #

<dependencies>
    <!-- 引入Protobuf Java依赖，版本需与protoc版本一致 -->
    <dependency>
        <groupId>com.google.protobuf</groupId>
        <artifactId>protobuf-java</artifactId>
        <version>3.24.4</version>
    </dependency>
</dependencies>

<build>
    <plugins>
        <!-- 配置Protobuf插件，生成Java代码 -->
        <plugin>
            <groupId>org.xolstice.maven.plugins</groupId>
            <artifactId>protobuf-maven-plugin</artifactId>
            <version>0.6.1</version>
            <configuration>
                <!-- 指定protoc版本，与依赖版本匹配 -->
                <protocArtifact>com.google.protobuf:protoc:3.24.4:exe:${os.detected.classifier}</protocArtifact>
                <!-- 生成的Java代码输出目录 -->
                <outputDirectory>${project.build.directory}/generated-sources/protobuf/java</outputDirectory>
                <clearOutputDirectory>true</clearOutputDirectory>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

        <!-- 将生成的代码目录加入Maven源码路径，确保能被编译 -->
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>build-helper-maven-plugin</artifactId>
            <version>3.4.0</version>
            <executions>
                <execution>
                    <id>add-source</id>
                    <phase>generate-sources</phase>
                    <goals>
                        <goal>add-source</goal>
                    </goals>
                    <configuration>
                        <sources>
                            <source>${project.build.directory}/generated-sources/protobuf/java</source>
                        </sources>
                    </configuration>
                </execution>
            </executions>
        </plugin>

        <!-- 配置Java编译插件，确保版本兼容 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.11.0</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

配置内部仓库发布地址 #

在pom.xml中添加distributionManagement节点，指定内部仓库的快照版和正式版地址（建议将认证信息放在Maven的settings.xml中，避免硬编码）：

<distributionManagement>
    <repository>
        <id>internal-release-repo</id>
        <url>http://your-internal-repo/release</url>
    </repository>
    <snapshotRepository>
        <id>internal-snapshot-repo</id>
        <url>http://your-internal-repo/snapshot</url>
    </snapshotRepository>
</distributionManagement>

Maven Settings.xml认证配置 #

在本地settings.xml中添加仓库账号密码：

<servers>
    <server>
        <id>internal-release-repo</id>
        <username>your-username</username>
        <password>your-password</password>
    </server>
    <server>
        <id>internal-snapshot-repo</id>
        <username>your-username</username>
        <password>your-password</password>
    </server>
</servers>

3. 执行打包与发布 #

• 本地验证：执行mvn clean install，检查target目录下生成的jar包是否包含编译后的Java代码
• 发布到内部仓库：执行mvn clean deploy，完成后即可在内部仓库中找到该Maven制品

注意事项 #

• 确保proto文件的跨文件引用路径正确，避免生成代码时出现依赖错误
• 如果需要生成GRPC代码，需在protobuf-maven-plugin中添加grpc相关配置和依赖
• 版本管理：开发阶段使用*-SNAPSHOT版本，正式发布时切换为稳定版本

内容的提问来源于stack exchange，提问作者alex