脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → 获取Maven项目的版本号

如何获取Maven项目的版本号

 更新时间：2021年05月22日 16:54:59   作者：码农小胖哥  
最近需要在项目中获取项目的版本号，最笨的方法莫过于硬编码一个版本号，当然之前我也是这么干的。不过闲下来的时候突发奇想Spring Boot项目中pom.xml定义的版本号（也就是project.version的值）能不能通过API获得呢？于是利用摸鱼的时间研究了这种无聊透顶的东西。

目前大多数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项目的版本号的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • spring调度注解@Scheduled方式(含分布式)

    spring调度注解@Scheduled方式(含分布式)

    文章介绍了Java中任务调度的几种常见方法,包括JDK原生的Timer、ScheduledThreadPoolExecutor和Spring的@Scheduled注解,文章还讨论了如何在分布式环境中实现任务调度,并介绍了一些开源的分布式任务调度解决方案,如Quartz和XXL-JOB
    2024-11-11
  • SpringBoot DBUnit 单元测试(小结)

    SpringBoot DBUnit 单元测试(小结)

    这篇文章主要介绍了SpringBoot DBUnit 单元测试(小结)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-09-09
  • java模拟发送form-data的请求方式

    java模拟发送form-data的请求方式

    这篇文章主要介绍了java模拟发送form-data的请求方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-05-05
  • java乐观锁原理与实现案例分析

    java乐观锁原理与实现案例分析

    这篇文章主要介绍了java乐观锁原理与实现,结合具体案例形式分析了乐观锁的原理及java使用乐观锁实现自动派单功能的相关操作技巧,需要的朋友可以参考下
    2019-10-10
  • Java压缩之LZW算法字典压缩与解压讲解

    Java压缩之LZW算法字典压缩与解压讲解

    今天小编就为大家分享一篇关于Java压缩之LZW算法字典压缩与解压讲解，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2019-02-02
  • 我总结的几种@Transactional失效原因说明

    我总结的几种@Transactional失效原因说明

    这篇文章主要是我总结的几种@Transactional失效原因说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-11-11
  • Spring Cloud Stream微服务消息框架原理及实例解析

    Spring Cloud Stream微服务消息框架原理及实例解析

    这篇文章主要介绍了Spring Cloud Stream微服务消息框架原理及实例解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • 详解Java中的final关键字的使用

    详解Java中的final关键字的使用

    这篇文章主要介绍了详解Java中的final关键字的使用,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-07-07
  • Idea安装Eslint插件提示：Plugin NativeScript was not installed的问题

    Idea安装Eslint插件提示：Plugin NativeScript was not installed的问题

    这篇文章主要介绍了Idea安装Eslint插件提示：Plugin NativeScript was not installed的问题,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2020-10-10
  • SpringBoot API接口超时时间的五种配置方式详解

    SpringBoot API接口超时时间的五种配置方式详解

    在开发API接口时,配置API接口的超时时间是一项非常重要的任务,SpringBoot中有多种方式可以配置API接口的超时时间,下面小编就为大家介绍一下吧
    2025-03-03

最新评论