如何在 maven pom.xml 中更改 shell 脚本输出以使用

Posted 2023-02-26

【中文标题】如何在 maven pom.xml 中更改 shell 脚本输出以使用

【英文标题】：How to variablize shell script output on maven pom.xml to use

【发布时间】：2016-03-08 18:00:30

【问题描述】：

我想知道有没有办法让 maven 执行一个 shell 脚本来卷曲资源并使响应像 maven 可以引用的环境变量或全局变量一样可用，或者是否可以使用 @987654321 @?

所以当我进行 maven 构建时，我想执行这个 shell 脚本。脚本本身将使 curl 到某个资源 URI 并输出响应（我们可能必须等待它返回），maven 或可能 Groovy 可以以某种方式获取该 curl 响应并将其用于设置某些配置。

【参考方案1】：

这是一个建议的方法：

使用Exec Maven Plugin 启动您的脚本或命令 使用Properties Maven Plugin 加载配置

此方法的要求：

您期望的 curl 响应（或输出或脚本）应具有 name=value 格式（即属性文件） 必须在执行属性 Maven 插件之前在您的 POM 中声明 Exec Maven 插件执行，并且它们必须附加到相同的 Maven 阶段或两个连续的 Maven 阶段，以提供所需的流程 属性 Maven 插件执行必须附加到 Maven 的早期阶段（初始化或验证），以使配置可用于其他 Maven 阶段和插件

有关 Maven 阶段的完整列表，官方文档here

更新：下面是一个流程示例，刚刚经过测试并且可以完美运行（在 Windows 机器上）：

<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.sample</groupId>
    <artifactId>generation</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>1.1</version>
                <executions>
                    <execution>
                        <id>retrieve-config</id>
                        <phase>validate</phase>
                        <goals>
                            <goal>exec</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <executable>echo</executable>
                    <arguments>
                        <argument>jar.name=from-exec</argument>
                        <argument>></argument>
                        <argument>config.properties</argument>
                    </arguments>
                    <workingDirectory>$basedir/src/main/resources/</workingDirectory>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>properties-maven-plugin</artifactId>
                <version>1.0-alpha-2</version>
                <executions>
                    <execution>
                        <id>read-properties</id>
                        <phase>initialize</phase>
                        <goals>
                            <goal>read-project-properties</goal>
                        </goals>
                        <configuration>
                            <files>
                                <file>$basedir/src/main/resources/config.properties</file>
                            </files>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.4</version>
                <configuration>
                    <finalName>$jar.name</finalName>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

基本上，附加到validate 阶段的 exec 插件将在构建开始时执行，将内容 jar.name=from-exec 写入 config.properties 文件（通过 echo 命令）。

然后附加到initialize 阶段的属性插件将读取该 config.properties 文件并加载要用作构建的一部分的属性。

然后，例如，jar 插件将使用该属性作为其配置的一部分（<finalName>$jar.name</finalName> 部分）。

运行mvn clean package，你会在目标文件夹中找到from-exec.jar文件。

更新：上面是如何从脚本动态加载一组属性的示例，然后可以将其注入到 Maven 构建中（因此用作 POM 配置的一部分）。

但是，如果您需要将此动态配置加载到您的应用程序中，您甚至可以跳过第二步（Propeprties Maven 插件）并从代码中的config.properties 文件加载属性，只要该文件是应用程序类路径的一部分（如上例中，位于src/main/resources 下）。

由于属性文件的创建发生在早期 Maven 阶段（validate 或 initialize），test（用于您的测试）和package（用于您的最终工件）阶段可以将其用作必需的。

在 Java 中，您将使用 java.util.Properties 类，在 Groovy 中，您可以按照 *** 中另一个问题的解释 here。

【讨论】：

我想知道因为 curl 最多可能需要 3-5 秒，所以是否存在属性 maven 插件找不到配置文件的情况（因为它尚未从剧本）？在这种情况下如何建立等待？

Exec 插件会阻塞构建，直到配置的命令的执行不会结束，因此这种情况不应该发生。然而，考虑到这一要求，可能不太重要，整个流程可能会影响构建时间、维护、可移植性。

感谢您的更新。我想知道如何从我的 Groovy 代码中的属性文件中访问这些变量，可能是在我想以编程方式配置我的 http 标头的 标记中的某个位置，例如在构建期间。

我更新了我对此要求的回答，以防您想在运行时使用这些属性（用于测试或与您的应用程序一起打包）。