具有显式 finalName 的 Maven 将无法正常工作

Question

1.背景

我的 maven 项目有很多带有 jars 和 wars 的模块和子模块，并且一切正常。我也可以毫无问题地将它部署在服务器上。

我决定关注this maven naming conversion，我正在使用project.name 和project.build.finalName 进行一些测试，以获得合适的名称。

我为根工件创建project.name 定义的模式是company-${project.artifactId}，而模块和子模块的模式是${project.parent.name}-${project.artifactId}：

• company-any-artifact-any-module1
• company-any-artifact-any-module2-any-submodule1
• company-any-artifact-any-module2-any-submodule2

project.build.finalName 的模式是${project.name}-${project.version}：

• company-any-artifact-any-module1-1.0.jar
• company-any-artifact-any-module2-any-submodule1-2.0.jar
• company-any-artifact-any-module2-any-submodule2-3.0.war

但是 maven 没有生成这些文件，而是给了我一个 StackOverflowError。

2。重现错误的示例

您可以从 github 克隆此示例：https://github.com/pauloleitemoreira/company-any-artifact

在 github 中有 master 分支，它会重现此错误。还有only-modules 分支，这是一个工作示例，它使用${project.parent.name} 生成我想要的jar finalName。

让我们考虑一个具有一个根 pom 工件、一个 pom 模块和一个子模块的 maven 项目。

-any-artifact
     |
     |-any-module      
           |
           |-any-submodule

2.1 任意工件

<?xml version="1.0" encoding="UTF-8"?>
<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>com.company</groupId>
    <artifactId>any-artifact</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>

    <name>company-${project.artifactId}</name>

    <modules>
        <module>any-module</module>
    </modules>

    <!-- if remove finalName, maven will not throw StackOverflow error -->
    <build>
        <finalName>${project.name}-${project.version}</finalName>
    </build>
</project>

2.2 任意模块

<?xml version="1.0" encoding="UTF-8"?>
<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>
        <artifactId>any-artifact</artifactId>
        <groupId>com.company</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>com.company.any-artifact</groupId>
    <artifactId>any-module</artifactId>
    <packaging>pom</packaging>

    <name>${project.parent.name}-${project.artifactId}</name>

    <modules>
        <module>any-submodule</module>
    </modules>
</project>

2.3 任意子模块

<?xml version="1.0" encoding="UTF-8"?>
<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>
        <artifactId>any-module</artifactId>
        <groupId>com.company.any-artifact</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>com.company.any-artifact.any-module</groupId>
    <artifactId>any-submodule</artifactId>

    <name>${project.parent.name}-${project.artifactId}</name>
</project>

3.问题

当尝试mvn clean install 时，maven 给了我一个StackOverflowError：

Exception in thread "main" java.lang.StackOverflowError
    at org.codehaus.plexus.util.StringUtils.isEmpty(StringUtils.java:177)
    at org.codehaus.plexus.util.introspection.ReflectionValueExtractor.evaluate(ReflectionValueExtractor.java:194)
    at org.codehaus.plexus.util.introspection.ReflectionValueExtractor.evaluate(ReflectionValueExtractor.java:163)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:266)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:143)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:174)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:143)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:429)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:143)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:174)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:143)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:429)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:143)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:174)
    at org.apache.maven.plugin.PluginParameterExpressionEvaluator.evaluate(PluginParameterExpressionEvaluator.java:143)

重要的是要知道错误仅在我们使用子模块时发生。如果我们使用根 POM 工件和 jar 模块创建项目，则不会发生错误。

4.问题

为什么只有在我们使用子模块时才会出现这个错误？

有什么建议可以解决我的问题吗？我应该忘记它并按照我想要的模式为每个项目手动设置project.name 和project.build.fileName 吗？

重要更新：

有些答案只是说使用&{parent.name}，但它不起作用。拜托，这是一个赏金问题，在回答这个问题之前，请考虑使用Maven version 3.3.9 测试您的解决方案。

Maven 版本 3.3.9

编辑 - 在发生错误的阶段向问题添加详细信息，直到 prepare-package 阶段一切正常，但 StackOverflow 发生在 @ 987654353@ 项目的 Maven 生命周期阶段。

Answer 1

这是属性继承的问题。
尝试使用${parent.name} 而不是${project.parent.name}。
看：Project name declared in parent POM isn't expanded in a module filtered web.xml。

---更新---

Benjamin Bentmann (maven committier) 说：“不过，一般来说，${project.parent.*} 形式的表达式是一种不好的做法，因为它们依赖于特定的构建状态，并且通常不会在整个 POM 中工作，从而引起意外”。

https://issues.apache.org/jira/browse/MNG-5126?jql=text%20~%20%22parent%20name%22

也许您应该考虑使用${project.parent.*} 是一个好方法。

Answer 2

将 company-any-artifact 中的 pom.xml 更改为以下内容即可。

<?xml version="1.0" encoding="UTF-8"?>
<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>com.company</groupId>
    <artifactId>any-artifact</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>${project.groupId}</name>


    <modules>
        <module>any-module</module>
    </modules>

    <!-- if remove finalName, maven will not throw StackOverflow error -->
    <build>
        <finalName>${project.groupId}-${project.version}</finalName>
    </build>
</project>

将子模块中的 pom.xml 更改为下面

<?xml version="1.0" encoding="UTF-8"?>
<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>
        <artifactId>any-artifact</artifactId>
        <groupId>com.company</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>com.company.any-artifact</groupId>
    <artifactId>any-module</artifactId>
    <packaging>pom</packaging>  

  <!--   <name>${project.parent.name}-${project.artifactId}</name>  --> 

    <modules>
        <module>any-submodule</module>
    </modules>  
     <build>
        <finalName>${project.parent.name}-${project.artifactId}</finalName>
    </build> 
</project>

将子模块 pom.xml 更改为下面

<?xml version="1.0" encoding="UTF-8"?>
<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>
        <artifactId>any-module</artifactId>
        <groupId>com.company.any-artifact</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>com.company.any-artifact.any-module</groupId>
    <artifactId>any-submodule</artifactId>
        <!-- <name>${project.parent.name}-${project.artifactId}-${project.version}</name>    -->
    <build>
        <finalName>company-${project.parent.name}-${project.artifactId}-${project.version}</finalName>
    </build>
</project>

那么输出是：company-any-module-any-submodule-1.0-SNAPSHOT

Answer 3

有趣！我开始克隆 repo 并重现错误。我将不胜感激任何可以从下面提到的帮助我调试问题的任何步骤中获得的线索 -

1. Maven Life Cycle Phases 发生问题的阶段是生命周期的package 阶段。意思是 mvn package 重现了您的项目的问题。

2. 查看错误中的堆栈跟踪行。了解它失败的表达式评估 -

   @Override
   public Object evaluate( String expr ) throws ExpressionEvaluationException {
       return evaluate( expr, null ); // Line 143
   }
   

3. 这也不是导致它的 finalName 属性。由于指定相同的默认值 <finalName>${artifactId}-${version}</finalName> 在相同的项目配置下工作正常。

4. 然后尝试将any-submodule的包装更改为

   <packaging>pom</packaging>
   

   并且错误消失了。这意味着在包装为 jar 、 war 等时，表达式评估不同并导致溢出。

5. 修改any-module 或any-submodule pom.xml 内容我可以肯定地说，是project.parent.name 在计算表达式时导致递归并导致堆栈溢出（如何？ - 是@ 987654322@..）。另外，改变

   <name>${project.parent.name}-${project.artifactId}</name>

   到

   <name>${parent.name}-${project.artifactId}</name>

   对我有用，因为我没有收到错误，但生成的 jar 是类型 -

   ${parent.name}-any-module-any-submodule-1.0-SNAPSHOT.jar 和

   ${parent.name}-any-submodule-1.0-SNAPSHOT分别跟换。

6. 根据需求寻找解决方案，我正在寻找你正在使用的递归的尾巴。

注意 - 仍在努力寻找解决此问题的适当方法。

Answer 4

正如我在回复Difference between project.parent.name and parent.name ans use of finalName in pom.xml 时所说的

我们先来看看基础知识：

如POM Reference中所述：

finalName：这是最终构建时捆绑项目的名称（无文件扩展名，例如：my-project-1.0.jar）。它默认为 ${artifactId}-${version}。

名称：项目往往具有会话名称，超出 artifactId。

所以这两个有不同的用途。

• name 纯粹用于提供信息，主要用于生成文档和构建日志。它不会被继承，也不会在其他任何地方使用。它是人类可读的字符串，因此可以包含任何字符，即文件名中不允许的空格或字符。所以，这将是有效的：<name>My Turbo Project on Speed!</name>。对于工件来说，这显然至少是一个有问题的文件名。

• 如上所述，finalName 是生成的工件的名称。它是继承的，所以它通常应该依赖于属性。仅有的两个真正有用的选项是默认的${artifactId}-${version} 和无版本的${artifactId}。其他一切都会导致混乱（例如一个名为foo 的项目创建了一个工件bar.jar）。实际上，我的涡轮增压计划！将是有效的，因为这是一个有效的文件名，但实际上，这样的文件名往往是相当不可用的（例如，尝试从 bash 中处理包含 ! 的文件名）

---

那么，至于 Stackoverflow 发生的原因：

• name 没有被继承
• project.parent.name 也不会在插值期间进行评估，因为名称是少数对孩子完全不可见的属性之一
• parent.name 实际上曾经在较旧的 Maven 版本中工作，但更多的是由于一个错误（也不推荐访问没有前导 project 的属性）。
• 未对缺失的属性进行插值，即按原样保留在模型中
• 因此，在 any-submodule 的有效 pom 中，finalName 的值仍然是（尝试使用 mvn help:effective-pom）：${project.parent.name}-any-submodule

到目前为止很糟糕。现在是 StackOverflow 的原因

Maven 有一个称为后期插值的附加功能，可以在实际使用插件参数时评估它们的值。这允许 pluing 使用不属于模型的属性，但在生命周期的早期由插件生成（例如，这允许插件为最终名称提供 git 修订）。

所以会发生这样的事情：

编辑：使错误的实际原因更清楚（参见 cmets）：

• 评估 jar 插件的 finalName： @Parameter( defaultValue = "${project.build.finalName}", readonly = true )
• PluginParameterExpressionEvaluator 启动并尝试评估最终名称 (${project.parent.name}-any-submodule，其中包含属性表达式 ${project.parent.name}。
• 评估者询问模型，模型反过来返回父项目的名称，即：${project.parent.name}-any-module。
• 因此评估者尝试解决此问题，返回 ${project.parent.name}-any-module（再次），因为属性始终针对当前项目解决，循环再次开始。
• 引发 StackOverflowError。

---

如何解决这个问题

很遗憾，你不能。

您需要为每个项目明确指定name（以及artifactId）。没有解决方法。

那么，你可以让finalName依赖它。但是，我建议不要这样做（请参阅我对 Difference between project.parent.name and parent.name ans use of finalName in pom.xml 的回答）

以这种方式更改最终名称的问题是本地构建工件的名称和存储库中的名称会不同，因此您的工件在本地命名为any-artifact-any-module-any-submodule.jar，但存储库中的工件名称仍为any-submodule.jar

建议

• 如果您真的需要区分这些细节，请改为更改 artifactId：<artifactId>artifact-anymodule-anysubmodule</artifactId>。
• 不要在短名称中使用破折号来区分结构的级别。
• 提示：模块的路径仍然可以是anymodule，不需要是模块的实际artifactId！
• 当我们这样做的时候：使用 name 来实现它的目的，以便人类可读，因此您可能会考虑一些更具视觉吸引力的东西（因为这是出现在构建日志中的名称）：<name>Artifact :: AnyModule :: AnySubModule</name> .
• 实际上很容易使用非常短的 groovy 脚本自动创建名称条目。
• 您还可以编写一个强制规则来强制 artifactIds 的命名

Answer 5

您的问题的严格答案是 ${project.parent.name} 将不会作为模型插值过程的一部分解决。反过来，您有一个 StackOverflowError，位于代码完全不同的位置，即当...构建项目的最终 JAR 时。

第 1 部分：构建的模型错误

这就是发生的事情。当您在项目上启动 Maven 命令时，它采取的第一个操作是创建项目的有效模型。这意味着读取您的 POM 文件、使用激活的配置文件进行推理、应用继承、对属性执行插值……所有这些都是为了为您的项目构建最终的 Maven 模型。这项工作由Maven Model Builder 组件完成。

构建模型的过程相当复杂，很多步骤可能分为 2 个阶段，但我们感兴趣的部分在 model interpolation 部分。这是 Maven 将模型中所有由 ${...} 表示的标记替换为计算值的时候。它发生在注入配置文件并执行继承之后。在那个时间点，由MavenProject 对象表示的Maven 项目还不存在，只有它的Model 正在构建中。只有在您拥有完整的模型之后，您才能开始从中构建 Maven 项目。

因此，当插值完成时，它仅根据 POM 文件中存在的信息进行推理，唯一有效的值是 mentioned in the model reference。 （如果您想查看源代码，此替换由 StringSearchModelInterpolator 类执行。）值得注意的是，您会注意到模型中的 <parent> 元素确实不包含名称的父模型。 Maven 中的Model 类实际上是使用Modello 从源.mdo 文件生成的，并且该源仅为<parent> 元素定义groupId, artifactId, version and relativePath（以及自定义id）。这也是可见的in the documentation。

所有这些的后果是，在执行模型插值后，令牌${project.parent.name} 将不会被替换。此外，由它构造的MavenProject 将有一个未替换的包含${project.parent.name} 的名称。您可以在日志中看到这一点，在您的示例项目中，我们有

[INFO] Reactor Build Order:
[INFO] 
[INFO] company-any-artifact
[INFO] ${project.parent.name}-any-module
[INFO] ${project.parent.name}-any-submodule

意味着 Maven 将项目的实际名称 any-module 视为 ${project.parent.name}-any-module。

第 2 部分：诡异开始

现在，反应堆中的所有项目都已正确创建甚至编译。实际上，理论上一切都应该正常工作，但项目本身的名称只是完全无聊的名称。但是你有一个奇怪的情况，它在使用maven-jar-plugin 创建 JAR 时失败。在您的示例中构建失败并显示以下日志：

[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ any-submodule ---
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] 
[INFO] company-any-artifact ............................... SUCCESS [  0.171 s]
[INFO] ${project.parent.name}-any-module .................. SUCCESS [  0.002 s]
[INFO] ${project.parent.name}-any-submodule ............... FAILURE [  0.987 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------

意味着在模型构建后出现了问题。而且原因是插件injects the name of the project as a parameter:

/**
 * Name of the generated JAR.
 *
 * @parameter alias="jarName" expression="${jar.finalName}" default-value="${project.build.finalName}"
 * @required
 */
private String finalName;

注意 project.build.finalName 作为子模块生成的 JAR 名称的默认值。这种注入和变量的插值是由另一个名为 PluginParameterExpressionEvaluator 的类完成的。

那么这会发生什么：

• any-submodule 上的 JAR 插件注入了项目的最终名称，命名为 ${project.parent.name}-any-submodule。
• 感谢从父项目继承，以及在您最顶层的 POM 项目中声明 <finalName>，它继承了 <finalName>${project.name}-${project.version}</finalName>。
• Maven 现在尝试将 ${project.name} 插入到 any-submodule。
• 由于第 1 部分，这将解析为 ${project.parent.name}-any-submodule。
• Maven 现在尝试将${project.parent.name} 插入any-submodule。这工作正常：MavenProject 已构建，getParent() 将在项目实例上调用，返回具体的 Maven 父项目。因此，${project.parent.name} 将尝试解析any-module 的名称，实际上是${project.parent.name}-any-module。
• Maven 现在尝试插入 ${project.parent.name}-any-module，但仍在 any-submodule 项目实例上。对于 PluginParameterExpressionEvaluator，评估令牌的根 "project" 没有改变。
• Maven 现在尝试在any-submodule 上插入${project.parent.name}，这再次正常工作并返回${project.parent.name}-any-module。
• Maven 现在尝试在 any-submodule... 上插入 ${project.parent.name}，这有效并返回 ${project.parent.name}-any-module，因此它尝试评估 ${project.parent.name}...

你可以看到这里发生了无穷无尽的递归，这导致了你拥有的StackOverflowError。这是PluginParameterExpressionEvaluator 中的错误吗？这还不清楚：它的原因是模型值最初没有被正确替换。理论上，它可以处理评估${project.parent} 的特殊情况并创建一个新的PluginParameterExpressionEvaluator 处理这个父项目，而不是一直处理当前项目。如果您对此有强烈的感觉，请随时创建a JIRA issue。

第 3 部分：为什么它可以在没有子模块的情况下工作

根据上面所说的，您现在可以推断为什么它在这种情况下有效。让我们来解释一下 Maven 需要做什么来评估最终名称，因为它必须被注入到 Maven Jar 插件中：

• any-module 上的 JAR 插件注入了项目的最终名称，命名为 ${project.parent.name}-any-module。
• 感谢从父项目继承，以及在您最顶层的 POM 项目中声明 <finalName>，它继承了 <finalName>${project.name}-${project.version}</finalName>。
• Maven 现在尝试将 ${project.name} 插入到 any-module。
• 这将解析为${project.parent.name}-any-module，与以前相同。
• Maven 现在尝试将${project.parent.name} 插入any-module。就像以前一样，这可以正常工作：MavenProject 已构建，getParent() 将在项目实例上调用，返回具体的 Maven 父项目。因此，${project.parent.name} 将尝试解析 any-artifact 的名称，实际上是 company-any-artifact。
• 插值成功并停止。

而且你没有任何错误。