如何在项目构建阶段免版本控制生成并编译Java客户端？

可以通过在构建阶段自动生成客户端并将其安装到本地Maven仓库的方式解决你的问题，既保证客户端使用自身依赖编译（避免序列化冲突），又无需将生成代码提交到Git。具体实现步骤如下：

核心思路 #

1. 用openapi-generator-maven-plugin将客户端源码生成到target下的临时目录（不会被Git追踪），并指定客户端的Maven坐标。
2. 借助maven-invoker-plugin调用生成客户端的mvn install命令，将其打包为jar并安装到本地Maven仓库。
3. 主项目直接依赖这个预构建好的客户端构件，构建时自动拉取本地仓库中的jar包。

具体配置 #

1. 主项目pom.xml插件配置 #

<build>
    <plugins>
        <!-- 生成OpenAPI客户端到target临时目录 -->
        <plugin>
            <groupId>org.openapitools</groupId>
            <artifactId>openapi-generator-maven-plugin</artifactId>
            <version>6.6.0</version>
            <executions>
                <execution>
                    <id>generate-openapi-client</id>
                    <phase>generate-sources</phase>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                    <configuration>
                        <inputSpec>${project.basedir}/src/main/resources/openapi-spec.yaml</inputSpec>
                        <generatorName>java</generatorName>
                        <output>${project.build.directory}/generated-client</output>
                        <!-- 指定生成客户端的Maven坐标，主项目后续依赖此坐标 -->
                        <groupId>com.yourcompany</groupId>
                        <artifactId>openapi-generated-client</artifactId>
                        <version>${project.version}</version>
                        <!-- 根据需求选择客户端库，比如spring-boot/feign等 -->
                        <library>spring-boot</library>
                        <configOptions>
                            <dateLibrary>java8</dateLibrary>
                            <serializationLibrary>jackson</serializationLibrary>
                        </configOptions>
                    </configuration>
                </execution>
            </executions>
        </plugin>

        <!-- 调用客户端的Maven构建，安装到本地仓库 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-invoker-plugin</artifactId>
            <version>3.5.0</version>
            <executions>
                <execution>
                    <id>install-generated-client</id>
                    <phase>process-sources</phase>
                    <goals>
                        <goal>run</goal>
                    </goals>
                    <configuration>
                        <pomFile>${project.build.directory}/generated-client/pom.xml</pomFile>
                        <goals>
                            <goal>clean</goal>
                            <goal>install</goal>
                        </goals>
                        <!-- 可选：跳过客户端测试，加快构建速度 -->
                        <properties>
                            <skipTests>true</skipTests>
                        </properties>
                        <failOnError>true</failOnError>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

<!-- 主项目依赖生成的客户端构件 -->
<dependencies>
    <dependency>
        <groupId>com.yourcompany</groupId>
        <artifactId>openapi-generated-client</artifactId>
        <version>${project.version}</version>
    </dependency>
</dependencies>

2. 配置.gitignore #

将生成的临时目录加入忽略列表，确保不会提交到Git：

# OpenAPI生成的客户端临时目录
target/generated-client/

方案优势 #

• 依赖完全隔离：客户端使用自身生成的pom.xml构建，依赖独立于主项目，彻底解决序列化等依赖冲突问题。
• 无Git追踪负担：所有生成文件都在target目录下，不会进入版本控制。
• 自动化构建：执行mvn clean install时，会自动完成客户端生成、构建、安装全流程，主项目直接使用成品jar包。

注意事项 #

• 确保openapi-generator-maven-plugin版本与你选择的客户端库（如spring-boot）版本兼容。
• CI环境中无需额外配置，每次构建都会重新生成并安装客户端，不受本地仓库状态影响。
• 可以通过${project.version}将客户端版本与主项目版本绑定，便于版本同步管理。

内容的提问来源于stack exchange，提问作者Baksa Zoltán