在Eclipse 2.0中使用版本控制系统CVS
2002 年 7 月
2002年6月28日,Eclipse 2.0正式版已经正式完成,这将是Java开发工具历史上的一个重要事件,Eclipse开始步入成熟阶段。本文借此机会介绍在Eclipse中使用版本控制系统CVS的一些经验和技巧。首先介绍为什么Eclipse要使用CVS来作为自己的版本控制系统而放弃了有着很好口碑的Visual Age Java的ENVY,然后简要讲述CVS系统的背景及NT平台下CVS服务器的安装和设置。接下来,针对Eclipse,详细讲解了使用CVS进行团队开发时的开发流程以及在Eclipse中具体使用的重要操作方法。
背景
在Visual Age Java之后,IBM推出了新一代的开放源码软件开发平台Eclipse,在此基础上打造其核心产品WebSphere家族。而对于大部分个人开发者而言,Eclipse作为一个崭新的Java集成开发环境提供了一个非常具有吸引力的选择,已经得到了越来越多开发者的关注和喜爱。
项目的版本控制对于团队开发是极端重要的,对于个人开发者也是项目复杂化时不可缺少的工具。
在Visual Age Java中,由于Visual Age Java特有的项目数据存储方式――所有的相关文件都存在一个二进制文件中,可以做到直接内置的版本控制,这一系统也就是著名的ENVY,它在Visual Age Java的使用者中有着非常好的口碑。
而在Eclipse中,情况有了变化。ENVY把项目数据存储在二进制文件中,也即所谓基于Repository的存储,而几乎所有其他集成开发环境的项目数据存储方式都是基于文件的,项目的所有相关文件直接作为物理文件存储在硬盘上。两种方式各有利弊,有许多刚接触Visual Age Java的用户很不习惯ENVY,认为看不见文件使得自己失去了直接感,反过来也有Visual Age Java的忠实用户极力支持和赞扬ENVY。(不过作者认为,在Visual Age Java中开发者至少可以几乎完全不用花心思在文件路径问题上,这个问题一般总是会耗费新手甚至老手的大量时间和精力。)在Eclipse中最终使用了基于文件的存储方式,这样增强了透明性和互操作性,但是要达到Visual Age Java以前做到的项目管理和源代码控制就必须采用不同的方式。
Eclipse的内置版本支持
Eclipse本身内置了一定程度的版本支持,也就是所谓的Local History。在Eclipse中编辑的文件每次存盘都会留下记录,可以随时与历史记录比较,恢复到某一个时刻的状态。在资源视图(Resource Perspective)或者Java视图(Java Perspective)中的文件上点右键,选择Compare With,Local History,就会得到如下的画面,可以很清晰看到各个版本的区别。
图1:Eclipse中的内置版本支持:Local History。
如果需要,则可以通过Replace With,Local History来恢复到任一个以前的版本。当然,这样版本的历史是有限制的,可以在Eclipse的Preference中设置。在Preference―>Workbench->Local History中,可以设置保持最多保持几天的文件,每一文件的版本数目,历史文件的大小限制。
但是,这样的版本系统只实现了最基本的版本功能,如果想把文件某一个状态标记为一个版本,加上注释(仅仅从Local History中的保存时间很难看出每一个版本的特点,也难以找到重要的关键版本),或者想把某个目录乃至整个项目版本化,Eclipse内置的Local History都是无能为力的。
好在Eclipse基于开放的思想,采用了业界标准的版本控制系统CVS,这样不仅很好地实现了版本控制的功能,对于已经熟悉CVS的开发者来说也更容易使用,更重要的是,可以为团队开发提供更加灵活和开放的选择:项目的数据可以存储在一个CVS服务器内,不同的开发者甚至可以采用不同的开发工具,只要这些工具都支持CVS。也许这时我们可以理解为什么Eclipse放弃了Visual Age Java的业已很成功的ENVY系统,这一点很好地体现了Eclipse的开放性和对其他软件的良好互操作性。
CVS
CVS是Concurrent Versions System(并发版本系统)的缩写,基于Unix体系中成熟的SCCS(Source Code Control System)和RCS(Revision Control System)开发,是一个开放源码的项目,目前已是版本控制系统的主流软件。一个很常见的使用CVS的场合,就是开放源码项目。由于开放源码项目的开发者的分布性,对于版本管理的要求更加严格,而目前大部分的开放源码项目几乎都是采用CVS来管理源代码,CVS的标准性和强大可见一斑。
CVS采用客户机/服务器体系,代码以及各种版本存储在中心服务器内,每一个个体开发者开发时都首先从服务器上获得一份自己的拷贝,在此基础上进行开发,以避免直接影响服务器上的数据。开发者可以随时把自己的新代码提交给服务器,并通过更新获得代码的最新状态,保持与其他开发者的一致。
CVS对于网络是透明的,开发者可以使用客户端软件(几乎所有的平台上都有相应的客户端软件)在任何时候,任何地点通过网络来获取最新的代码。
对于Eclipse的开发者而言,Eclipse本身内置了CVS支持,不需要使用其他客户端软件,只要建立一个CVS服务器,就可以使用这一强大的版本控制系统了。
CVS起源于Unix/Linux平台,关于Unix/Linux平台下的安装使用的介绍文章很多,这里就不再重复,读者如果需要在Unix/Linux平台下建立CVS服务器,可以参考本文附录的相关资源。
在Windows平台上也有CVS的一个实现――CVSNT,CVSNT的安装有一定困难,这里我们做一个简单介绍。 CVSNT的安装
首先到CVSNT的主页http://www.cvsnt.org下载最新版本,目前是CVSNT 1.11.1.3 (Build 57f)。
CVSNT的安装有一些注意事项,请读者尽量按照下面所说的步骤来进行安装,描述主要针对Windows 2000。如果读者在安装过程中还有问题,可以参考本文附录的资源中关于CVSNT的安装技巧的文章或邮件列表。
CVSNT可以安装在Windows NT4 服务器或工作站SP6, Windows 2000服务器或专业版,Windows XP专业版上。
以管理员账号登陆,首先修改环境变量。直接执行安装程序,很有可能在最后会出现无法创建路径变量的错误,为此我们首先修改环境变量,设定路径。假设我们要把CVSNT安装到D:\app\cvsnt目录下(与CVSNT相关的内容最好安装到NTFS分区上,也尽量不要使用含有空格的目录名或者文件名,虽然CVSNT已经尽量支持包含空格的目录名和文件名,但仍有可能出现问题),那么打开控制面板,系统属性,高级,环境变量,系统变量中的Path,添加上D:\app\cvsnt并保存设置。
接下来可以执行安装程序,修改安装目录,一步步完成安装。
从开始菜单的程序组中启动CVSNT配置程序Configure Server。这时应该看到服务器还没有运行(CVSNT作为系统服务运行),如果已经运行了,先把它停下来。
选择第二个选项卡Repositories,首先勾上Repositories prefix(数据库路径前缀)的选项。CVSNT中只有一个数据库路径前缀,在这同一个前缀下,可以有多个数据库。相应的,所有的数据库都位于数据库路径前缀对应的目录之下。这里我们假设数据库都存储在E:\work\cvsrepo下,点击省略号按钮来选择E:\work\cvsrepo作为数据库路径前缀。
点击下面的Add按钮添加数据库根,可以有多个。比如我们将/work作为我们的工作项目的存储根。注意添加时系统自动把已设定的E:\work\cvsrepo作为了路径前缀。
选择第三个选项卡Advanced,勾上全部选项,包括Use local users instead of domain。设置临时目录,假设为E:\work\cvstemp。注意要保证临时目录的安全设置(右键点击目录属性,共享,权限)给所有帐号以完全控制权限,包括SYSTEM帐号。并且,绝对不能把临时目录设在诸如C:\WINNT\TEMP或者C:\Documents and Settings下的任何地方,因为这些地方对于用户的访问是有限制的。
点击应用以保存设置,这一点相当重要。
现在可以回到第一个选项卡,点击Start按钮,服务应该正常启动运行了。如果有问题,可以打开一个命令行窗口,输入path命令来检查路径是否已经设置正确,也许需要重新启动来使设置生效。
打开一个命令行窗口,输入如下命令,用你的实际计算机名和用户名替代尖括号内的内容,注意对于NT Server,不能用localhost作为计算机名,必须使用实际计算机名:
set cvsroot=:ntserver:<计算机名>:/work
这一命令通过设定cvsroot这一环境变量,设定/work为目前的cvs数据库根。这里使用ntserver模式,这一模式比较适合服务器就在本地的情形。它要求局域网或者域内所有机器的用户帐号相同,客户端使用Windows NT,Windows 2000或者Windows XP。pserver模式是缺省的,除非关掉2401端口,下面我们的Eclipse就是使用pserver模式。
cvs passwd -a <你的NT用户名>
这一命令设定CVS中的用户名和密码,输入后将提示你输入密码。
注意如果需要CVS 服务器同时以ntserver和pserver模式运行,那么密码最好不要和系统中用户的真实密码相同以保证安全。
这里的用户必须是服务器上的真实用户,不过可以给真实用户设定一个不同的使用名alias。使用命令:
cvs passwd -a -r <你的NT用户名> <CVS帐号别名>
必须注意,这些名字里最好不要使用任何空格。如果必须的话,可以用双引号括起来。
到此为止,CVS服务器已经初步设置完成,可以使用了。缺省情况下,服务器将作为NT服务自动运行。读者既可以使用命令行的CVS命令,也可以使用各种CVS客户端来连接CVS服务器,执行CVS操作。不过,下面我们主要介绍在Eclipse中通过内置的CVS支持来使用CVS系统。
在Eclipse中使用CVS系统
前面已经提到,CVS的数据存放在服务器的数据库中。为了支持Concurrent这一并发特点,CVS使用了一个分枝(Branch)模型,以保证不同开发者的相对独立,但是又高度集成。分枝可以看成一个开发团队共享的工作区(Workspace),在CVS数据库中,有一个特殊的分枝称为HEAD,代表主要工作流。
开发者可以提交(Commit)自己的工作,并通过更新(Update)与其他人的最新修改保持同步。提交是把自己的修改提交给数据库,称为输出(Outgoing),更新则是得到其他人的修改,称为输入(Incoming)。每次提交之前,都应该先更新,以保持与最新状态同步。
因此,在Eclipse中使用CVS进行团队开发,理想的开发流程应该是这样的(具体操作方法随后介绍):
图2:团队开发流程
1.从最新状态开始。开始工作前,要保证所有资源与最新的分枝状态一致。对于从头开始的新项目,首先要连接服务器,设定存储那些资源文件。对于在服务器数据库中已经有记录的项目,首先要通过更新来保证资源状态最新。如果本地的工作没有需要特别保存的,可以直接把数据库中的最新版本Check Out As Project,或者Replace With,Latest from Repository。
2.进行本地工作,保存修改。
3.同步。当做好提交工作的准备后,要和服务器数据库同步。
(1)首先应该更新(Update),检查所有的Incoming改变,输入到本地,看是否会影响自己的工作,是否会造成冲突,破坏完整性等等。
(2)检查完更新后,可以确认自己的工作和最新的Branch内容是一致的,就可以提交(Commit)自己的修改了,标上适当的注释。
下面介绍这一开发流程所用到的主要操作。
对于一个新的项目而言,首先需要做的就是设置Eclipse来连接CVS服务器。首次连接将与服务器同步(Synchronize)。
首先在Eclipse的资源视图(Resource Perspective)或者Java视图(Java Perspective)中的项目上点右键,选择Team,Share Project,将出现提示窗口,选择是使用已知的CVS数据库位置还是新建数据库位置。对于第一次连接CVS服务器的情况,将需要首先定义连接所需的服务器参数和路径,用户名,密码等等。这些参数将得到保存,以后如果需要重新连接,就可以直接使用已知的CVS数据库设置。
这里我们选择新建一个数据库位置,进入下一个输入画面。
这里的主机名(Host)可以输入localhost(在Windows NT 4下不可以这样输入),因为我们的CVS服务器就在本机上。
接下来输入/work,设定我们的项目数据存放在这一数据库根路径下。
然后输入用户名和密码。
连接类型选择pserver,端口是缺省的不用改动。当然,如果你修改过CVS服务器使用的端口,这里就要保持一致。
图3:在Eclipse中设置使用CVS系统
接下来可以直接点击Finish完成设置。如果点击下一步,可以继续定义在CVS中是否使用与项目名不同的名字作为模块名,缺省是使用相同的名字。
现在我们完成了项目与CVS服务器的连接,项目已经和CVS服务器同步了。
但是这并不意味着CVS已经开始记录版本信息。因为在一个项目中可能有相当一部分资源文件不适合存储到数据库中记录版本信息,比如编辑器生成的临时文件,编译生成的.class文件,或者某些编译过程生成的二进制文件等等。因此,Eclipse并不自动把所有文件存储到数据库中,需要开发者手工指定把那些文件存储到数据库中,也就是加入版本控制add to version control。对于单个文件的指定,可以随时在资源视图(Resource Perspective)或者Java视图(Java Perspective)中的文件上使用右键,选择Team,Add to Version Control。如果需要存储整个项目或者同时指定多个文件,则要使用同步(Synchronize)视图。
注意项目与CVS服务器连接完成并同步后,在Eclipse右下角的Tasks和Console的位置新出现了一个Synchronize窗口,下方状态栏也显示了这次同步的状态信息。双击Synchronize窗口的标题栏使之最大化,我们可以看到窗口上半部分列出了所有尚未指定加入数据库的资源和文件。在这里我们可以同时选择多个文件,甚至选择整个项目,使用右键,选择Team,Add to Version Control,就可以把多个文件或者整个项目加入到数据库中,开始记录其版本信息。
我们可以看到,这时的同步视图上标明了处于Outgoing模式。同步(Synchronize)视图有Incoming模式和Outgoing模式,对应于提交(Commit)和更新(Update)操作,表示目前修改是来自本地还是来自服务器。当然,视图也可以同时显示Incoming和Outgoing方向的变化。当有变化时,在下半部分的比较窗口可以显示不同版本之间的差异和变化。进一步地,可以通过工具条上的合并(Merge)操作来消除对同一文件不同修改所带来的冲突。
在此之后,当完成对文件或者项目的修改,需要确认修改,把最新的状态存储到数据库中去,就需要执行提交(commit)操作。类似的,我们可以在资源视图(Resource Perspective)或者Java视图(Java Perspective)中的文件上使用右键,选择Team,Commit;或者在同步(Synchronize)视图中同时提交多个文件乃至整个项目。注意,每次提交时都会提示输入注释,这是很重要的,作为每一个状态的说明和提示。
当我们需要把文件或者项目的不同版本进行比较或者替换时,可以在资源视图(Resource Perspective)或者Java视图(Java Perspective)中的文件上使用右键,选择Team,Compare With或者Team,Replace With来完成。进行比较时将打开一个比较编辑器,很好地表示不同版本之间的差异,和Local History类似。
如果要了解CVS数据库的内容情况,可以使用CVS数据库浏览视图(CVS Repository Exploring Perspective)。我们可以点击Eclipse左上角的开启视图(Open Perspective)按钮,增加这一视图到左边的视图浏览栏里。前面已经提到,HEAD代表CVS数据库里的主流内容。展开Versions,可以看到以往的版本。另外,在右下角有数据库的历史记录标明每次修改的相关信息。
如果需要导出某一版本,就要用到Check Out操作。在某一版本上右键选择Check Out As Project,这将把这一版本导出为同名的项目,从而可以覆盖已有的状态,或者选择Check Out对话框来导出为其他项目。
图4:CVS数据库浏览视图
关于更详细的CVS使用方法和技巧,可以参考Eclipse的帮助中相关内容。
关于作者:
董向辉,1998年毕业于清华大学,随后进入中科院自动化所人工智能实验室直接攻博。科研兴趣主要在演化计算和系统复杂性问题,技术方面,从接触Java开始,便一直保持着对Java的兴趣并作为主要编程语言。同时注意关心新出现的有前景的相关技术,聚焦点先后包括软件工程,XML,J2ME等等。电子邮件地址:xianghui.dong@mail.ia.ac.cn。
相关资源:
关于CVS:
http://www.cvshome.org,CVS官方网站,可以从这里下载最新版本的CVS(Unix/Linux平台版本)以及相关的文档和资料,例如Per Cederqvist的Version Management with CVS 这本官方手册。
http://laser.zhengmai.com.cn/cvstutorials.html,一个中文的CVS简单教程。
http://www.cvsnt.org,CVSNT,在Windows NT上的CVS服务器,在此基础上也有返回Unix/Linux平台的版本。目前最新版本是CVSNT 1.11.1.3 (Build 57f)。
http://www.cvsnt.org/mailman/listinfo/cvsnt,关于CVSNT的使用问题的邮件列表。
http://w1.858.telia.com/~u85831169/InstallCVSNT.html,关于CVSNT安装的一些技巧和知识,感谢作者慷慨的准许,本文参考了其中部分内容。
http://devguy.com/cvsnt,另一个CVSNT安装问题的帮助和常见问题回答。
http://www.cvsgui.org,Windows平台下的图形化CVS客户端软件。
关于Eclipse:
http://www.eclipse.org,Eclipse官方网站,可以从这里下载最新版本2.0。
http://www-900.ibm.com/developerWorks/cn/java/l-ide/part2/index.shtml,VAJ之后是什么?,介绍从Visual Age Java到Eclipse,WSWB等等的来龙去脉以及各自的特点。
http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/platform-vcm-home/docs/online/cvs_features2.0/cvs-faq.html,在Eclipse中使用CVS的常见问题回答。更详细的具体操作介绍,可以参考Eclipse软件所附带的帮助。