如何獲取Maven項目的版本號
目前大多數(shù)Spring Boot項目都會打成Jar包,所以什么War包、Ear包的就先不摸索了。
Jar包的秘密
我們先解壓一個Spring Boot應(yīng)用Jar包看看里面能不能找到一些蛛絲馬跡。在META-INF文件夾中找到了兩個相關(guān)的東西,一個是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啟動發(fā)現(xiàn)version=null,不過用java -jar運行時version = 1.0.23??赡芘cIDE運行并不是通過jar的方式有關(guān)。
另一個是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在構(gòu)建項目時可以通過資源插件將構(gòu)建屬性即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中已經(jīng)設(shè)置了這種方式。
<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其實已經(jīng)內(nèi)置了獲取項目構(gòu)建信息的自動配置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提供了不少構(gòu)建信息:
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執(zhí)行下面的命令生成:
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生效,我們可以輕松取得相關(guān)的信息:
{ "version" : "1.0.23", "group" : "cn.felord", "artifact" : "spring-boot-version", "name" : "spring-boot-version", "time" : { "epochSecond" : 1620664643, "nano" : 591000000 } }
總結(jié)
今天介紹了幾種從通過API獲取項目構(gòu)建版本信息的方法,有什么用呢?主要用于項目監(jiān)控,發(fā)版審計,DevOps等領(lǐng)域,包括Spring Boot的自定義banner。如果你的項目涉及到CI/CD,很可能要涉及到這一方面。 如果你知道更好用的獲取方法歡迎留言討論,我來拋磚引玉。
以上就是如何獲取Maven項目的版本號的詳細內(nèi)容,更多關(guān)于獲取Maven項目的版本號的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
SpringBoot使用異步線程池實現(xiàn)生產(chǎn)環(huán)境批量數(shù)據(jù)推送
本文主要介紹了SpringBoot使用異步線程池實現(xiàn)生產(chǎn)環(huán)境批量數(shù)據(jù)推送,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-02-02Java網(wǎng)絡(luò)編程UDP實現(xiàn)消息發(fā)送及聊天
這篇文章主要為大家詳細介紹了Java網(wǎng)絡(luò)編程UDP實現(xiàn)消息發(fā)送及聊天,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2021-07-07Java kafka如何實現(xiàn)自定義分區(qū)類和攔截器
這篇文章主要介紹了Java kafka如何實現(xiàn)自定義分區(qū)類和攔截器,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-06-06