`
dannyhz
  • 浏览: 395238 次
  • 性别: Icon_minigender_1
  • 来自: 杭州
文章分类
社区版块
存档分类
最新评论

maven的最佳实践 - 版本管理

 
阅读更多
引用




http://blog.csdn.net/shirley_john_thomas/article/details/52598308




什么是版本管理
        首先,这里说的版本管理(version management)不是指版本控制(version control),但是本文假设你拥有基本的版本控制的知识,了解subversion的基本用法。版本
管理中说得版本是指构件(artifact)的版本,而非源码的版本(如subversion中常见的rXXX,或者git中一次提交都有个sha1的commit号)。
        比如我有一个项目,其artifactId为myapp,随着项目的进展,我们会生成这样一些jar:myapp-1.0-SNAPSHOT.jar,myapp-1.0.jar,myapp-1.1-SNAPSHOT.jar,
myapp-1.0.1.jar等等。你可能会说,这很简单啊,我在POM中改个version,mvn clean install不就完了?但这只是表面,本文我将讲述,snapshot和release版本的区别,如何
自动化版本发布(如果你的项目有几十个module,你就会觉得手工改POM来升级版本是很痛苦的事情),结合自动化发布的过程,这里还会介绍maven-release-plugin。此
外,一些scm概念也会被涉及到,比如tag和branch。
前提:版本控制
        不管怎样,我们都需要建立一个项目并提交到SCM中,这里我以subversion为例。你得有一个配置好的subversion repository,这里我建立了一个空的svn仓库,其地址
为:https://192.168.1.100:8443/svn/myapp/ 现在,该目录下只有三个空的典型的子目录:/trunk/, branches/, tags/。分别用来存放主干,分支,以及标签。
接着将项目导入到svn仓库中,到项目根目录,运行如下命令:
[java] view plaincopy
svn import -m 'project initialization' https://192.168.1.100:8443/svn/myapp/trunk  

(注意,这么做你会将目录下所有文件导入到svn库中,但是这其中某些目录和文件是不应该被导入的,如/target目录,以及eclipse相关的项目文件)
目前,我们将项目的版本设置为1.0-SNAPSHOT。
为什么用SNAPSHOT?
        我先说说如果没有SNAPSHOT会是什么样子。假设你的项目有2个模块,A,B,其中A依赖B。这三个模块分别由甲,乙两个个人负责开发。在开发过程中,因为A是依赖于B
的,因此乙每次做一个改动都会影响到甲,于是,乙提交了一些更改后,需要让甲看到。这个时候,怎么做呢?乙对甲说,“你签出我的代码,build一下就OK了”,甲有点不情
愿,但还是照做了,签出代码,svn clean install,然后,发现build出错了,有个测试没有pass。甲郁闷了,对乙说,“你的代码根本不能用,我不想build,你build好了给我”,
乙看了看确实自己的代码build不过,于是回去解决了,然后打了个jar包,扔给甲,甲对了对groupId,artifactId,放到了自己的.m2/repository/目录下,OK,能用了。
于是乙每次更新都这样做,打包,复制,然后甲粘贴,使用……渐渐的,大家发现这是个很笨的办法,这是纯手工劳动阿,程序员最BS的就是重复劳动。一天,甲对乙说,“你
知道nexus么?你把你的jar发布到nexus上就可以了,我要用就自动去下载,这多棒!”乙说“哦?有这好东西,我去看看”于是乙发现了nexus这块新大陆,并成功的发布了B到
nexus上。(见,Nexus入门指南,(图文))。
        但是,请注意,我们这里的一切都假设没有SNAPSHOT,因此如果乙不更改版本,甲下载一次如B-1.0.jar之后,maven认为它已经有了正确的B的版本,就不会再重新下
载。甲发现了这个问题,对乙说“你的更新我看不到,你更新了么?”乙说“不可能!我看看”,于是检查一下甲下载的C-1.0.jar,发现那是几天前的。乙一拍脑袋,说“这简单,我
更新一下我的版本就好了,我发布个B-1.1.jar上去,你更新下依赖版本”,甲照做了,似乎这么做是可行的。
        这里有一个问题,一次提交就更新一个版本,这明显不是正确的管理办法,此外,乙得不停的通知甲更新对B的依赖版本,累不累阿?1.0,或者说1.1,2.0,都代表了稳
定,这样随随便便的改版本,能稳定么?
        所以Maven有SNAPSHOT版本的概念,它与release版本对应,后者是指1.0,1.1,2.0这样稳定的发布版本。
现在乙可以将B的版本设置成1.0-SNAPSHOT,每次更改后,都mvn deploy到nexus中,每次deploy,maven都会将SNAPSHOT改成一个当前时间的timestamp,比如B-1.0-
SNAPSHOT.jar到nexus中后,会成为这个样子:B-1.0-20081017-020325-13.jar。Maven在处理A中对于B的SNAPSHOT依赖时,会根据这样的timestamp下载最新的jar,默
认Maven每天更新一次,如果你想让Maven强制更新,可以使用-U参数,如:
[java] view plaincopy
mvn clean install -U 

现在事情简化成了这个样子:乙做更改,然后mvn deploy,甲用最简单的maven命令就能得到最新的B。
从1.0-SNAPSHOT到1.0到1.1-SNAPSHOT
SNAPSHOT是快照的意思,项目到一个阶段后,就需要发布一个正式的版本(release版本)。一次正式的发布需要这样一些工作:
在trunk中,更新pom版本从1.0-SNAPSHOT到1.0
对1.0打一个svn tag
针对tag进行mvn deploy,发布正式版本
更新trunk从1.0到1.1-SNAPSHOT
你可以手工一步步的做这些事情,无非就是一些svn操作,一些pom编辑,还有一些mvn操作。但是你应该明白,手工做这些事情,一来繁琐,而来容易出错。因此这里我介绍使用maven插件来自动化这一系列动作。
SCM
首先我们需要在POM中加入scm信息,这样Maven才能够替你完成svn操作,这里我的配置如下:
[java] view plaincopy
<scm>   
  <connection>scm:svn:http://192.168.1.100:8443/svn/myapp/trunk/</connection>   
  <developerConnection>scm:svn:https://192.168.1.100:8443/svn/myapp/trunk/</developerConnection>   
</scm>   

需要注意的是,很多windows使用的tortoiseSVN客户端,而没有svn命令行客户端,这会导致Maven所有svn相关的工作失败,因此,你首先确保svn --version能够运行。
分发仓库
想要让Maven帮我们自动发布,首先我们需要配置好分发仓库。关于这一点,见Maven最佳实践:Maven仓库——分发构件至远程仓库。
maven-release-plugin
紧接着,我们需要配置maven-release-plugin,这个插件会帮助我们升级pom版本,提交,打tag,然后再升级版本,再提交,等等。基本配置如下:
[java] view plaincopy
<plugin>   
  <groupId>org.apache.maven.plugins</groupId>   
  <artifactId>maven-release-plugin</artifactId>   
  <version>2.0-beta-7</version>   
  <configuration>   
    <tagBase>https://192.168.1.100:8443/svn/myapp/tags/</tagBase>   
  </configuration>   
</plugin>   
GAV我就不多解释了,这里我们需要注意的是configuration元素下的tagBase元素,它代表了我们svn中的tag目录,也就是说,maven-release-plugin帮我们打tag的时候,其基
础目录是什么。这里,我填写了svn仓库中的标准的tags目录。
提交代码
接着,确保你的所有代码都提交了,如果你有未提交代码,release插件会报错,既然你要发布版本了,就表示代码是稳定的,所以要么要么把代码提交了,要么把本地的更改
抛弃了。
开始工作
现在,屏住呼吸,执行:
[java] view plaincopy
mvn release:prepare 

执行过程中,你会遇到这样的提示:
What is the release version for "Unnamed - org.myorg:myapp:jar:1.0-SNAPSHOT"? (org.myorg:myapp) 1.0: :
——“你想将1.0-SNAPSHOT发布为什么版本?默认是1.0。”我要的就是1.0,直接回车。
What is SCM release tag or label for "Unnamed - org.myorg:myapp:jar:1.0-SNAPSHOT"? (org.myorg:myapp) myapp-1.0: :
——“发布的tag标签名称是什么?默认为myapp-1.0。”我还是要默认值,直接回车。
What is the new development version for "Unnamed - org.myorg:myapp:jar:1.0-SNAPSHOT"? (org.myorg:myapp) 1.1-SNAPSHOT: :
——“主干上新的版本是什么?默认为1.1-SNAPSHOT。”哈,release插件会自动帮我更新版本到1.1-SNAPSHOT,很好,直接回车。
然后屏幕刷阿刷,maven在build我们的项目,并进行了一些svn操作,你可以仔细查看下日志。
那么结果是什么呢?你可以浏览下svn仓库:
我们多了一个tag:https://192.168.1.100:8443/svn/myapp/tags/myapp-1.0/,这就是需要发布的版本1.0。
再看看trunk中的POM,其版本自动升级成了1.1-SNAPSHOT。
这不正是我们想要的么?等等,好像缺了点什么,对了,1.0还没有发布到仓库中呢。
再一次屏住呼吸,执行:
[java] view plaincopy
mvn release:perform 

maven-release-plugin会自动帮我们签出刚才打的tag,然后打包,分发到远程Maven仓库中,至此,整个版本的升级,打标签,发布等工作全部完成。我们可以在远程Maven
仓库中看到正式发布的1.0版本。

这可是自动化的 ,正式的 版本发布!
Maven的版本规则
前面我们提到了SNAPSHOT和Release版本的区别,现在看一下,为什么要有1.0,1.1,1.1.1这样的版本,这里的规则是什么。
Maven主要是这样定义版本规则的:
[java] view plaincopy
<主版本>.<次版本>.<增量版本> 

比如说1.2.3,主版本是1,次版本是2,增量版本是3。
主版本一般来说代表了项目的重大的架构变更,比如说Maven 1和Maven 2,在架构上已经两样了,将来的Maven 3和Maven 2也会有很大的变化。次版本一般代表了一些功能的
增加或变化,但没有架构的变化,比如说Nexus 1.3较之于Nexus 1.2来说,增加了一系列新的或者改进的功能(仓库镜像支持,改进的仓库管理界面等等),但从大的架构上
来说,1.3和1.2没什么区别。至于增量版本,一般是一些小的bug fix,不会有重大的功能变化。
一般来说,在我们发布一次重要的版本之后,随之会开发新的版本,比如说,myapp-1.1发布之后,就着手开发myapp-1.2了。由于myapp-1.2有新的主要功能的添加和变化,
在发布测试前,它会变得不稳定,而myapp-1.1是一个比较稳定的版本,现在的问题是,我们在myapp-1.1中发现了一些bug(当然在1.2中也存在),为了能够在段时间内修复
bug并仍然发布稳定的版本,我们就会用到分支(branch),我们基于1.1开启一个分支1.1.1,在这个分支中修复bug,并快速发布。这既保证了版本的稳定,也能够使bug得到
快速修复,也不同停止1.2的开发。只是,每次修复分支1.1.1中的bug后,需要merge代码到1.2(主干)中。
上面讲的就是我们为什么要用增量版本。
实战分支
目前我们trunk的版本是1.1-SNAPSHOT,其实按照前面解释的版本规则,应该是1.1.0-SNAPSHOT。
现在我们想要发布1.1.0,然后将主干升级为1.2.0-SNAPSHOT,同时开启一个1.1.x的分支,用来修复1.1.0中的bug。
首先,在发布1.1.0之前,我们创建1.1.x分支,运行如下命令:

[java] view plaincopy
mvn release:branch -DbranchName=1.1.x -DupdateBranchVersions=true -DupdateWorkingCopyVersions=false 
这是maven-release-plugin的branch目标,我们指定branch的名称为1.1.x,表示这里会有版本1.1.1, 1.1.2等等。updateBranchVersions=true的意思是在分支中更新版本,而
updateWorkingCopyVersions=false是指不更改当前工作目录(这里是trunk)的版本。
在运行该命令后,我们会遇到这样的提示:
What is the branch version for "Unnamed - org.myorg:myapp:jar:1.1-SNAPSHOT"? (org.myorg:myapp) 1.1-SNAPSHOT: :
——"分支中的版本号是多少?默认为1.1-SNAPSHOT" 这时我们想要的版本是1.1.1-SNAPSHOT,因此输入1.1.1-SNAPSHOT,回车,maven继续执行直至结束。
接着,我们浏览svn仓库,会看到这样的目录:https://192.168.1.100:8443/svn/myapp/branches/1.1.x/,打开其中的POM文件,其版本已经是1.1.1-SNAPSHOT。
分支创建好了,就可以使用release:prepare和release:perform为1.1.0打标签,升级trunk至1.2.0-SNAPSHOT,然后分发1.1.0。
至此,一切OK。
小结
本文讲述了如何使用Maven结合svn进行版本管理。解释了Maven中SNAPSHOT版本的来由,以及Maven管理版本的规则。并结合SCM的tag和branch概念展示了如何使用
maven-release-plugin发布版本,以及创建分支。本文涉及的内容比较多,且略显复杂,不过掌握版本管理的技巧对于项目的正规化管理来说十分重要。Maven为我们提供了一
些一套比较成熟的机制,值得掌握。


分享到:
评论

相关推荐

    apache-maven-3.8.6-bin.zip

    提供最佳实践开发指南。 允许透明迁移到新功能。 在对Maven有所了解之后,让我们继续下一步,安装Apache Maven。 步骤1.下载Apache Maven 转到Apache Maven,然后从左侧栏中的“获取Maven”部分,单击“下载”...

    apache-maven-3.1.1-bin

    Apache Maven 是一个强大的Java项目管理工具,它遵循项目对象模型(Project Object ...通过理解和掌握Maven的工作原理以及如何配置和使用它,可以帮助开发者更好地管理他们的项目,并保持与社区最新的最佳实践同步。

    maven专题--apache-maven-2.2.0-bin.zip

    为了充分利用Maven,开发者应该遵循一些最佳实践,如保持POM的简洁明了,合理组织模块结构,以及定期更新依赖到最新稳定版本。 总结,Apache Maven 2.2.0是Java开发中的重要工具,它的功能强大,易于使用,大大简化...

    maven-shared-utils-0.4.zip

    源码阅读有助于自定义功能或调试,同时也能帮助开发者遵循最佳实践,提升代码质量。这个库通常包括以下几个核心组件: 1. **XML解析器**:提供了解析XML文档的能力,支持DOM(Document Object Model)和SAX(Simple...

    apache-maven-3.6.0-src

    **Maven的最佳实践:** 1. **约定优于配置**:Maven遵循一套标准目录结构,如`src/main/java`存放源代码,`src/test/java`放测试代码。 2. **依赖管理**:避免硬编码版本号,尽可能利用传递性依赖,保持POM简洁。 3....

    apache-maven-3.6.0-bin安装包和教程

    **最佳实践:** 1. **保持POM简洁**:避免在POM中直接指定具体版本,尽可能使用父POM或依赖管理来管理版本。 2. **合理使用模块化**:大型项目可以使用多模块结构,每个模块负责一部分功能。 3. **版本管理**:遵循...

    maven-parent-25-source-release.zip

    深入研究"Maven-parent-25-source-release.zip"源码,开发者不仅能理解Maven的内部工作机制,还能学习到最佳实践,提高项目管理水平。通过阅读和分析源码,开发者可以更有效地定制和扩展Maven,以适应不断变化的项目...

    apache-maven-3.5.0

    Apache Maven 是一个强大的项目管理和构建工具,主要用于Java应用程序的开发。它通过定义项目的构建过程、依赖关系和项目信息,使得开发人员能够以...在实际使用中,结合Maven的最佳实践,可以进一步优化项目构建流程。

    maven-definitive-guide

    - **内容概述**:该描述强调了文档将涵盖Maven 2.0.9及以上版本的内容,暗示读者可以通过此书深入学习Maven的核心功能、最佳实践以及如何有效地管理和构建项目。 #### 标签:“maven” - **主题标识**:标签“maven...

    maven_archetype

    - **版本控制**:archetype 可以随着项目需求的变化而更新,新版本的 archetype 会包含最新的最佳实践和依赖。 ### Maven Archetype 的配置文件 每个 archetype 都有一个配置文件,通常是 `archetype-metadata.xml...

    maven-parent-40-source-release.zip

    标题 "maven-parent-40-source-release.zip" 提示我们这是一个与 Maven 相关的源码包,...同时,通过分析和学习这个源码,开发者还可以掌握 Java 项目的最佳实践和标准化构建流程,提升自己的开发技能和团队协作效率。

    maven 3.8.5 linux版本下载

    ### Maven的最佳实践 - 保持POM简洁清晰,避免过度配置。 - 使用统一的命名规则和版本控制策略。 - 利用Maven的 profiles 功能为不同的环境(如开发、测试、生产)创建不同的配置。 - 使用Maven的依赖管理,避免...

    apache-maven-3.3.9-src.tar.gz

    总的来说,通过分析"apache-maven-3.3.9-src.tar.gz"中的源代码,开发者不仅可以深入了解Maven的工作机制,还可以学习到软件构建的最佳实践,如依赖管理、自动化构建流程等,这对于提升Java项目的开发效率和质量...

    Maven原理和实践-培训课件.ppt

    何为Maven 构建,依赖管理,项目信息聚合 Maven核心概念 坐标,依赖,仓库,生命周期,插件 Maven最佳实践 创建、打包、发布、版本管理 项目实战 Nexus(Todo…) M2eclipse(Todo…)

    MAVEN使用最佳实践

    【MAVEN使用最佳实践】 Maven 是一个强大的项目管理和构建工具,它简化了Java应用程序的构建过程,通过一套约定优于配置的原则,使得项目构建、依赖管理和文档生成等工作变得标准化。以下是一些在使用Maven时可以...

    apache-maven-3.5.2.zip

    3. **插件更新**:可能包含对内置插件的更新,以支持最新的技术和最佳实践。 4. **更好的用户体验**:可能改进了命令行接口,或者对日志输出进行了优化,使开发者更容易理解和调试构建过程。 为了使用"apache-maven...

    apache-maven-3.3.3

    6. **最佳实践**: - 遵循Maven的标准目录结构,如`src/main/java`放置源代码,`src/test/java`放置测试代码。 - 使用`&lt;dependencyManagement&gt;`元素在父POM中管理所有子项目的依赖版本。 - 定期清理本地仓库,...

    yuicompressor-maven-plugin

    ### 六、最佳实践与注意事项 1. **避免压缩库文件**:第三方库通常已经过优化,不需要再压缩,因此在`excludes`中排除这些库文件。 2. **版本控制**:确保将原始未压缩文件纳入版本控制系统,以便于调试和更新。 3....

    flume-plugin-maven-plugin-1.0.zip

    共享这些设置对于团队协作尤其重要,因为它可以帮助所有成员遵循相同的编码标准和最佳实践,减少因为环境差异导致的问题。这通常包括代码格式化规则、代码分析设置、构建路径配置、JUnit测试配置等。通过导入这些...

    maven-project-源码.rar

    【标题解析】:“maven-project-源码.rar”这个标题暗示了我们正在处理一个与Maven项目相关的源代码压缩文件。...通过解压和研究这个项目,开发者可以提升对Maven的掌握,并借鉴其设计模式和最佳实践。

Global site tag (gtag.js) - Google Analytics