查找多模块 Maven Reactor 项目的根目录

Question

有没有一种简单的方法可以找到多模块 Maven 项目的根目录，例如 Gradle 的 rootDir？

---

背景：

我想使用 maven-dependency-plugin 将多模块项目的所有子模块中的工件复制到相对于整个项目的根目录的目录。

也就是说，我的布局看起来与此类似，名称已更改：

to-deploy/
my-project/
    module-a/
    module-b/
    more-modules-1/
        module-c/
        module-d/
    more-modules-2/
        module-e/
        module-f/
    ...

并且我希望将所有工件从各自模块的目标目录复制到 my-project/../to-deploy 所以我最终

to-deploy/
    module-a.jar
    module-b.jar
    module-c.jar
    module-d.jar
    module-e.jar
    module-f.jar
my-project/
    ...

可以在每个模块中使用相对路径来完成此操作，如下所示：

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy</id>
                    <phase>install</phase>
                    <goals>
                        <goal>copy</goal>
                    </goals>
                    <configuration>
                        <artifactItems>
                            <artifactItem>
                                <groupId>${project.groupId}</groupId>
                                <artifactId>${project.artifactId}</artifactId>
                                <version>${project.version}</version>
                                <type>jar</type>
                                <outputDirectory>../../to-deploy</outputDirectory>
                            </artifactItem>
                        </artifactItems>
                    </configuration>
                </execution>
            </executions>
        </plugin>

但我不想在 元素中指定相对路径。 我更喜欢像 ${reactor.root.directory}/../to-deploy 这样的东西，但我找不到这样的东西。

另外，我希望有某种方法可以继承此 maven-dependency-plugin 配置，这样我就不必为每个模块指定它。

我还尝试从根 pom 继承自定义属性：

<properties>
    <myproject.root>${basedir}</myproject.root>
</properties>

但是当我尝试在模块 POM 中使用 ${myproject.root} 时，${basedir} 将解析到模块的 basedir。

另外，我发现 http://labs.consol.de/lang/de/blog/maven/project-root-path-in-a-maven-multi-module-project/ 建议每个开发人员并且大概持续集成服务器应该在profiles.xml文件中配置根目录，但我不认为这是一个解决方案。

那么有没有一种简单的方法来找到多模块项目的根呢？

Answer 1

使用 ${session.executionRootDirectory}

作为记录，${session.executionRootDirectory} 在 Maven 3.0.3 的 pom 文件中为我工作。该属性将是您正在运行的目录，因此运行父项目，每个模块都可以获取该根目录的路径。

我将使用此属性的插件配置放在父 pom 中，以便它被继承。我在配置文件中使用它，仅当我知道要在父项目上运行 Maven 时才选择该配置文件。这样，当我在子项目上运行 Maven 时，我就不太可能以不希望的方式使用此变量（因为这样该变量将不是父项目的路径）。

例如，

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
        <execution>
            <id>copy-artifact</id>
            <phase>package</phase>
            <goals>
                <goal>copy</goal>
            </goals>
            <configuration>
                <artifactItems>
                    <artifactItem>
                        <groupId>${project.groupId}</groupId>
                        <artifactId>${project.artifactId}</artifactId>
                        <version>${project.version}</version>
                        <type>${project.packaging}</type>
                    </artifactItem>
                </artifactItems>
                <outputDirectory>${session.executionRootDirectory}/target/</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

Answer 2

从 Maven 3.3.1 开始，您可以使用 ${maven.multiModuleProjectDirectory} 来实现此目的。
（感谢 https://stackoverflow.com/a/48879554/302789）

编辑：这似乎只有在以下情况下才能正常工作您的项目根目录下有一个 .mvn 文件夹。

Answer 3

我在项目中使用的方法是覆盖子模块 poms 中的属性。

    root:           <myproject.root>${basedir}</myproject.root>
    moduleA:        <myproject.root>${basedir}/..</myproject.root>
    other/moduleX:  <myproject.root>${basedir}/../..</myproject.root>

这样，您仍然拥有相对路径，但您可以在根模块中定义一次插件，并且您的模块将通过正确替换 myproject.root 来继承它。

Answer 4

有一个maven插件可以解决这个特殊问题： directory-maven-plugin

它将分配您的项目到您选择的属性的根路径。请参阅文档中的 highest-basedir 目标。

例如：

<!-- Directory plugin to find parent root directory absolute path -->
<plugin>
  <groupId>org.commonjava.maven.plugins</groupId>
  <artifactId>directory-maven-plugin</artifactId>
  <version>0.1</version>
  <executions>
    <execution>
      <id>directories</id>
      <goals>
        <goal>highest-basedir</goal>
      </goals>
      <phase>initialize</phase>
      <configuration>
        <property>main.basedir</property>
      </configuration>
    </execution>
  </executions>
</plugin>

然后在父/子 pom.xml 中的任何位置使用 ${main.basedir} 。

Answer 5

正如其他人所建议的，directory-maven-plugin 是正确的选择。
但是，我发现它最适合 directory-of 目标，如下所述：https://stackoverflow .com/a/37965143/6498617。

我更喜欢这样，因为使用 highest-basedir 不适用于具有嵌套多模块 pom 的多模块项目。 directory-of 目标允许您将属性设置为整个项目中任何模块的路径，当然包括根目录。
它也比 ${session.executionRootDirectory} 好得多，因为无论您构建的是根模块还是子模块，也无论您从哪个 mvn 当前工作目录，它总是有效。

Answer 6

目前，Maven 不提供这样的“根项目目录路径”属性。
“根项目”是指“最顶层”父项目。

请参阅票证并考虑投票：[MNG-7038] Introduce public property to指向（多模块）项目的根目录 - ASF JIRA。

Answer 7

以下小简介对我有用。我需要这样的 CheckStyle 配置，我将其放入项目根目录的 config 目录中，这样我就可以从主模块和子模块运行它。

<profile>
    <id>root-dir</id>
    <activation>
        <file>
            <exists>${project.basedir}/../../config/checkstyle.xml</exists>
        </file>
    </activation>
    <properties>
        <project.config.path>${project.basedir}/../config</project.config.path>
    </properties>
</profile>

它不适用于嵌套模块，但我确信可以使用具有不同 exists 的多个配置文件对其进行修改。 （我不知道为什么验证标签中应该有“../..”，而重写属性本身只有“..”，但它只能以这种方式工作。）

Answer 8

我遇到了类似的问题，因为我需要在项目之间复制文件。 Maven 所做的事情是合乎逻辑的，因为它将使安装在存储库中的 pom.xml 远离硬编码值。

我的解决方案是将复制的目录放入 Maven 工件中，然后使用 Ant 提取/复制

Answer 9

除了使用绝对根路径之外，在某些情况下，我还有另一种方法来解决问题。

使用maven插件combine.children功能，参考：maven插件

我可以编写我的代码：

parent pom：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-dependency-plugin</artifactId>
      <executions>
          <execution>
              <id>copy-dependencies</id>
              <phase>package</phase>
              <goals>
                  <goal>copy-dependencies</goal>
              </goals>
              <configuration>
                  <includeScope>runtime</includeScope>
                  <outputDirectory combine.children="override">${project.basedir}/to-deploy</outputDirectory>
              </configuration>
          </execution>
      </executions>
    </plugin>
  </plugins>
</build>

或者写在插件管理中，如果parent pom不使用该插件。

子pom：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-dependency-plugin</artifactId>
      <executions>
          <execution>
              <!--same as parent plugin id-->
              <id>copy-dependencies</id>
              <configuration>
                  <outputDirectory combine.children="override">${project.parent.basedir}/to-deploy</outputDirectory>
              </configuration>
          </execution>
      </executions>
    </plugin>
  </plugins>
</build>

类似的方式
孙子 pom：

<outputDirectory combine.children="override">${project.parent.parent.basedir}/to-deploy</outputDirectory>

Answer 10

我不知道找到多模块项目的根的“好”方法。但你也许可以改进一下你当前的方法。

第一种选择是直接在根项目下创建一个附加模块，将所有 EAR 声明为其中的依赖项并使用 dependency:copy-dependencies 将模块的依赖项复制到to-deploy目录（相对）。是的，路径仍然是相对的，但由于依赖插件配置将是集中的，我觉得它并不那么烦人。

第二种选择是使用 Maven Assembly Plugin 而不是 < a href="http://maven.apache.org/plugins/maven-dependency-plugin/" rel="nofollow noreferrer">Maven 依赖插件 使用 dir 格式（这将在目录中创建一个发行版）。这实际上就是我要做的。

Answer 11

另一个解决方案是使用 ant 任务将“rootdir=${basedir}”写入根项目中的 target/root.properties，然后使用 属性插件 来读回该文件。我自己还没有尝试过，但我想它应该可以工作..？

Answer 12

你可以选择这样的东西。请注意，您必须定义两个配置文件 - 一个将为根目录激活，另一个为子目录激活。显然，这假设孩子们将具有相同的结构，但这可以很容易地适应。

    <profiles>
        <profile>
            <id>root-dir</id>
            <activation>
                <file>
                    <exists>${basedir}/lib</exists>
                </file>
            </activation>
            <properties>
                <project.libdir>${basedir}/lib</project.libdir>
            </properties>
        </profile>
        <profile>
            <id>child-dir</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <properties>
                <project.libdir>${basedir}/../../lib</project.libdir>
            </properties>
        </profile>
    </profiles>

Answer 13

这样：在某个父项目的属性中的某个位置，我有稍后需要关联的文件，这就是为什么我在任何地方都需要它的绝对路径。所以，我在groovy的帮助下得到了它：

<properties>    
<source> import java.io.File; 
        String p =project.properties['env-properties-file']; 
        File f = new File(p); 
        if (!f.exists()) 
        { 
           f = new File("../" + p); 
          if (!f.exists()) 
          { 
             f = new File("../../" + p); 
          } 
        } 
        // setting path together with file name in variable xyz_format 
        project.properties['xyz_format'] =f.getAbsolutePath() 
                            + File.separator 
                            + "abc_format.xml"; 
</source>
</properties>   

然后：

  <properties>
     <snapshots>http://localhost:8081/snapshots<snapshots>
     <releases>http://localhost:8081/releases</releases>
     <sonar>jdbc:oracle:thin:sonar/sonar@localhost/XE</sonar>
     <sonar.jdbc.username>sonar</sonar.jdbc.username>
     <format.conf> ${xyz_format}</format.conf>  <---- here is it!
    </properties>

它起作用了！

Answer 14

使用 Maven 4（自 4.0.0-beta7 起实施，请参阅 MNG-7038 ）您可以使用 project.rootDirectory 变量，其中根目录是通过使用 .mvn 目录或使用新的 pom 属性 root=true< 来定义的/code> 是在新的 pom 模型版本 4.1.0 中与 Maven 4 一起引入的。

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

然后使用该变量，例如

${project.rootDirectory}/exclude-pmd.properties

Answer 15

对于 Maven 3.6.1，从子项目中，${parent.basedir} 返回父项目的完全限定目录。

Answer 16

我有 ${project.parent.basedir} 的父 pom 的根目录。