maven:讀取程序版本號的三種方案

方案1
在應用項目中，如果應用程序需要獲取當前程序的版本號，可以讀取”/META-INF/maven/${groupId}/${artifactId}/pom.properties“,獲取maven生成的版本信息。 
當然前提用應用程序在運行時得知道自己的groupId和artifactId，否則無法定位路徑。

pom.properties內容示例

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

這種方法很簡單，但也有缺點： 
貌似這種方法只能獲取maven默認定義${project.version}，無法加入自定義的信息。

方案2
還有一個方案就是直接將版本信息寫入MANIFEST.MF。通過java.util.jar.Manifest來讀取解析MANIFEST.MF來獲取版本號。 
如下增加buildnumber-maven-plugin插件，並給maven-jar-plugin插件指定寫入MANIFEST.MF的參數。

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>buildnumber-maven-plugin</artifactId>
    <version>1.2</version>
    <executions>
        <execution>
            <goals>
                <goal>create</goal>
            </goals>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.0.2</version>
    <configuration>
        <archive>
            <manifestEntries>
                <!-- 項目版本號 -->
                <Project-Version>${project.version}</Project-Version>
                <!-- buildnumber插件提供的 SCM(git/svn等)版本號 -->
                <Scm-Version>${buildNumber}</Scm-Version>
                <!-- 時間戳 -->
                <Timestamp>${maven.build.timestamp}</Timestamp>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

方案3
前面兩種方案，都需要將應用程序打成jar包才能讀取版本信息。 
那么程序在開發調試的時候，並沒有生成pom.properties,和MANIFEST.MF,也就無法讀取版本信息了。 
所以另一種思路就是用 template-maven-plugin插件讓maven自動生成一個包含版本信息的代碼如Version.java。這樣任何時候，程序都能很方便的知道自己的版本號了。

模板
首先需要一個代碼模板Version.java，示例如下：

package net.gdface.facelog.service;
public final class Version {
    /** project version */
    public static final String VERSION = "${project.version}";
    /** SCM(git) revision */
    public static final String SCM_REVISION= "${buildNumber}";
    /** SCM branch */
    public static final String SCM_BRANCH = "${scmBranch}";
    /** build timestamp */
    public static final String TIMESTAMP ="${buildtimestamp}";
}

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

原本在模板文件中用maven內置變量${maven.build.timestamp}做時間戳，實際運行並沒有被正確替換，不知道原因。所以改為使用buildnumber-maven-plugin插件(goal create-timestamp)生成的時間戳${buildtimestamp}

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

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>buildnumber-maven-plugin</artifactId>
    <version>1.4</version>
    <executions>
        <execution>
            <id>bn1</id>
            <goals>
                <!-- 創建${buildNumber} -->
                <goal>create</goal>
            </goals>
        </execution>
        <execution>
            <id>bn2</id>
            <goals>
                <!-- 創建時間戳${buildtimestamp} -->
                <goal>create-timestamp</goal>
            </goals>
            <configuration>
                <!-- 指定時間戳變量名 -->
                <timestampPropertyName>buildtimestamp</timestampPropertyName>
                <!-- 指定日期格式 -->
                <timestampFormat>yyyy-MM-dd HH:mm:ss</timestampFormat>
            </configuration>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>templating-maven-plugin</artifactId>
    <version>1.0.0</version>
    <executions>
        <execution>
            <id>filter-src</id>
            <goals>
                <goal>filter-sources</goal>
            </goals>
        </execution>
    </executions>
</plugin>

template-maven-plugin插件會將/src/main/java/java-templates/文件夾下的所有模板中的${xxx}占位符都用maven中同名的變量替換一遍， 
生成的Version.java在${project.build.directory}/generated-sources/${package_of_template}下，並且該文件夾會自動成為源碼文件夾加入編譯過程。

參考資料
《Generate a Version.java file in Maven》