[轉]Maven多模塊結構下版本管理的正確姿勢-revision

轉自: Maven多模塊結構下版本管理的正確姿勢(CI Friendly Versions) - ${revision}

在使用Maven多模塊結構工程時,配置版本是一個比較頭疼的事。繼承版本,依賴版本,自身版本,都需要單獨定義,很是麻煩。但其實Maven已經提供了這種CI版本的管理方式,下面來介紹具體用法。

從Maven 3.5.0-beta-1版本開始,就可以使用{sha1} 和 ${changelist}作爲佔位符來替換pom文件了。

注意:Idea下使用${revision}定義Parent版本時會提示錯誤“Reports that usage of properties in modules parent definition is prohibited”,但並不影響使用,只是Idea不支持這種寫法而已。

單模塊項目

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
</project>

這種情況比較簡單,只使用了${revision}來替換版本。

還可以用另一種動態添加參數的方式來指定版本

$ mvn -Drevision=1.0.0-SNAPSHOT clean package

-D 代表設置環境變量

-D,--define <arg> Define a system property

或者在(父)項目的properties中定義版本:

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
  <properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>
</project>

多模塊項目

現在來看看多模塊構建的情況。有一個父項目和一個或多子模塊。父pom將如下所示:

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
  <properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>
  <modules>
    <module>child1</module>
    ..
  </modules>
</project>

子模塊配置:

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache.maven.ci</groupId>
    <artifactId>ci-parent</artifactId>
    <version>${revision}</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-child</artifactId>
   ...
</project>

多模塊項目中子模塊的版本應該使用父工程的版本,單獨設置版本的話會導致版本混亂。

依賴

多模塊工程結構下,會有很多模塊依賴的情況,應該使用${project.version}來定義依賴(同父工程下的依賴)的版本

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
  <properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>
  <modules>
    <module>child1</module>
    ..
  </modules>
</project>

子工程配置:

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache.maven.ci</groupId>
    <artifactId>ci-parent</artifactId>
    <version>${revision}</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-child</artifactId>
   ...
  <dependencies>
        <dependency>
      <groupId>org.apache.maven.ci</groupId>
      <artifactId>child2</artifactId>
      <version>${project.version}</version>
    </dependency>
  </dependencies>
</project>

定義依賴版本時,使用${revision}會導致構建失敗,需要使用${project.version}。

install/deploy

如果使用以上設置來發布,必須使用flatten-maven-plugin

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
  <properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>

 <build>
  <plugins>
    <plugin>
      <groupId>org.codehaus.mojo</groupId>
      <artifactId>flatten-maven-plugin</artifactId>
      <version>1.1.0</version>
      <configuration>
          <!-- 是否更新pom文件,此處還有更高級的用法 -->
        <updatePomFile>true</updatePomFile>
        <flattenMode>resolveCiFriendliesOnly</flattenMode>
      </configuration>
      <executions>
        <execution>
          <id>flatten</id>
          <phase>process-resources</phase>
          <goals>
            <goal>flatten</goal>
          </goals>
        </execution>
        <execution>
          <id>flatten.clean</id>
          <phase>clean</phase>
          <goals>
            <goal>clean</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
  </build>
  <modules>
    <module>child1</module>
    ..
  </modules>
</project>

最終執行install/deploy後,會將該模塊的pom文件中的${revision}替換爲實際的版本。

install/deploy後會在項目目錄下生成文件:.flattened-pom.xml , 這是替換版本號後的pom.xml文件 , 也是最終打進 jar 包裏的文件 .

參考

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章