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配置示例展示了这种尝试:


    org.codehaus.mojo
    exec-maven-plugin
    3.1.0
    
      
        myexec
        generate-test-sources
        
          exec
        
        
          java
          test
          
            -classpath
            
            com.mypackage.SomeMainClass
          
        
      
    

此外,用户还有一个明确的需求:SomeMainClass作为一个测试源生成器,不应包含在最终的发布JAR包中。

为了解决这些问题,我们提供以下两种方案。

解决方案一:解耦为独立Maven模块(推荐)

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

理念

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

Batch GPT
Batch GPT

使用AI批量处理数据、自动执行任务

下载

优势

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

实现步骤

  1. 创建父POM (如果尚未是多模块项目): 如果你的项目还不是多模块结构,首先需要创建一个父pom.xml来管理所有子模块。

    
    
        4.0.0
        com.mypackage
        my-parent
        1.0.0-SNAPSHOT
        pom
    
        
            my-generator
            my-application
        
        
    
  2. 创建生成器模块: 创建一个新的子模块(例如my-generator),将SomeMainClass放置在其src/main/java目录中。这个模块将构建成一个普通的JAR包。

    
    
        4.0.0
        
            com.mypackage
            my-parent
            1.0.0-SNAPSHOT
        
        my-generator
        jar
    
        
            
                
                    org.apache.maven.plugins
                    maven-compiler-plugin
                    3.8.1
                    
                        1.8
                        1.8
                    
                
            
        
        
    

    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调用其主类。

    
    
        4.0.0
        
            com.mypackage
            my-parent
            1.0.0-SNAPSHOT
        
        my-application
        jar
    
        
            
                com.mypackage
                my-generator
                ${project.parent.version}
                test 
            
            
            
                org.junit.jupiter
                junit-jupiter-api
                5.10.0
                test
            
            
                org.junit.jupiter
                junit-jupiter-engine
                5.10.0
                test
            
        
    
        
            
                
                    org.codehaus.mojo
                    exec-maven-plugin
                    3.1.0
                    
                        
                            generate-test-sources
                            generate-test-sources
                            
                                java 
                            
                            
                                com.mypackage.SomeMainClass
                                test 
                                
                                    ${project.build.directory}/generated-test-sources
                                
                            
                        
                    
                    
                        
                        
                            com.mypackage
                            my-generator
                            ${project.parent.version}
                        
                    
                
                
                    org.apache.maven.plugins
                    maven-compiler-plugin
                    3.8.1
                    
                        1.8
                        1.8
                    
                
                
                
                    org.codehaus.mojo
                    build-helper-maven-plugin
                    3.2.0
                    
                        
                            add-test-source
                            generate-test-sources
                            
                                add-test-source
                            
                            
                                
                                    ${project.build.directory}/generated-test-sources
                                
                            
                        
                    
                
                
                    org.apache.maven.plugins
                    maven-surefire-plugin
                    3.0.0-M5
                    
                        
                    
                
            
        
    

通过这种方式,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。这样它

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

825

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

724

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

728

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

395

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

445

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

428

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16861

2023.08.03

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

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

共23课时 | 2.1万人学习

C# 教程
C# 教程

共94课时 | 5.7万人学习

Java 教程
Java 教程

共578课时 | 39.9万人学习

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

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