Maven はコンパイル時間とバージョンの Java クラスを生成します

この記事では、Maven プラグインを使用してVersion.javaクラスを自動的に生成します。Java コード内の対応する定数を使用して、現在のバージョン番号とビルド時間を取得できます。

コンパイル後に Maven によって自動的に生成されるファイルの内容はVersion.java次のとおりです。

package com.shanhy.demo;

public final class Version {
    
    
    public static String NUMBER = "0.0.41-SNAPSHOT";
    public static String BUILD_TIME = "2023-08-15 10:54:16";
}

pom.xml でのプラグインの使用例は次のとおりです。

<plugin>
	<groupId>org.codehaus.mojo</groupId>
	<artifactId>build-helper-maven-plugin</artifactId>
	<version>3.4.0</version>
	<executions>
		<execution>
			<id>timestamp-property</id>
			<goals>
				<goal>timestamp-property</goal>
			</goals>
                     <configuration>
                         <name>current.time</name>
                         <pattern>yyyy-MM-dd HH:mm:ss</pattern>
                         <timeZone>GMT+8</timeZone>
                         <locale>zh_CN</locale>
                     </configuration>
		</execution>
	</executions>
</plugin>
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-antrun-plugin</artifactId>
    <version>3.0.0</version>
    <executions>
        <execution>
            <goals>
                <goal>run</goal>
            </goals>
            <phase>generate-sources</phase>
            <configuration>
                <target>
                    <property name="src.dir" value="${project.build.sourceDirectory}"/>
                    <property name="package.dir" value="com/shanhy/demo"/>
                    <property name="package.name" value="com.shanhy.demo"/>
                    <!--maven.build.timestamp是UTC时间，跟北京时间有8个小时的时差，
                        使用插件 build-helper-maven-plugin:timestamp-property 解决这个时差问题-->
                    <!--<property name="buildtime" value="${maven.build.timestamp}"/>-->
                    <property name="buildtime" value="${current.time}"/>

                    <!--生成一个 Version.java 文件，里面生成常量，可以在Java代码中直接使用-->
                    <echo file="${src.dir}/${package.dir}/Version.java"
                          message="package ${package.name};${line.separator}${line.separator}"/>
                    <echo file="${src.dir}/${package.dir}/Version.java" append="true"
                          message="public final class Version {${line.separator}"/>
                    <echo file="${src.dir}/${package.dir}/Version.java" append="true"
                          message="    public static String NUMBER = &quot;${project.version}&quot;;${line.separator}"/>
                    <echo file="${src.dir}/${package.dir}/Version.java" append="true"
                          message="    public static String BUILD_TIME = &quot;${buildtime}&quot;;${line.separator}"/>
                    <echo file="${src.dir}/${package.dir}/Version.java" append="true"
                          message="}${line.separator}"/>
                </target>
            </configuration>
        </execution>
    </executions>
</plugin>

このメソッドを使用して、version.properties などの通常のバージョン構成ファイルを生成することもできます。上記で生成された Java ファイルは、Java コード内の関連ビジネスで定数を直接使用するためのものです。

---

（終わり）