
在maven项目中,将一个需要在generate-test-sources阶段运行的“主类”放置于src/test/java目录中,并期望它能成功执行,会遇到一个核心的maven生命周期冲突。
Maven的构建生命周期定义了各个阶段的顺序。generate-test-sources阶段用于生成额外的测试源代码,而src/test/java中的类会在更晚的test-compile阶段才被编译。这意味着,当exec-maven-plugin尝试在generate-test-sources阶段执行src/test/java中的com.mypackage.SomeMainClass时,该类尚未被编译成可执行的字节码,从而导致执行失败。
用户最初的pom.xml配置示例展示了这种尝试:
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<id>myexec</id>
<phase>generate-test-sources</phase>
<goals>
<goal>exec</goal>
</goals>
<configuration>
<executable>java</executable>
<classpathScope>test</classpathScope>
<arguments>
<argument>-classpath</argument>
<classpath/>
<argument>com.mypackage.SomeMainClass</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>此外,用户还有一个明确的需求:SomeMainClass作为一个测试源生成器,不应包含在最终的发布JAR包中。
为了解决这些问题,我们提供以下两种方案。
最清晰和专业的解决方案是将生成测试源的逻辑封装在一个独立的Maven模块中。这使得代码生成器拥有自己的独立构建生命周期,能够在其主源目录中被正确编译,然后作为依赖被主项目调用。
将SomeMainClass(或其他类似的构建辅助类)从主项目分离出来,创建为一个独立的Maven JAR模块。主项目将这个新模块作为依赖引入,并在适当的构建阶段调用其主类。
创建父POM (如果尚未是多模块项目): 如果你的项目还不是多模块结构,首先需要创建一个父pom.xml来管理所有子模块。
<!-- parent/pom.xml -->
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.mypackage</groupId>
<artifactId>my-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>my-generator</module>
<module>my-application</module>
</modules>
<!-- ... 其他配置 ... -->
</project>创建生成器模块: 创建一个新的子模块(例如my-generator),将SomeMainClass放置在其src/main/java目录中。这个模块将构建成一个普通的JAR包。
<!-- my-generator/pom.xml -->
<project>
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.mypackage</groupId>
<artifactId>my-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>my-generator</artifactId>
<packaging>jar</packaging>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
</plugins>
</build>
<!-- ... 其他依赖 ... -->
</project>my-generator/src/main/java/com/mypackage/SomeMainClass.java:
package com.mypackage;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
public class SomeMainClass {
public static void main(String[] args) throws IOException {
System.out.println("Running SomeMainClass to generate test sources...");
// 假设 args[0] 是输出目录
String outputDir = (args.length > 0) ? args[0] : "target/generated-test-sources";
java.nio.file.Files.createDirectories(java.nio.file.Paths.get(outputDir + "/com/mypackage"));
try (PrintWriter writer = new PrintWriter(new FileWriter(outputDir + "/com/mypackage/GeneratedTestCase.java"))) {
writer.println("package com.mypackage;");
writer.println("import org.junit.jupiter.api.Test;");
writer.println("import static org.junit.jupiter.api.Assertions.assertTrue;");
writer.println("public class GeneratedTestCase {");
writer.println(" @Test");
writer.println(" void generatedTest() {");
writer.println(" assertTrue(true, \"This is a generated test.\");");
writer.println(" }");
writer.println("}");
}
System.out.println("Generated GeneratedTestCase.java in " + outputDir);
}
}主项目模块配置: 主项目(例如my-application)将my-generator作为依赖引入,并在generate-test-sources阶段通过exec-maven-plugin调用其主类。
<!-- my-application/pom.xml -->
<project>
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.mypackage</groupId>
<artifactId>my-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>my-application</artifactId>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>com.mypackage</groupId>
<artifactId>my-generator</artifactId>
<version>${project.parent.version}</version>
<scope>test</scope> <!-- 作为测试依赖引入,不会进入最终发布包 -->
</dependency>
<!-- JUnit 依赖用于编译生成的测试类 -->
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>5.10.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>5.10.0</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<id>generate-test-sources</id>
<phase>generate-test-sources</phase>
<goals>
<goal>java</goal> <!-- 使用 'java' 目标直接运行类 -->
</goals>
<configuration>
<mainClass>com.mypackage.SomeMainClass</mainClass>
<classpathScope>test</classpathScope> <!-- 确保生成器模块在测试类路径中 -->
<arguments>
<argument>${project.build.directory}/generated-test-sources</argument>
</arguments>
</configuration>
</execution>
</executions>
<dependencies>
<!-- 确保exec插件能找到生成器模块 -->
<dependency>
<groupId>com.mypackage</groupId>
<artifactId>my-generator</artifactId>
<version>${project.parent.version}</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<!-- 将生成的文件添加到测试源目录 -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.2.0</version>
<executions>
<execution>
<id>add-test-source</id>
<phase>generate-test-sources</phase>
<goals>
<goal>add-test-source</goal>
</goals>
<configuration>
<sources>
<source>${project.build.directory}/generated-test-sources</source>
</sources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.0.0-M5</version>
<configuration>
<!-- Surefire 插件配置,确保能找到生成的测试类 -->
</configuration>
</plugin>
</plugins>
</build>
</project>通过这种方式,my-generator模块会在my-application模块之前被构建,其SomeMainClass会被编译。随后,my-application在generate-test-sources阶段执行SomeMainClass,生成测试源。由于my-generator被标记为test范围依赖,它不会包含在最终的发布JAR中。
如果不想创建多模块项目,或者SomeMainClass仅仅是需要从最终发布包中排除,而不是解决编译时序问题,可以使用Maven的排除机制。
此方法假设SomeMainClass已经能够被编译(例如,它被放置在src/main/java中,或者你已经通过其他非标准方式解决了其在src/test/java中的编译问题)。它的主要目的是确保该类不会最终出现在项目的发布JAR包中。
以上就是Maven Exec Plugin:在测试源中运行主类并从发布包中排除的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号