在代码中从maven pom.xml中检索版本

Question

在代码中从maven的pom.xml中检索版本号的最简单方法是什么,即以编程方式？

Answer 1

假设你正在使用Java,你可以

1. .properties在(最常见的)您的src/main/resources目录中创建一个文件(但在步骤4中,您可以告诉它在其他地方查找).

2. .properties使用项目版本的标准Maven属性设置文件中某些属性的值: foo.bar=${project.version}

3. 在您的Java代码中,从类路径中将属性文件中的值作为资源加载(谷歌有关如何执行此操作的大量示例,但这里是初学者的示例).

4. 在Maven中,启用资源过滤 - 这将导致Maven将该文件复制到输出类中,并在该副本期间转换资源,从而解释属性.你可以在这里找到一些信息,但你大多只是在你的pom中这样做:

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

您还可以访问其他标准属性,例如project.name,project.description甚至是放在pom中的任意属性<properties>等.资源过滤与Maven配置文件结合使用,可以在构建时为您提供变量构建行为.在运行时指定配置文件时-PmyProfile,可以启用随后可以在构建中显示的属性.

Answer 2

接受的答案可能是将版本号静态地提供给应用程序的最佳和最稳定的方法,但实际上并未回答原始问题:如何从pom.xml中检索工件的版本号？因此,我想提供一个替代方案,展示如何在运行时动态地执行它:

你可以使用Maven本身.更确切地说,您可以使用Maven库.

<dependency>
  <groupId>org.apache.maven</groupId>
  <artifactId>maven-model</artifactId>
  <version>3.3.9</version>
</dependency>

然后在Java中执行类似的操作:

package de.scrum_master.app;

import org.apache.maven.model.Model;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;

import java.io.FileReader;
import java.io.IOException;

public class Application {
    public static void main(String[] args) throws IOException, XmlPullParserException {
        MavenXpp3Reader reader = new MavenXpp3Reader();
        Model model = reader.read(new FileReader("pom.xml"));
        System.out.println(model.getId());
        System.out.println(model.getGroupId());
        System.out.println(model.getArtifactId());
        System.out.println(model.getVersion());
    }
}

控制台日志如下:

de.scrum-master.stackoverflow:my-artifact:jar:1.0-SNAPSHOT
de.scrum-master.stackoverflow
my-artifact
1.0-SNAPSHOT

更新2017-10-31:为了回答Simon Sobisch的后续问题,我修改了这样的示例:

package de.scrum_master.app;

import org.apache.maven.model.Model;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;

import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStreamReader;

public class Application {
  public static void main(String[] args) throws IOException, XmlPullParserException {
    MavenXpp3Reader reader = new MavenXpp3Reader();
    Model model;
    if ((new File("pom.xml")).exists())
      model = reader.read(new FileReader("pom.xml"));
    else
      model = reader.read(
        new InputStreamReader(
          Application.class.getResourceAsStream(
            "/META-INF/maven/de.scrum-master.stackoverflow/aspectj-introduce-method/pom.xml"
          )
        )
      );
    System.out.println(model.getId());
    System.out.println(model.getGroupId());
    System.out.println(model.getArtifactId());
    System.out.println(model.getVersion());
  }
}

Answer 3

打包的工件包含一个META-INF/maven/${groupId}/${artifactId}/pom.properties内容如下的文件:

#Generated by Maven
#Sun Feb 21 23:38:24 GMT 2010
version=2.5
groupId=commons-lang
artifactId=commons-lang

许多应用程序使用此文件在运行时读取应用程序/ jar版本,所需的设置为零.

上述方法的唯一问题是该文件(当前)在package阶段期间生成,因此在测试期间不会出现等等(有一个Jira问题需要更改,请参阅MJAR-76).如果这对您来说是一个问题,那么Alex描述的方法就是您的选择.

Answer 4

还有使用Maven以简单方式描述的方法来显示您的应用程序版本号:

将其添加到pom.xml

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-jar-plugin</artifactId>
      <configuration>
        <archive>
          <manifest>
            <mainClass>test.App</mainClass>
            <addDefaultImplementationEntries>
              true
            </addDefaultImplementationEntries>
          </manifest>
        </archive>
      </configuration>
    </plugin>
  </plugins>
</build>

然后用这个:

App.class.getPackage().getImplementationVersion()

我发现这种方法更简单.

Answer 5

为了补充@kieste发布的内容,我认为如果您使用的是Spring-boot,那么在代码中可以使用Maven构建信息的最佳方式:http ://docs.spring.io/spring-boot/上的文档docs/current/reference/htmlsingle/#production-ready-application-info非常有用.

您只需要激活执行器,并在您的application.properties或中添加您需要的属性application.yml

Automatic property expansion using Maven

You can automatically expand info properties from the Maven project using resource filtering. If you use the spring-boot-starter-parent you can then refer to your Maven ‘project properties’ via @..@ placeholders, e.g.

project.artifactId=myproject
project.name=Demo
project.version=X.X.X.X
project.description=Demo project for info endpoint
info.build.artifact=@project.artifactId@
info.build.name=@project.name@
info.build.description=@project.description@
info.build.version=@project.version@

Answer 6

如果您使用mvn包装,如jar或war,请使用:

getClass().getPackage().getImplementationVersion()

它读取归档中生成的META-INF/MANIFEST.MF(设置为pom.xml的版本)的属性"Implementation-Version".

Answer 7

有时，在编写与项目版本相关的脚本时，Maven 命令行就足够了，例如通过 URL 从存储库中检索工件：

mvn help:evaluate -Dexpression=project.version -q -DforceStdout

用法示例：

mvn help:evaluate -Dexpression=project.version -q -DforceStdout

Answer 8

使用 spring boot 时，此链接可能有用：https : //docs.spring.io/spring-boot/docs/2.3.x/reference/html/howto.html#howto-properties-and-configuration

使用 spring-boot-starter-parent，您只需将以下内容添加到您的应用程序配置文件中：

# get values from pom.xml
pom.version=@project.version@

之后，该值可用，如下所示：

@Value("${pom.version}")
private String pomVersion;

Answer 9

使用此库可以轻松实现简单的解决方案.根据需要添加到清单中,然后按字符串查询.

 System.out.println("JAR was created by " + Manifests.read("Created-By"));

http://manifests.jcabi.com/index.html

Answer 10

            <build>
                <finalName>${project.artifactId}-${project.version}</finalName>
                <pluginManagement>
                    <plugins>
                        <plugin>
                            <groupId>org.apache.maven.plugins</groupId>
                            <artifactId>maven-war-plugin</artifactId>
                            <version>3.2.2</version>
                            <configuration>
                                <failOnMissingWebXml>false</failOnMissingWebXml>
                                <archive>
                                    <manifest>
                                        <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                                        <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
                                    </manifest>
                                </archive>
                            </configuration>
                        </plugin>
                     </plugins>
                </pluginManagement>
            </build>

使用获取版本this.getClass().getPackage().getImplementationVersion()

PS别忘了添加：

<manifest>
    <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
    <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
</manifest>