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

优势

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

实现步骤

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



    4.0.0
    com.mypackage
    my-parent
    1.0.0-SNAPSHOT
    pom

    
        my-generator
        my-application

创建生成器模块： 创建一个新的子模块（例如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);
    }
}

主项目模块配置： 主项目（例如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中。