yeskery

Maven 读取程序版本号的三种方案

方案1

在应用项目中,如果应用程序需要获取当前程序的版本号,可以读取 /META-INF/maven/${groupId}/${artifactId}/pom.properties ,获取 maven 生成的版本信息。当然前提用应用程序在运行时得知道自己的 groupIdartifactId,否则无法定位路径。

pom.properties 内容示例

  1. #Created by Apache Maven .5.0
  2. version=1.0.4-SNAPSHOT
  3. groupId=com.gitee.l0km
  4. artifactId=facelog-service

这种方法很简单,但也有缺点:

貌似这种方法只能获取 maven 默认定义 ${project.version},无法加入自定义的信息。

方案2

还有一个方案就是直接将版本信息写入 MANIFEST.MF。通过 java.util.jar.Manifest 来读取解析MANIFEST.MF来获取版本号。 如下增加 buildnumber-maven-plugin 插件,并给 maven-jar-plugin 插件指定写入 MANIFEST.MF 的参数。

  1. <plugin>
  2. <groupId>org.codehaus.mojo</groupId>
  3. <artifactId>buildnumber-maven-plugin</artifactId>
  4. <version>1.2</version>
  5. <executions>
  6. <execution>
  7. <goals>
  8. <goal>create</goal>
  9. </goals>
  10. </execution>
  11. </executions>
  12. </plugin>
  13. <plugin>
  14. <groupId>org.apache.maven.plugins</groupId>
  15. <artifactId>maven-jar-plugin</artifactId>
  16. <version>3.0.2</version>
  17. <configuration>
  18. <archive>
  19. <manifestEntries>
  20. <!-- 项目版本号 -->
  21. <Project-Version>${project.version}</Project-Version>
  22. <!-- buildnumber插件提供的 SCM(git/svn等)版本号 -->
  23. <Scm-Version>${buildNumber}</Scm-Version>
  24. <!-- 时间戳 -->
  25. <Timestamp>${maven.build.timestamp}</Timestamp>
  26. </manifestEntries>
  27. </archive>
  28. </configuration>
  29. </plugin>

方案3

前面两种方案,都需要将应用程序打成jar包才能读取版本信息。

那么程序在开发调试的时候,并没有生成 pom.properties,和 MANIFEST.MF,也就无法读取版本信息了。

所以另一种思路就是用 template-maven-plugin 插件让 maven 自动生成一个包含版本信息的代码如 Version.java。这样任何时候,程序都能很方便的知道自己的版本号了。

模板

首先需要一个代码模板 Version.java,示例如下:

  1. package net.gdface.facelog.service;
  2. public final class Version {
  3. /** project version */
  4. public static final String VERSION = "${project.version}";
  5. /** SCM(git) revision */
  6. public static final String SCM_REVISION= "${buildNumber}";
  7. /** SCM branch */
  8. public static final String SCM_BRANCH = "${scmBranch}";
  9. /** build timestamp */
  10. public static final String TIMESTAMP ="${buildtimestamp}";
  11. }

模板放在 /src/main/java-templates/${package_of_template}/

原本在模板文件中用maven内置变量 ${maven.build.timestamp} 做时间戳,实际运行并没有被正确替换,不知道原因。所以改为使用 buildnumber-maven-plugin 插件 (goal create-timestamp)生成的时间戳 ${buildtimestamp}

插件

然后修改 pom.xml 增加 template-maven-plugin 插件和 buildnumber-maven-plugin 插件

  1. <plugin>
  2. <groupId>org.codehaus.mojo</groupId>
  3. <artifactId>buildnumber-maven-plugin</artifactId>
  4. <version>1.4</version>
  5. <executions>
  6. <execution>
  7. <id>bn1</id>
  8. <goals>
  9. <!-- 创建${buildNumber} -->
  10. <goal>create</goal>
  11. </goals>
  12. </execution>
  13. <execution>
  14. <id>bn2</id>
  15. <goals>
  16. <!-- 创建时间戳${buildtimestamp} -->
  17. <goal>create-timestamp</goal>
  18. </goals>
  19. <configuration>
  20. <!-- 指定时间戳变量名 -->
  21. <timestampPropertyName>buildtimestamp</timestampPropertyName>
  22. <!-- 指定日期格式 -->
  23. <timestampFormat>yyyy-MM-dd HH:mm:ss</timestampFormat>
  24. </configuration>
  25. </execution>
  26. </executions>
  27. </plugin>
  28. <plugin>
  29. <groupId>org.codehaus.mojo</groupId>
  30. <artifactId>templating-maven-plugin</artifactId>
  31. <version>1.0.0</version>
  32. <executions>
  33. <execution>
  34. <id>filter-src</id>
  35. <goals>
  36. <goal>filter-sources</goal>
  37. </goals>
  38. </execution>
  39. </executions>
  40. </plugin>

template-maven-plugin 插件会将 /src/main/java-templates/ 文件夹下的所有模板中的 ${xxx} 占位符都用 maven 中同名的变量替换一遍,生成的 Version.java${project.build.directory}/generated-sources/${package_of_template} 下,并且该文件夹会自动成为源码文件夹加入编译过程。

Spring Boot 获取版本号

application.properties 中添加:version=@project.version@

注意值部分为 @project.version@, 而非 ${project.version} 占位符,主要是为了避免与 Spring 语法冲突,配置好之后,可以通过 @Value 注解的方式直接获取。

  1. @Value("${version}")
  2. private String version;

也可以 Properties 代码加载

  1. final Properties properties = new Properties();
  2. properties.load(this.getClass().getClassLoader().getResourceAsStream("application.properties"));
  3. return properties.getProperty("version");

参考资料

  1. 《Generate a Version.java file in Maven》
  2. http://www.mojohaus.org/templating-maven-plugin/filter-sources-mojo.html

本文内容来自:

  1. https://blog.csdn.net/10km/article/details/79013499
  2. https://blog.csdn.net/kangkanglou/article/details/78585997

评论

发表评论 点击刷新验证码

提示

该功能暂未开放