Maven打包使用代码版本号和时间戳


为了显示区分部署代码版本，一般会在打包的时候带上SVN/Git版本号，如果是多机房部署的，还需要带上机房标签。

若代码发布在Git仓库，可以使用maven插件git-commit-id-plugin。
该插件会产生一个git.properties文件，并被包含进最终的jar文件中。
简单配置如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<plugin>
       <groupId>pl.project13.maven</groupId>
       <artifactId>git-commit-id-plugin</artifactId>
       <version>2.2.4</version>
       <executions>
           <execution>
               <goals>
                   <goal>revision</goal>
               </goals>
           </execution>
       </executions>
       <configuration>
           <!-- 使properties扩展到整个maven bulid 周期
           Ref: https://github.com/ktoso/maven-git-commit-id-plugin/issues/280 -->
           <injectAllReactorProjects>true</injectAllReactorProjects>
           <!--日期格式;默认值:dd.MM.yyyy '@' HH:mm:ss z;-->
           <dateFormat>yyyyMMddHHmmss</dateFormat>
           <!--,构建过程中,是否打印详细信息;默认值:false;-->
           <verbose>true</verbose>
           <!--是否生成"git.properties"文件;默认值:false;-->
           <generateGitPropertiesFile>true</generateGitPropertiesFile>
           <!-- ".git"文件路径;默认值:${project.basedir}/.git; ..表示上一级-->
           <dotGitDirectory>${project.basedir}/../.git</dotGitDirectory>
           <gitDescribe>
               <!--提交操作ID显式字符长度,最大值为:40;默认值:7;0代表特殊意义;-->
               <abbrev>7</abbrev>
               <!--构建触发时,代码有修改时(即"dirty state"),添加指定后缀;默认值:"";-->
               <dirty>-dirty</dirty>
           </gitDescribe>
       </configuration>
   </plugin>

项目module可以配置打包的finalName如下：

1
2
3
<finalName>
	project-module-${dc}-${git.commit.id.abbrev}-${git.build.time}
</finalName>

其中git.commit.id.abbre是提交Git仓库时的版本号缩写，git.build.time顾名思义是打包时间。

对应的maven打包命令如下：

1
mvn clean package -Dmaven.test.skip=true -Ddc=$dc -P $dc

若有多机房信息，为方便配置，一般会将profile配置成机房编码，这样上面的机房dc参数和项目profile参数即可以共享同一个参数值。

打包时间还可以通过另外一个maven插件build-helper-maven-plugin读取。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<plugin>
      <groupId>org.codehaus.mojo</groupId>
      <artifactId>build-helper-maven-plugin</artifactId>
      <version>3.0.0</version>
      <executions>
          <execution>
              <id>timestamp-property</id>
              <goals>
                  <goal>timestamp-property</goal>
              </goals>
          </execution>
      </executions>
      <configuration>
          <name>current.time</name>
          <pattern>yyyyMMddHHmmss</pattern>
          <timeZone>GMT+8</timeZone>
      </configuration>
  </plugin>

上述current.time字段值即是打包时间，可以被pom文件引用。