java - 访问 pom 中定义的 maven 属性

Question

如何在普通 maven 项目和 maven 插件项目中访问 pom 中定义的 maven 属性？

Answer 1

使用properties-maven-plugin在编译时将特定的 pom 写入properties文件，然后在运行时读取该文件。

在你的pom.xml中：

<properties>
     <name>${project.name}</name>
     <version>${project.version}</version>
     <foo>bar</foo>
</properties>

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>properties-maven-plugin</artifactId>
            <version>1.0.0</version>
            <executions>
                <execution>
                    <phase>generate-resources</phase>
                    <goals>
                        <goal>write-project-properties</goal>
                    </goals>
                    <configuration>
                        <outputFile>${project.build.outputDirectory}/my.properties</outputFile>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

然后在.java：

java.io.InputStream is = this.getClass().getResourceAsStream("my.properties");
java.util.Properties p = new Properties();
p.load(is);
String name = p.getProperty("name");
String version = p.getProperty("version");
String foo = p.getProperty("foo");

Answer 2

从 Maven设置系统变量并在 java 中使用以下调用

System.getProperty("Key");

Answer 3

Maven 已经有一个解决方案来做你想做的事：

仅从 POM.xml - pom 解析器获取 MavenProject？

顺便说一句：第一次点击谷歌搜索；）

Model model = null;
FileReader reader = null;
MavenXpp3Reader mavenreader = new MavenXpp3Reader();

try {
     reader = new FileReader(pomfile); // <-- pomfile is your pom.xml
     model = mavenreader.read(reader);
     model.setPomFile(pomfile);
}catch(Exception ex){
     // do something better here
     ex.printStackTrace()
}

MavenProject project = new MavenProject(model);
project.getProperties() // <-- thats what you need

Answer 4

这可以通过标准的 java 属性结合maven-resource-plugin启用的属性过滤来完成。

有关更多信息，请参阅http://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html

这将适用于标准 Maven 项目和插件项目

Answer 5

我在spring-boot-maven-plugin中使用build-info目标：

在我的 pom.xml 中：

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <executions>
    ...
      <execution>
        <id>build-info</id>
        <goals>
          <goal>build-info</goal>
        </goals>
      </execution>
    </executions>
    <configuration>
    ...
    </configuration>
</plugin>

在我的代码中：

@Autowired
BuildProperties buildProperties;

...

@GetMapping
public Map<String, String> getVersion() {
    return Map.of(
            "build.name", buildProperties.getName(), 
            "build.version", buildProperties.getVersion(), 
            "build.date", buildProperties.getTime().toString());
}

关于这个插件目标的更多信息可以在这里找到：https ://docs.spring.io/spring-boot/docs/current/maven-plugin/reference/htmlsingle/#goals-build-info

Answer 6

Leif Gruenwoldt 答案的更新：

使用很重要

this.getClass().getClassLoader().getResourceAsStream("maven.properties");

而不仅仅是

 this.getClass().getResourceAsStream("maven.properties");

特别是，如果您将maven.properties文件写入权限project.build.outputDirectory：

<plugin>
   <groupId>org.codehaus.mojo</groupId>
   <artifactId>properties-maven-plugin</artifactId>
   <version>1.0.0</version>
   <executions>
      <execution>
         <phase>generate-resources</phase>
         <goals>
            <goal>write-project-properties</goal>
         </goals>
         <configuration>
            <outputFile>${project.build.outputDirectory}/maven.properties</outputFile>
         </configuration>
      </execution>
   </executions>
</plugin>

解释就在那里。

Answer 7

您可以使用 JDOM (http://www.jdom.org/) 解析 pom 文件。