如何在多模块项目的生成源阶段共享过滤的资源？

Question

我有一个包含 3 个子项目的父项目：

parent
   project-1
       /src/main/resources/config.xml
   project-2
       /src/main/resources/config.xml
   project-3
       /src/main/resources/config.xml

config.xml 配置在generate-sources 阶段使用。对于三个项目，config.xml 完全相同。不过这个config.xml的用法对于每个项目是不同的。

在project-X中，我指的是config.xml如下：

<build>
    <plugins>
        <plugin>
            <groupId>some-group</groupId>
            <artifactId>some-artifact</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>some-goal</goal>
                    </goals>
                    <configuration>
                        <input>src/main/resources/config.xml</input>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

在所有 3 个项目之间共享这个共同的 config.xml 的最佳方式是什么？

Answer 1

您可以在此处使用build-helper-maven-plugin。

项目结构

shared-resources-project
  +-src
     +-main
        +-resources
           `config.xml
  +-project-A
     `pom.xml
  +-project-B
     `pom.xml
  +-project-C
     `pom.xml
  `pom.xml

---

shared-resources-project/pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>my</groupId>
    <artifactId>shared-resources-project</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <packaging>pom</packaging>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <modules>
        <module>project-A</module>
        <module>project-B</module>
        <module>project-C</module>
    </modules>

    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>build-helper-maven-plugin</artifactId>
                <version>1.10</version>
                <executions>
                    <execution>
                        <id>add-resource</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>add-resource</goal>
                        </goals>
                        <configuration>
                            <resources>
                                <resource>
                                    <filtering>true</filtering>
                                    <directory>${project.parent.basedir}/src/main/resources</directory>
                                    <includes>
                                        <include>config.xml</include>
                                    </includes>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

            <plugin>
                <groupId>some-group</groupId>
                <artifactId>some-artifact</artifactId>
                <executions>
                    <execution>
                        <id>some-plugin-job</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>some-goal</goal>
                        </goals>
                        <configuration>
                            <input>${project.build.outputDirectory}/config.xml</input>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

shared-resources-project/src/main/resources/config.xml

<config>
    <parameter>${custom-value}</parameter>
</config>

project-X/pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>my</groupId>
        <artifactId>shared-resources-project</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>project-X</artifactId>

    <properties>
        <custom-value>Project-X Value</custom-value>
    </properties>
</project>

现在，让我们构建项目：

D:\workspaces> cd shared-resources-project
D:\workspaces\java\shared-resources-project> mvn clean install

一些注意事项：

• build-helper-maven-plugin 会将公共 config.xml 文件作为资源添加到 Project-X。
• 然后Maven资源插件（MRP）会将config.xml复制到项目输出目录（默认target目录）。在复制过程中，MRP 还会将${custom-value} 替换为 Project-X 提供的具体值。
• 只要另一个插件绑定到generate-source 阶段并且它的声明出现在build-helper-maven-plugin 声明之后，最终的config.xml 将可用于另一个插件。 Maven（至少 3.0.4+）按照它们在 pom.xml 中出现的顺序调用插件。