0

0

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

聖光之護

聖光之護

发布时间:2025-09-29 23:11:01

|

643人浏览过

|

来源于php中文网

原创

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模块。主项目将这个新模块作为依赖引入,并在适当的构建阶段调用其主类。

Otter.ai
Otter.ai

一个自动的会议记录和笔记工具,会议内容生成和实时转录

下载

优势

  • 职责分离: 清晰区分业务逻辑代码和构建辅助工具代码。
  • 正确生命周期: 生成器模块的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。这样它

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

0

2025.09.15

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1949

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2119

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1171

2024.11.28

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

25

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

44

2026.03.12

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

177

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

50

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

92

2026.03.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.3万人学习

Java 教程
Java 教程

共578课时 | 82万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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