首页 > Java > java教程 > 正文

Maven Exec Plugin:在测试源中运行主类并从发布包中排除

聖光之護
发布: 2025-09-29 23:11:01
原创
630人浏览过

Maven Exec Plugin:在测试源中运行主类并从发布包中排除

针对Maven项目中在src/test/java下运行一个主类以生成测试源,同时确保该类不包含在最终发布包中的挑战,本文提供两种解决方案。首先介绍通过创建独立Maven模块实现清晰解耦与正确构建生命周期管理;其次,探讨利用Maven排除机制从发布JAR中过滤特定类的快速方法。

理解核心问题:Maven生命周期与类编译冲突

在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模块(推荐)

最清晰和专业的解决方案是将生成测试源的逻辑封装在一个独立的Maven模块中。这使得代码生成器拥有自己的独立构建生命周期,能够在其主源目录中被正确编译,然后作为依赖被主项目调用。

理念

将SomeMainClass(或其他类似的构建辅助类)从主项目分离出来,创建为一个独立的Maven JAR模块。主项目将这个新模块作为依赖引入,并在适当的构建阶段调用其主类。

人声去除
人声去除

用强大的AI算法将声音从音乐中分离出来

人声去除 23
查看详情 人声去除

优势

  • 职责分离: 清晰区分业务逻辑代码和构建辅助工具代码。
  • 正确生命周期: 生成器模块的SomeMainClass位于src/main/java,可以在主项目调用前被正常编译。
  • 可重用性: 如果其他项目也需要此生成器,可以直接复用。
  • 避免发布冲突: 生成器模块可以独立发布,或者只作为构建依赖存在,不会混入主项目的发布包。

实现步骤

  1. 创建父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>
    登录后复制
  2. 创建生成器模块: 创建一个新的子模块(例如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);
        }
    }
    登录后复制
  3. 主项目模块配置: 主项目(例如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中。

解决方案二:利用Maven排除机制(快速但有限)

如果不想创建多模块项目,或者SomeMainClass仅仅是需要从最终发布包中排除,而不是解决编译时序问题,可以使用Maven的排除机制。

理念

此方法假设SomeMainClass已经能够被编译(例如,它被放置在src/main/java中,或者你已经通过其他非标准方式解决了其在src/test/java中的编译问题)。它的主要目的是确保该类不会最终出现在项目的发布JAR包中。

局限性

  • 不解决编译时序问题: 如果SomeMainClass仍在src/test/java中且需要在test-compile之前运行,此方法无法解决。它只负责在打包阶段进行排除。
  • 可能导致代码混淆: 如果将构建辅助代码与核心业务代码混淆在src/main/java中,会降低项目清晰度。

实现步骤

  1. 确保类可编译: 最简单的方法是将SomeMainClass移至src/main/java。这样它

以上就是Maven Exec Plugin:在测试源中运行主类并从发布包中排除的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
热门推荐
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号