从命令行覆盖 maven 插件中的属性

Question

这个 maven 命令会启动 H2 数据库的旧版本 (1.3.162)：

mvn -debug com.edugility:h2-maven-plugin:1.0:spawn

正如这里推荐的那样，我试图在命令行上覆盖插件的属性......所以我可以改用更新的 h2 版本：

mvn -debug -Dh2Version=1.4.200 com.edugility:h2-maven-plugin:1.0:spawn

这个带有旧 h2 版本的 h2Version 属性在插件的 pom 中的github 上定义。

这是详细的 maven 输出的结尾

 [DEBUG] Process arguments: [C:\java\jdk-9.0.4\bin\java, -cp, C:\Users\eoste\.m2\repository\com\h2database\h2\1.3.162\h2-1.3.162.jar, org.h2.tools.Server, -tcp, -tcpPassword, h2-maven-plugin, -tcpPort, 9092]
 [INFO] H2 server spawned at tcp://localhost:9092

不仅旧的 1.3.162 版本启动，而且我在命令行上放置的 h2Version 属性的任何地方都零提及。

我尝试将 -Dh2Version 参数移动到命令行的末尾。 我还尝试从本地存储库中删除插件，以强制下载，因此 h2Version 可能会被重新评估....这些都不起作用。 这个博客展示了如何在插件中嵌入依赖项，但这比我简单的命令行调用要复杂得多。

我究竟做错了什么？

使用 windows 10、java 9、maven 3.6.2

Answer 1

我认为您无法使用这个特定的 maven-plugin 来做到这一点。 这是针对有类似问题的人的另一个答案： How to pass parameter to Maven plugin from CLI? .

基本上， h2Version属性没有定义为用户属性。

当您使用您提到的命令启动插件时，预定义的配置属性会有一个输出：

<configuration>
  <allowOthers>${h2.allowOthers}</allowOthers>
  <baseDirectory>${h2.baseDirectory}</baseDirectory>
  <forceShutdown>${h2.forceShutdown}</forceShutdown>
  <ifExists>${h2.ifExists}</ifExists>
  <java>${h2.java}</java>
  <port default-value="9092">${h2.port}</port>
  <shutdownAllServers>${h2.shutdownAllServers}</shutdownAllServers>
  <shutdownHost default-value="localhost">${h2.shutdownHost}</shutdownHost>
  <shutdownPassword default-value="h2-maven-plugin">${h2.shutdownPassword}</shutdownPassword>
  <trace>${h2.trace}</trace>
  <useSSL>${h2.useSSL}</useSSL>
</configuration>

用户只能定义这些属性。 例如，更改运行端口：

mvn -debug com.edugility:h2-maven-plugin:1.0:spawn -Dport=9090

Answer 2

我究竟做错了什么？

1) 当您想使用未维护的插件/库时要小心。 源代码从大约 8 年没有更新。 那可能有重要的问题。

2) 要知道如何使用 Maven 插件，请不要查看 pom 声明。 您可以在 中找到一些信息，但您会在 mojo 实现/规范中找到更多信息。
但事实上不，你甚至不应该依靠它来了解如何使用插件。

3) 事实上，Maven 插件可能支持可配置属性：直接在 pom.xml 中，甚至导出它们以供命令行使用。 但这不是自动的。 但是在这两种情况下，插件开发人员都必须预见到，并且通常记录在插件或源存储库主页上。

事实上，在您的情况下，如果您进入 Mojo 实现： AbstractH2Mojo ，您可以看到配置是如何设置的。
所有属性在 mojo 构造函数中都有默认值。

 protected AbstractH2Mojo() {
    super();
    final Service tcpService = new Service("tcp", Service.getDefaultPort("tcp"), false, false);
    this.setServices(Collections.singletonList(tcpService));
    this.setPort(Service.getDefaultPort("tcp"));
    this.setShutdownPassword("h2-maven-plugin");
    this.setJava(new File(new File(new File(System.getProperty("java.home")), "bin"), "java"));
 }

首先调用 mojo 空构造函数，然后在创建的实例上调用所有 setter。
这意味着您可以在运行时通过提供诸如${artifactIdPrefixWithoutMavenPlugin}.field类的属性来覆盖该类中定义的任何这些属性。
由于 maven 插件是h2-maven-plugin ， 因此引用的前缀是h2 。

如果你运行：

mvn -X com.edugility:h2-maven-plugin:1.0:spawn -Dh2.port=8084 -Dh2.useSSL=false

您可以在输出中看到：

[DEBUG] Configuring mojo 'com.edugility:h2-maven-plugin:1.0:spawn' with basic configurator -->
[DEBUG]   (s) port = 8084
[DEBUG]   (s) shutdownHost = localhost
[DEBUG]   (s) shutdownPassword = h2-maven-plugin
[DEBUG]   (s) useSSL = false
[DEBUG] -- end configuration --
[DEBUG] Process arguments: [/usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java, -cp, /home/david/.m2/repository/com/h2database/h2/1.3.162/h2-1.3.162.jar, org.h2.tools.Server, -tcp, -tcpPassword, h2-maven-plugin, -tcpPort, 8084]

关于使用的 h2 jar，如果您仍然查看同一个类，您将看到从 classpath 检索 jar 文件的部分：

 public final File getH2() {
    final ProtectionDomain pd = Server.class.getProtectionDomain();
    assert pd != null;
    final CodeSource cs = pd.getCodeSource();
    assert cs != null;
    final URL location = cs.getLocation();
    assert location != null;
    try {
      return new File(location.toURI());
    } catch (final URISyntaxException wontHappen) {
      throw (InternalError)new InternalError().initCause(wontHappen);
    }
 }

这意味着您无法更改使用的 H2 JAR：从运行插件时的命令行或 pom.xml 中的插件声明，因为没有在 Mojo 中定义属性来实现这一点。

如果要更改H2版本，则需要更改插件嵌入的版本。 作为初学者，您可以尝试 fork 插件 GIT 存储库，更改 pom 中使用的 h2 依赖项以符合您的要求，并检查尽管存在间隙版本，但使用该插件是否可行。

请注意，您可以添加 Mojo 的新属性以使其完全可配置，例如：

mvn ... -Dh2Version=1.4.200 

但在这种情况下，您将需要检索它。 例如，通过执行从 m2 中央存储库下载依赖项的请求。
并且您还应该确保仅使用 h2 版本的有效范围。