**本文正在参加「Java主题月 - Java Debug笔记活动」，详情查看 [活动链接](https://juejin.cn/post/6960478432744931364/)** 最近需要在项目中获取项目的版本号，最笨的方法莫过于硬编码一个版本号，当然之前我也是这么干的。不过闲下来的时候突发奇想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`这个值好像通过代码能够获得： ```java String version = this.getClass().getPackage().getImplementationVersion() ``` 但是用IDE启动发现`version=null`，不过用`java -jar`运行时`version = 1.0.23`。可能与IDE运行并不是通过`jar`的方式有关。另一个是`pom.properties`，Maven项目编译会生成一个`Properties`配置文件: ```properties artifactId=spring-boot-version groupId=cn.felord version=1.0.23 ``` 这岂不是读取`Properties`文件就可以了？ ```java 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`中的属性注入到指定的资源文件中，具体操作为： ```xml ... src/main/resources true main.properties ... ``` 恰好`spring-boot-starter-parent`中已经设置了这种方式。 ```xml ${basedir}/src/main/resources true **/application*.yml **/application*.yaml **/application*.properties ``` 如果你是`application.properties`,你可以通过下面的方式来接收版本号： ```properties application.version = ${project.version} ``` 如果是`application.yaml`,你可以通过下面的方式来接收版本号： ```yaml application: version: '@project.version@' ``` 然后如何取值就不用多说了吧。这种方式不依赖jar包，使用起来也很简单。 ## Spring Boot提供 Spring Boot其实已经内置了获取项目构建信息的自动配置`ProjectInfoAutoConfiguration`,它包含一个条件Bean`BuildProperties`： ```java @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`提供了不少构建信息： ```java 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`执行下面的命令生成： ```shell mvn spring-boot:build-info ``` 我们只需要配置插件为: ```xml org.springframework.boot spring-boot-maven-plugin build-info ``` 就能使得`BuildProperties`生效，我们可以轻松取得相关的信息： ```json { "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，很可能要涉及到这一方面。如果你知道更好用的获取方法欢迎留言讨论，我来抛砖引玉。