如何獲取Maven項目的版本號

Posted on by

目前大多數Spring Boot項目都會打成Jar包，所以什麼War包、Ear包的就先不摸索瞭。

Jar包的秘密

我們先解壓一個Spring Boot應用Jar包看看裡面能不能找到一些蛛絲馬跡。在META-INF文件夾中找到瞭兩個相關的東西，一個是MANIFEST.MF：

Manifest-Version: 1.0
Spring-Boot-Classpath-Index: BOOT-INF/classpath.idx
Implementation-Title: spring-boot-version
Implementation-Version: 1.0.23
Spring-Boot-Layers-Index: BOOT-INF/layers.idx
Start-Class: cn.felord.SpringBootVersionApplication
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Build-Jdk-Spec: 1.8
Spring-Boot-Version: 2.4.5
Created-By: Maven Jar Plugin 3.2.0
Main-Class: org.springframework.boot.loader.JarLauncher

裡面包含瞭我定義的版本號1.0.23，Implementation-Version這個值好像通過代碼能夠獲得：

String version = this.getClass().getPackage().getImplementationVersion()

但是用IDE啟動發現version=null，不過用java -jar運行時version = 1.0.23。可能與IDE運行並不是通過jar的方式有關。

另一個是pom.properties，Maven項目編譯會生成一個Properties配置文件:

artifactId=spring-boot-version
groupId=cn.felord
version=1.0.23

這豈不是讀取Properties文件就可以瞭？

  String path = "META-INF/maven/cn.felord/spring-boot-version/pom.properties";
  ClassPathResource resource = new ClassPathResource(path);

  InputStream inputStream = resource.getInputStream();
  try (InputStreamReader reader = new InputStreamReader(inputStream)) {
      try (BufferedReader bufferedReader = new BufferedReader(reader)) {
          bufferedReader.lines()
                                .forEach(System.out::println);
         }
     } catch (Exception ignored) {

  }

這豈不是讀取Properties文件就可以瞭？

  String path = "META-INF/maven/cn.felord/spring-boot-version/pom.properties";
  ClassPathResource resource = new ClassPathResource(path);

  InputStream inputStream = resource.getInputStream();
  try (InputStreamReader reader = new InputStreamReader(inputStream)) {
      try (BufferedReader bufferedReader = new BufferedReader(reader)) {
          bufferedReader.lines()
                                .forEach(System.out::println);
         }
     } catch (Exception ignored) {

  }

依然隻能從jar讀取，而且比較麻煩。這兩種方式都要依賴jar包，有木有不單純依賴jar包的呢？

Maven資源插件過濾

Maven在構建項目時可以通過資源插件將構建屬性即pom.xml中的屬性註入到指定的資源文件中，具體操作為：

<build>
  ...
  <resources>
    <!-- include main.properties -->
    <resource>
      <directory>src/main/resources</directory>
      <filtering>true</filtering>
      <includes>
        <include>main.properties</include>
      </includes>
    </resource>
  </resources>
  ...
</build>

恰好spring-boot-starter-parent中已經設置瞭這種方式。

      <resource>
        <directory>${basedir}/src/main/resources</directory>
        <filtering>true</filtering>
        <includes>
          <include>**/application*.yml</include>
          <include>**/application*.yaml</include>
          <include>**/application*.properties</include>
        </includes>
      </resource>

如果你是application.properties,你可以通過下面的方式來接收版本號：

application.version = ${project.version}

如果是application.yaml,你可以通過下面的方式來接收版本號：

application:
  version: '@project.version@'

然後如何取值就不用多說瞭吧。這種方式不依賴jar包，使用起來也很簡單。

Spring Boot提供

Spring Boot其實已經內置瞭獲取項目構建信息的自動配置ProjectInfoAutoConfiguration,它包含一個條件BeanBuildProperties：

    @ConditionalOnResource(
        resources = {"${spring.info.build.location:classpath:META-INF/build-info.properties}"}
    )
    @ConditionalOnMissingBean
    @Bean
    public BuildProperties buildProperties() throws Exception {
        return new BuildProperties(this.loadFrom(this.properties
                                                 .getBuild()
                                                 .getLocation(), "build",                                                     this.properties
                                                 .getBuild().getEncoding()));
    }

這個BuildProperties提供瞭不少構建信息：

public class BuildProperties extends InfoProperties {
    public BuildProperties(Properties entries) {
        super(processEntries(entries));
    }

    public String getGroup() {
        return this.get("group");
    }

    public String getArtifact() {
        return this.get("artifact");
    }

    public String getName() {
        return this.get("name");
    }

    public String getVersion() {
        return this.get("version");
    }

    public Instant getTime() {
        return this.getInstant("time");
    }
   }

其中的條件build-info.properties可以通過Spring Boot插件spring-boot-maven-plugin執行下面的命令生成：

mvn spring-boot:build-info

我們隻需要配置插件為:

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

就能使得BuildProperties生效，我們可以輕松取得相關的信息：

{
  "version" : "1.0.23",
  "group" : "cn.felord",
  "artifact" : "spring-boot-version",
  "name" : "spring-boot-version",
  "time" : {
    "epochSecond" : 1620664643,
    "nano" : 591000000
  }
}

總結

今天介紹瞭幾種從通過API獲取項目構建版本信息的方法，有什麼用呢？主要用於項目監控，發版審計，DevOps等領域，包括Spring Boot的自定義banner。如果你的項目涉及到CI/CD，很可能要涉及到這一方面。 如果你知道更好用的獲取方法歡迎留言討論，我來拋磚引玉。

以上就是如何獲取Maven項目的版本號的詳細內容，更多關於獲取Maven項目的版本號的資料請關註WalkonNet其它相關文章！

推薦閱讀：