原 荐 介绍一个 Java 程序运行时版本信

1. 介绍

作为应用程序尤其是框架和库的作者,常常需要了解运行程序的版本:

  1. 作为 bug 报告的关键信息
  2. 在应用启动的时候打印版本带来更加清晰的信息展示

例如下面是一个ActFramework应用项目启动时的 Banner:

针对这样的需求,我开发了一个小小的工具 (9K jar 包) 来帮助大家轻松方便地管理和访问应用/库/框架在运行时的版本信息.

2. 安装

该工具已经发行到了 maven 中央库, 可以在你的 pom 文件中加入一下依赖:

<dependency>
  <groupId>org.osgl</groupId>
  <artifactId>osgl-bootstrap</artifactId>
  <version>${osgl-bootstrap.version}</version>
</dependency>

3. 准备应用/库的版本信息

作为应用/库的开发者,你需要将软件的版本信息按照下面的方式加入到项目当中:

假设你的产品的包名是 `org.mrcool.swissknife`,你需要将一个名为 .version 的文件存放在 src/resources/org/mrcool/swissknife 目录里, 文件的内容大致如下:

# artifact is optional, if not provided the package name will be used
artifact=<delivery-name>

# version is mandatory, if not provided then UNKNOWN version will be returned
version=<the project version>

# build number is optional, if not provided then empty string will be used
build=<SCM build number, e.g. git hash>

因为不想每次发布新版都手工编辑这个文件,我们可以利用 maven 的资源过滤功能, 将上面的文件定义为一下内容:

artifact=${project.artifactId}
version=${project.version}
## build number is optional
build=${buildNumber}

同时在 pom 文件里面加上资源过滤插件:

<resources>
  <resource>
    <directory>src/main/resources</directory>
    <filtering>true</filtering>
    <includes>
      <include>**/.version</include>
    </includes>
   </resource>
</resources>

另外如果需要上面的 buildNumber 的话,还需要加上 buildnumber maven plugin 插件:

<plugin>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>buildnumber-maven-plugin</artifactId>
  <version>${buildnumber-maven-plugin.version}</version>
  <executions>
    <execution>
      <phase>validate</phase>
      <goals>
        <goal>create</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <shortRevisionLength>4</shortRevisionLength>
  </configuration>
</plugin>

这样就可以了.只要运行 mvn package,生成出来的 jar 文件里会包含足够的版本信息.

4. 在运行时访问版本信息

假如某个库已经按照上面的方式加入版本信息到 jar 文件当中了,使用库的应用可以利用 osgl-bootstrap 里面的 Version 类来访问该库的版本, 如下面代码所示:

Version version1 = Version.of(org.mrcool.swissknife.SwissKnife.class);
System.out.println(version1.getPackage()); // print `org.mrcool.swissknife`
System.out.println(version1.getArtifactId()); // print `swissknife`
System.out.println(version1.getProjectVersion()); // print `1.0`
System.out.println(version1.getBuildNumber()); // print `ebf1`
System.out.println(version1.getVersion()); // print `r1.0-ebf1`
System.out.println(version1); // print `swissknife-r1.0-ebf1`

// Another method to get Version info
Version version2 = Version.of("org.mrcool.swissknife.db");

// If a certain library's version is SNAPSHOT, e.g. 1.0-SNAPSHOT, 
// then the version tag is decorated with `v` instead of `r`:
System.out.println(version2.getProjectVersion()); // print `1.0-SNAPSHOT`
System.out.println(version2.getBuildNumber()); // print `51b9`
System.out.println(version2.getVersion()); // print `v1.0-SNAPSHOT-51b9`
System.out.println(version2); // print `swissknife-v1.0-SNAPSHOT-ebf1`

如果访问到的库正好没有版本信息也不会出打错, Version 会返回一个 Unknown 版本实例给调用方.

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Hadoop实操

3.如何实现OpenLDAP的主主同步

前面Fayson文章讲《1.如何在CentOS6.5安装OpenLDAP并配置客户端》以及《2.OpenLDAP集成SSH登录并使用SSSD同步用户》,那么如何...

3835
来自专栏JavaWeb

原 Spring Boot-使用Sprin

1554
来自专栏精讲JAVA

使用 JITWatch 查看 JVM 的 JIT 编译代码

我们知道Java代码通过编译器编译成字节码,一般是class文件,有JVM的各个类加载器加载后,根据JVM的启动配置可以进行解释执行和编译执行,编译执行是由JI...

1052
来自专栏肖蕾的博客

分析一次自动登录引起的风波,并提供对Cookie的处理方式

986
来自专栏一英里广度一英寸深度的学习

Hello,Java女神

第一阶段:C++转行,开始学习Java 第二阶段:Java Web,jsp+servlet 第三阶段:Struct Spring 第四阶段:Spring ...

1035
来自专栏漫漫全栈路

Windows下JavaWeb环境的安装笔记

写在前面:专升本报道开课,这个学期的课程中开了JavaWeb和Oracle数据库,作为软狗虽然一百个不愿意,但是学习为重嘛。Oracle数据库之前在吉奥实习的...

2715
来自专栏主机笔记

软件给win10快速断网

在使用电脑中一些特殊的情况下,需要我们断开网络,一般情况下就是把无线网断开或者网线拔掉就可以了,但是有时候主机的位置很小拔网线不是很方便这时候就需要用windo...

2468
来自专栏james大数据架构

idea启动多个tomcat失败

Intellij idea中,为在本地调试两个系统之间的调用,配置两个本地tomcat server,设置不同的端口号,如8081和8082,Deploy中加入...

1925
来自专栏Java学习网

Android中App安装位置详解

Android中App安装位置详解 Android应用可以安装在本机自带存储,同时也可以安装到外部存储(SD卡)。自从API 8后也就是Android2.2后...

2329
来自专栏云原生架构实践

JHipster生成微服务架构的应用栈(四)- 网关微服务示例

默认端口号是8080,也可以自己输入端口号,注意不要和别的微服务和进程的端口号冲突。

1242

扫码关注云+社区