Maven多模块结构下版本管理的正确姿势(CI Friendly Versions) - ${revision}

在使用Maven多模块结构工程时，配置版本是一个比较头疼的事。继承版本，依赖版本，自身版本，都需要单独定义，很是麻烦。但其实Maven已经提供了这种CI版本的管理方式，下面来介绍具体用法。

从Maven 3.5.0-beta-1版本开始，就可以使用${revision}, ${sha1} 和 ${changelist}作为占位符来替换pom文件了。

注意：Idea下使用${revision}定义Parent版本时会提示错误“Reports that usage of properties in modules parent definition is prohibited”，但并不影响使用，只是Idea不支持这种写法而已。

单模块项目

  4.0.0
  
    org.apache
    apache
    18
  
  org.apache.maven.ci
  ci-parent
  First CI Friendly
  ${revision}
  ...

这种情况比较简单，只使用了${revision}来替换版本。

还可以用另一种动态添加参数的方式来指定版本

$ mvn -Drevision=1.0.0-SNAPSHOT clean package

-D代表设置环境变量

 -D,--define                       Define a system property

或者在(父)项目的properties中定义版本：

  4.0.0
  
    org.apache
    apache
    18
  
  org.apache.maven.ci
  ci-parent
  First CI Friendly
  ${revision}
  ...
  
    1.0.0-SNAPSHOT
  

多模块项目

现在来看看多模块构建的情况。有一个父项目和一个或多子模块。父pom将如下所示：

  4.0.0
  
    org.apache
    apache
    18
  
  org.apache.maven.ci
  ci-parent
  First CI Friendly
  ${revision}
  ...
  
    1.0.0-SNAPSHOT
  
  
    child1
    ..
  

子模块配置：

  4.0.0
  
    org.apache.maven.ci
    ci-parent
    ${revision}
  
  org.apache.maven.ci
  ci-child
   ...

多模块项目中子模块的版本应该使用父工程的版本，单独设置版本的话会导致版本混乱。

依赖

多模块工程结构下，会有很多模块依赖的情况，应该使用${project.version}来定义依赖（同父工程下的依赖）的版本

  4.0.0
  
    org.apache
    apache
    18
  
  org.apache.maven.ci
  ci-parent
  First CI Friendly
  ${revision}
  ...
  
    1.0.0-SNAPSHOT
  
  
    child1
    ..
  

子工程配置：

  4.0.0
  
    org.apache.maven.ci
    ci-parent
    ${revision}
  
  org.apache.maven.ci
  ci-child
   ...
  
        
      org.apache.maven.ci
      child2
      ${project.version}
    
  

定义依赖版本时，使用${revision}会导致构建失败，需要使用${project.version}。

install/deploy

如果使用以上设置来发布，必须使用flatten-maven-plugin

  4.0.0
  
    org.apache
    apache
    18
  
  org.apache.maven.ci
  ci-parent
  First CI Friendly
  ${revision}
  ...
  
    1.0.0-SNAPSHOT
  

 
  
    
      org.codehaus.mojo
      flatten-maven-plugin
      1.1.0
      
          是否更新pom文件，此处还有更高级的用法
        true
        resolveCiFriendliesOnly
      
      
        
          flatten
          process-resources
          
            flatten
          
        
        
          flatten.clean
          clean
          
            clean
          
        
      
    
  
  
  
    child1
    ..
  

最终执行install/deploy后，会将该模块的pom文件中的${revision}替换为实际的版本。

参考

https://maven.apache.org/maven-ci-friendly.html
https://github.com/spring-projects/spring-boot
https://www.mojohaus.org/flatten-maven-plugin/