Maven构建中如何为客户端库测试启动独立类路径的API？

我有一个客户端库的Maven项目，希望在Maven构建过程中通过JUnit测试将该库与真实API对接测试，同时要在构建流程中启动这个API。由于应用使用Spring Framework的组件扫描机制，若API存在于JUnit测试的类路径中，可能会引入额外依赖和配置，导致测试结果失真，因此我不希望API出现在JUnit测试的类路径中。

请问是否存在一种方式，能让Maven以独立的依赖/类路径启动API，使用当前模块/项目的测试类路径运行JUnit测试，测试完成后再停止API？

我考虑过的第一种方案 #

最初我想直接从JUnit测试中启动API，但这样就必须将API代码及其所有依赖纳入测试类路径，这可能会引入库使用者未必会用到的依赖和配置，从而影响测试结果。

我考虑过的第二种方案 #

我尝试使用spring-boot-maven-plugin在集成测试的pre-integration-test和post-integration-test阶段启动/停止API，将API设为test作用域依赖，并通过maven-failsafe-plugin排除相关依赖来运行测试方法。但这种方式过于复杂，且我遇到了问题：即使配置了使用测试类路径，启动/停止执行也无法找到指定的API主类。以下是我目前的配置，当前项目和clienttarget依赖均为另一个项目的子模块：

<dependencies>
    <dependency>
        <groupId>com.example.test</groupId>
        <artifactId>clienttarget</artifactId>
        <version>3.0.LOCAL.RELEASE</version>
        <scope>test</scope>
    </dependency>
</dependencies>
<plugins>
    <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <configuration>
            <mainClass>com.example.testapi.ClientTargetApiApplication</mainClass>
            <useTestClasspath>true</useTestClasspath>
        </configuration>
        <executions>
            <execution>
                <id>pre-integration-test</id>
                <goals>
                    <goal>start</goal>
                </goals>
            </execution>
            <execution>
                <id>post-integration-test</id>
                <goals>
                    <goal>stop</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>3.1.2</version>
        <configuration>
            <classpathDependencyExcludes>
                <classpathDependencyExclude>com.example.test:clienttarget</classpathDependencyExclude>
            </classpathDependencyExcludes>
            <excludedGroups>com.example.test.IntegrationTest</excludedGroups>
        </configuration>
    </plugin>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-failsafe-plugin</artifactId>
        <version>3.1.2</version>
        <configuration>
            <classpathDependencyExcludes>com.example.test:clienttarget</classpathDependencyExcludes>
            <groups>com.example.test.IntegrationTest</groups>
        </configuration>
    </plugin>
</plugins>

更新 #

我找到一个类似问题，但它未关注类路径隔离，仅关注同时运行独立进程：Maven下多个Spring Boot应用的端到端集成测试

解决方案：实现API与测试的类路径完全隔离 #

要实现API独立启动且不污染JUnit测试类路径，可以按以下步骤调整配置：

1. 调整API依赖的作用域与插件配置

不要将API依赖放在当前项目的test作用域中，而是通过spring-boot-maven-plugin直接引用API模块的构建产物，避免API进入测试类路径。

修改spring-boot-maven-plugin配置，移除useTestClasspath，改为指定API模块的Jar包路径（多模块项目可通过maven-dependency-plugin提前复制Jar包到指定目录）：

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
        <mainClass>com.example.testapi.ClientTargetApiApplication</mainClass>
        <arguments>
            <argument>--server.port=8080</argument>
        </arguments>
    </configuration>
    <executions>
        <execution>
            <id>pre-integration-test</id>
            <phase>pre-integration-test</phase>
            <goals>
                <goal>run</goal>
            </goals>
            <configuration>
                <fork>true</fork>
                <workingDirectory>${project.build.directory}/api-run</workingDirectory>
                <!-- 多模块下直接引用API模块的打包产物 -->
                <classpath>${project.parent.basedir}/clienttarget/target/clienttarget-3.0.LOCAL.RELEASE.jar</classpath>
            </configuration>
        </execution>
        <execution>
            <id>post-integration-test</id>
            <phase>post-integration-test</phase>
            <goals>
                <goal>stop</goal>
            </goals>
        </execution>
    </executions>
</plugin>

2. 确保Failsafe插件完全隔离API依赖

移除当前项目中clienttarget的test依赖，这样测试类路径中就不会包含API相关代码和依赖。同时简化maven-failsafe-plugin配置，无需再排除依赖：

<dependencies>
    <!-- 移除clienttarget的test依赖 -->
</dependencies>

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-failsafe-plugin</artifactId>
    <version>3.1.2</version>
    <configuration>
        <groups>com.example.test.IntegrationTest</groups>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>integration-test</goal>
                <goal>verify</goal>
            </goals>
        </execution>
    </executions>
</plugin>

3. 多模块项目的补充配置

如果是多模块项目，需要确保API模块在当前项目构建前完成打包。可以在父POM中配置模块顺序，或者在当前项目的pre-integration-test阶段先执行API模块的package目标：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-invoker-plugin</artifactId>
    <version>3.5.0</version>
    <executions>
        <execution>
            <id>package-api</id>
            <phase>pre-integration-test</phase>
            <goals>
                <goal>run</goal>
            </goals>
            <configuration>
                <pom>${project.parent.basedir}/clienttarget/pom.xml</pom>
                <goals>
                    <goal>package</goal>
                </goals>
            </configuration>
        </execution>
    </executions>
</plugin>

4. 验证类路径隔离

执行mvn dependency:build-classpath -Dmdep.outputFile=test-classpath.txt -Dscope=test，查看生成的test-classpath.txt中是否包含clienttarget相关Jar包，确认测试类路径已完全隔离API依赖。

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