logo标签列表

如何在Maven POM中从文件设置构建属性？

javamavenant
8

我需要读取和过滤一个位于项目外部位置的属性文件，例如 ${user.home}/my.properties。这个属性文件的样子如下：

res.dir=/my/stuff/here
resource.dir=C:/${res.dir}
bin.dir=${resource.dir}/bin
cfg.dir=${resource.dir}/config

当我构建和运行应用程序时，都需要进行一些操作。在Ant中很容易做到这一点，只需使用PROPERTY标签即可。然而，在Maven中没有好的方法可以实现。

到目前为止，我尝试过Maven的<property>标签、<filter>标签以及其他各种标签的组合。要么构建失败，要么单元测试失败，甚至两者都有可能。

如果我将这些属性硬编码进POM中，就一切正常，所以我知道问题仅在于读取属性。

我查看了properties-maven-plugin，但插件似乎已不再维护。

有方法可以解决这个问题吗？

我看到了你关于插件的评论，所以删除了我的回答。只是想让你知道，无论是否维护，它都能正常工作（或者至少曾经能够正常工作）。 - crnlx
谢谢您的回应。是的，我认为如果插件不再维护甚至被开发（它被列为“Alpha”）那么要么它非常棒，没有进一步的发展是可能的（令人怀疑），要么有更好的方法来做这个。我希望有人能指引我走向“更好的方法”。 - user1071914
1
你是如何得出插件将不再维护的假设的？此外，Maven项目之外的属性将使您的项目依赖于这些东西，这将破坏Maven概念，即将所有必需的内容放在项目本身内。问题是为什么您需要这个？ - khmarbaise
1
问题是为什么你需要这个？ 这是公司的标准。 它起源于Ant时代。 我对它的满意程度和Maven社区中的其他人一样不高。 至于插件，连Codehaus也将其列为“预发布版”。 - user1071914
我和你的情况差不多，正在寻找一个好的解决方案。你最终使用了什么？ - Eric B.
2个回答
8

你可以简单地实现自己的 maven-plugin，它将为您处理此事。

以下是具有以下结构的示例：

.
 |-- pom.xml
 |-- plugin
 |   `-- pom.xml
 |   `-- src
 |       `-- main
 |           `-- java
 `-- app
     `-- pom.xml
     `-- src
         `-- main
             `-- java

你需要创建一个Mojo，将属性文件作为输入，并将属性传播到app的pom.xml中。实际上，pom.xml不会被更新，只是其中的项目数据会被更新。 pom.xml。
<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.stackoverflow</groupId>
    <artifactId>Q12082277</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

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

    <modules>
        <module>plugin</module>
        <module>app</module>
    </modules>

</project>

plugin/pom.xml

<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>
        <groupId>com.stackoverflow</groupId>
        <artifactId>Q12082277</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>Q12082277-plugin</artifactId>
    <packaging>maven-plugin</packaging>

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

    <dependencies>
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.0.4</version>
        </dependency>
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-project</artifactId>
            <version>2.2.1</version>
        </dependency>
    </dependencies>
</project>

plugin/src/main/java/com/stackoverflow/Q12082277/plugin/PropertiesMojo.java

package com.stackoverflow.Q12082277.plugin;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Properties;

/**
 * @author maba, 2012-08-24
 *
 * @goal extract
 */
public class PropertiesMojo extends AbstractMojo {

    private Log log;

    /**
     * The current project representation.
     * @parameter expression="${project}"
     * @required
     * @readonly
     */
    private MavenProject project;

    /**
     * A properties file
     *
     * @parameter expression="${propertiesFile}"
     * @required
     */
    private File propertiesFile;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        log.info("Executing PropertiesMojo on " + propertiesFile.getAbsolutePath());

        try {
            Properties fileProperties = new Properties();
            fileProperties.load(new FileInputStream(propertiesFile));
            Properties projectProperties = project.getProperties();
            for (Object key : fileProperties.keySet()) {
                projectProperties.setProperty((String)key, (String) fileProperties.get(key));
            }
            project.getProperties().list(System.out);
        } catch (FileNotFoundException e) {
            throw new MojoFailureException("The file " + propertiesFile.getAbsolutePath() + " was not found!", e);
        } catch (IOException e) {
            log.error("");
        }

    }

    @Override
    public void setLog(Log log) {
        this.log = log;
    }
}

您将从以下的 app/pom.xml 文件中使用此插件。
<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>
        <groupId>com.stackoverflow</groupId>
        <artifactId>Q12082277</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>Q12082277-app</artifactId>

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

    <build>
        <plugins>
            <plugin>
                <groupId>com.stackoverflow</groupId>
                <artifactId>Q12082277-plugin</artifactId>
                <version>1.0-SNAPSHOT</version>
                <executions>
                    <execution>
                        <phase>initialize</phase>
                        <goals>
                            <goal>extract</goal>
                        </goals>
                        <configuration>
                            <propertiesFile>${user.home}/my.properties</propertiesFile>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>1.2.1</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>java</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <mainClass>com.stackoverflow.Q12082277.App</mainClass>
                </configuration>
            </plugin>
        </plugins>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>
</project>

然后你需要添加以下的app.properties文件，它将作为一个模板来接收我们刚刚从文件中读取的值，并设置这些值并创建一个具体的app.properties文件，该文件可从jar包内部访问。

app/src/main/resources/app.properties

res.dir=${res.dir}
resource.dir=${resource.dir}
bin.dir=${bin.dir}
cfg.dir=${cfg.dir}

最后，这里有一个测试应用程序，它只从类路径中加载app.properties文件并打印结果。

app/src/main/java/com/stackoverflow/Q12082277/App.java

package com.stackoverflow.Q12082277;

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

/**
 * @author maba, 2012-08-23
 */
public class App {

    public static void main(String[] args) throws IOException {
        ClassLoader loader = App.class.getClassLoader();
        InputStream in = loader.getResourceAsStream("app.properties");
        Properties properties = new Properties();
        properties.load(in);
        properties.list(System.out);
    }
}

现在您可以站在顶级目录并执行。
mvn install

接下来进入app文件夹并执行命令。

mvn exec:java

它将打印

-- listing properties --
resource.dir=C://my/stuff/here
cfg.dir=C://my/stuff/here/config
bin.dir=C://my/stuff/here/bin
res.dir=/my/stuff/here

这正是你想要的。

这似乎是最好的答案 - 我并不高兴Maven工具集中存在这样一个巨大的漏洞，但是嘿，欢迎来到开源世界，我想。 :-( - user1071914
5

我认为，将属性文件转换为模板文件，并使用Maven资源过滤器从pom.xml中获取属性会更好。

一个简单的设置可能如下所示：

pom.xml

<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.stackoverflow</groupId>
    <artifactId>Q12082277</artifactId>
    <version>1.0-SNAPSHOT</version>

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

    <properties>
        <res.dir>/default/stuff/here</res.dir>
        <resource.dir>${res.dir}</resource.dir>
        <bin.dir>${resource.dir}/bin</bin.dir>
        <cfg.dir>${resource.dir}/config</cfg.dir>
    </properties>

    <dependencies>
    <!-- Your dependencies -->
    </dependencies>

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

</project>

src/main/resources/app.properties

res.dir=${res.dir}
resource.dir=${resource.dir}
bin.dir=${bin.dir}
cfg.dir=${cfg.dir}

src/main/java/com/stackoverflow/Q12082277/App.java

package com.stackoverflow.Q12082277;

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

/**
 * @author maba, 2012-08-23
 */
public class App {

    public static void main(String[] args) throws IOException {
        ClassLoader loader = App.class.getClassLoader();
        InputStream in = loader.getResourceAsStream("app.properties");
        Properties properties = new Properties();
        properties.load(in);
        properties.list(System.out);
    }
}

System.out

-- listing properties --
resource.dir=/default/stuff/here
cfg.dir=/default/stuff/here/config
bin.dir=/default/stuff/here/bin
res.dir=/default/stuff/here

pom.xml文件包含了默认的属性，适用于所有人。

如果你想要覆盖这些值，可以使用输入参数来调用Maven:

mvn install -Dres.dir=/my/stuff/here -Dresource.dir="C:/${res.dir}"

System.out

-- listing properties --
resource.dir=C://my/stuff/here
cfg.dir=C://my/stuff/here/config
bin.dir=C://my/stuff/here/bin
res.dir=/my/stuff/here

通过这种方式，每个人都将拥有相同的属性视图，并且在自己的电脑上运行时可以选择覆盖它们。
谢谢您的建议，不幸的是，当前的布局方式（属性在单独的文件中）是公司标准，无法讨论，所以我只能按照现有的方式使用它。 - user1071914
@user1071914 试着使用Maven Antrun插件，它可能会满足你的需求。 - maba
@user1071914 我添加了另一个答案，实现了一个简单的魔法，可以满足你的要求。 - maba
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接