针对不同目标的不同 Maven 配置

Different Maven configurations for different goals

我有一个 Maven 项目,其中包含一个公开不同目标的 Maven 插件(Liquibase Maven plugin)。 其中两个目标(更新和差异)需要不同的参数,它们之间存在冲突(因为两者的语义不同),所以我需要在两个目标执行中为 Maven 提供不同的属性。

我就是这么做的

<plugin>
    <groupId>org.liquibase</groupId>
    <artifactId>liquibase-maven-plugin</artifactId>
    <version>3.4.1</version>

    <!-- This configuration is used for every goal except "diff" -->
    <configuration>
        <propertyFile>src/main/resources/liquibase.properties</propertyFile>
        <promptOnNonLocalDatabase>false</promptOnNonLocalDatabase>
    </configuration>
    <executions>
        <execution>
            <id>default-cli</id>
            <goals>
                <goal>diff</goal>
            </goals>
            <!-- This configuration is used for the "diff" goal -->
            <configuration>
                <propertyFile>src/main/resources/liquibaseDiff.properties</propertyFile>
                <promptOnNonLocalDatabase>false</promptOnNonLocalDatabase>
            </configuration>
        </execution>
    </executions>
</plugin>

但是,此配置是错误的,因为对于每个目标(差异,其他目标的更新)仅使用 liquibaseDiff.properties 文件。

有什么方法可以在 Maven 中为不同的目标传递不同的配置吗?

插件的配置可以在两个不同的位置完成:

  • Globally for all executions。全局配置是通过 <plugin> 下的 <configuration> 元素完成的。此配置由所有执行继承。
  • Per execution。这是使用 <execution>.
  • 下的 <configuration> 元素完成的

在你的例子中,考虑这个 POM:

<plugin>
    <groupId>org.liquibase</groupId>
    <artifactId>liquibase-maven-plugin</artifactId>
    <version>3.4.1</version>
    <configuration>
        <!-- put the configuration here that is common to all executions -->
    </configuration>
    <executions>
        <execution>
            <id>diff</id>
            <goals>
                <goal>diff</goal>
            </goals>
            <configuration>
                <!-- put the specific configuration of the diff goal here, this will inherit from the global configuration -->
            </configuration>
        </execution>
        <execution>
            <id>update</id>
            <goals>
                <goal>update</goal>
            </goals>
            <configuration>
                <!-- put the specific configuration of the update goal here, this will inherit from the global configuration -->
            </configuration>
        </execution>
    </executions>
</plugin>

默认的继承行为是根据元素名称合并配置元素的内容。如果子 POM 具有特定元素,则该值成为有效值。如果子 POM 没有元素,但父 POM 有,则父值成为有效值。

如果发生冲突,您可以使用 combine.children and combine.self 控制 Maven 执行的默认继承。引用 Maven 文档:

combine.children="append" results in the concatenation of parent and child elements, in that order. combine.self="override", on the other hand, completely suppresses parent configuration.


除此之外,您需要注意的是,在命令行上执行直接调用目标的 Maven 命令时,例如 mvn liquibase:diff,它会创建一个 new default-cli 的 ID 执行。因此,由于上述目标 diff 的具体配置是在 id diff 的执行中完成的,因此不会使用它。这实际上是正常的,因为同一个插件的相同目标可能存在于具有不同配置的多个执行块中:如果在命令行上执行,应该使用哪一个,没有附加信息?

通常,这种情况可以通过两种方式解决:

  • 在命令行上执行特定的执行,即您配置的那个。 This is possible since Maven 3.3.1 然后你会执行

    mvn liquibase:diff@diff
    

    上面命令中的@diff是指POM中配置的执行的唯一<id>

  • 将您的执行绑定到 Maven 生命周期的特定阶段,并让它以生命周期的正常流程执行。这通常是首选解决方案。在上面的例子中,例如,我们可以在 diff 执行的执行块中添加一个 <phase>test</phase> ;然后 Maven 将在构建过程中测试阶段 运行 时执行它。