创建一个Maven Mojo，自动向构建中添加新的源文件夹

Question

我为maven编译器插件创建了一个新的编译器。这个编译器喜欢在src/main/groovy和src/main/java中寻找编译源。类似地，测试源位于src/test/groovy和src/test/java中。

我知道build-helper-maven-plugin允许用户扩展他们的pom，为构建指定新的源文件夹，但使用这个插件并不理想，因为它需要在pom中进行20多行额外配置。

我想创建一个mojo，自动配置额外的源文件夹。

这是我创造的魔力，但我不知道如何确保魔力在正确的时间执行。

/**
 * @goal add-groovy-source
 * @phase generate-sources
 * @requiresDependencyResolution compile
 * @execute phase="compile"
 */
public class AddGroovySourceFolders extends AbstractMojo {
    /**
     * @parameter expression="${project}"
     * @required
     * @readonly
     */
    private MavenProject project;
    public void execute() throws MojoExecutionException, MojoFailureException {
        getLog().info("Adding /src/main/groovy to the list of source folders");
        this.project.addCompileSourceRoot(project.getBasedir() + "/src/main/groovy");
    }
}

同样，我的目标是确保用户pom中的最小配置量。我的意思是，应该只有一个对包含这个mojo的插件的依赖声明，而没有进一步的配置。

Answer 1

可以通过定义自定义生命周期来实现。

步骤1：定义MOJO以添加路径。你已经用AddGroovySourceFolders做到了。

步骤2：在src/main/resources:中创建一个META-INF/plexus/components.xml文件

<component-set>
    <components>
        <component>
            <role>org.apache.maven.lifecycle.mapping.LifecycleMapping</role>
            <role-hint>jar</role-hint>
            <implementation>org.apache.maven.lifecycle.mapping.DefaultLifecycleMapping</implementation>
            <configuration>
                <lifecycles>
                    <lifecycle>
                        <id>default</id>
                        <phases>
                            <!-- I added this one, use appropriate plugin groupId/artifactId instead-->
                            <initialize>groovyadd:maven-groovyadd-plugin:add-build-paths</initialize>
                            <process-resources>org.apache.maven.plugins:maven-resources-plugin:2.4.3:resources</process-resources>
                            <compile>org.apache.maven.plugins:maven-compiler-plugin:2.3.2:compile</compile>
                            <process-test-resources>org.apache.maven.plugins:maven-resources-plugin:2.4.3:testResources</process-test-resources>
                            <test-compile>org.apache.maven.plugins:maven-compiler-plugin:2.3.2:testCompile</test-compile>
                            <test>org.apache.maven.plugins:maven-surefire-plugin:2.7.2:test</test>
                            <package>org.apache.maven.plugins:maven-jar-plugin:2.3.1:jar</package>
                            <install>org.apache.maven.plugins:maven-install-plugin:2.3.1:install</install>
                            <deploy>org.apache.maven.plugins:maven-deploy-plugin:2.5:deploy</deploy>
                        </phases>
                    </lifecycle>
                </lifecycles>
            </configuration>
        </component>
    </components>
</component-set>

元素指定生命周期所针对的包装。显然，你可以覆盖jar的生命周期(我在Maven 3.0.3中得到了这个(

覆盖Maven的JAR生命周期的副作用是，您现在已经对编译和其他插件的版本进行了硬编码，即插件中的内容，而不是Maven中的内容。我不确定这是坏事还是好事。

步骤3：当使用来自另一个项目的插件时，您只需要：

<plugins>
    ...
    <plugin>
        <groupId>groovyadd</groupId>
        <artifactId>maven-groovyadd-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
        <extensions>true</extensions>
    </plugin>
    ...
</plugins>

重要的部分是扩展元素。没有它，你的插件的自定义生命周期将不会被接受。

您还可以将其他插件添加到生命周期的其他阶段(例如，在编译阶段，在单独的插件中编译groovy代码，而不是为maven编译器插件添加编译器(。

参考文献：覆盖Maven书籍中的默认生命周期