代码审核插件Jupiter Code Review Reference.docx

1、代码审核插件Jupiter Code Review ReferenceJupiter Code Review Reference备注：IE6内核的浏览器图片总是出不来，建 议使用Mozilla Firefox，Opera，谷歌浏览器一、Jupiter是什么？这里的Jupiter是一个开源的代码审查工具，是集成在Eclipse下执行代码审查工作一个很棒的工具。可以把Jupiter的工作划分为3个阶段，（我个人认为5个人阶段），分别是：Individual Phase个人阶段，表示个人审查阶段。Team Phase团队阶段，表示团队审查阶段。Rework Phase修复阶段，表示修改Bug阶段。而

2、我觉得应 该加入：任务定义阶 段和BUG确认阶段。任务定义阶 段：是指在指派审查任务前的任务定义和分配过程。BUG确认阶段：是指bug修改结束后的重新审查和关闭bug阶段。二、如何安装Jupiter条件：Jupiter需要Java 5或更高版本的JDK以及Eclipse3.3（Europa）或更高版本Eclipse。由于Jupiter是基于团队的工作，建议在一个版本控制系统下执行 代码生审查工作。（即CVS或SVN等）。安装：这里只提供针对Eclipse3.5 Galileo的离线安装，通过在线安装的地址是：http:/jupiter-eclipse-请自行决定第一步：到下载最新的JAR文件。

3、第二步：把下载到的JAR文件拷贝到Eclipse的plugins目录下。第三步：重启Eclipse（或是打开Eclipse）如果在Eclipse的工具栏出现如下图标表示安装成功。三、如何创建Review ID？1、我们先了解 什么是Review IDReview ID代表一个审查任务，包涵了很多元素，比如审查任务 名称，描述，审查那些代码文件，审查人，审查类型，级别设置等等，而这些信息正是组成一个审查任务的基本元素。2、创建ReviewID流程A、在Eclipse右击选择要审查代码的项目B、选择“属 性”，如下图：C、进入属性页 面选择“Review”选项，如下图：D、点击右边的 “New”按

4、钮出现填写框，可以填写ReviewID的名称，描述。如下图：E、点击“Next”按钮进入下一步，选择对那些代码文件进行审查， 如下图：F、点击“Next”按钮进入下一步，选择或是新输入审查人员，如下 图：G、点击“Next”按钮进入下一步，指定Session的作者，这部可以不选择，但是一般选择所审查程序 的编程人员。H、点击“Next”按钮进入下一步，选择“Type，Severity，Resolution，Status”的选项，同时可以修改这里选择项，这一点很有 用，在大部分的代码审查工具中这个不能做到很灵活，所以有不少弊端。但是Jupiter搞定了这个问题。I、点击“Next”按钮进入下一步

5、，确定“Type，Severity，Resolution，Status”的默认选项。如下图：J、点击“Next”按钮进入下一步，输入最后得审查数据放在那个目 录下，建议用日期加任务标记作为目录，比如:2010630TEST，如下图：K、点击“Next”按钮进入下一步，最后设定每个阶段的过滤器，每 个项目可以根据项目的需要设定，这里默认不变。L、点击“Finish”按钮完成ReviewID的设定，在工程的属性对话框里多了一条数据，这些 数据就在文件“.jupiter”下，这个文件在工程的文件目录下，如下图：3、发布ReviewID发布ReviewID的过程其实就是配合SVN或是CVS或是其他版本

6、控制系统发布“.jupiter”，通过传播“.jupiter”，让其他人把该文件拿到同一工程下的同一目录， 即可实现下一步骤的功能。4、获取ReviewID获得的方式 主要通过同步版本控制器的“.jupiter”文件即可，一般是定制一个审查任务之后，发起者发出邮件，邮件里面说明此次任务的具体细节，在“.jupiter”里面就 是这些细节的体现。四、在Individual Phase我们应该做些什么？1、Individual Phase的目标个人阶段的 目标就是针对在ReviewID定义阶段指定的审查人员开始工作的出发地，他们要 从这里开始，把属于他的任务执行完成，并提交到版本控制器，有很多需要

7、注意的细节我们在后面表述。2、Individual Phase的过程1)确认已经从 版本控制器更新了“.jupiter”文件。2)点击Jupiter的Eclipse图标的下拉箭头，出现4个选项，选择1 Individual Phase，即可进入选择ReviewID界面。如下图：3)选择ReviewID界面，如下图：4)点击“Finish”按钮，进入Individual Phase视图，图下图：5)点击“ReviewTable”视图的按钮，出现可以选的待审查的代码文件列表，如下 图：6)选择其中你 想审查的文件，那么在Eclipse的编辑区即打开该文件。这时候，你可以开始你的Review工作了。

8、7)找到一个Bug，那怎么办？选择代码行，右击，选择“Add Review Issue”,如下图：可记录改BUG的所有信息，并分类型，严重等级等。填写之后点击 右边的保存按钮，形成一条审查记录。8)这时候在代 码文件行号的位置出现一个小图标，说明这行代码有问题，同时在“ReviewTable“视图增加了一条记录。如下图：3、结束Individual Phase个人审查阶 段就是这么一个一个问题的叠加的，直到你完成所有代码文件的审查工作，这之后刷新工程项目的目录，在目录的下面会增加一个子目录“2010630TEST”不一定就这个名称，这是根据你在定义ReviewID时数据而定，里面有一个文件“测

9、试代码审查任务-XXX.review”。其中“-”的前一部分是ReviewID名称，后一部分的XXX是执行Individual的ReviewerID，也就是审查者。文件的后缀是.review。提交.review文件到版本控制系统，并回复执行的任务邮件告知审 查发起者你的任务已经完成，在回复时记得把.review文件名称写在邮件里面。五、在Team Phase我们讨论些什么？1、Team Phase的目标Team Phase的目标就是把很多审查人的审查文件集合起来然后， 开个评审会议，把问题讨论清楚，确认是否需要调整或是制定给谁解决等。2、Team Phase的过程1)进入Team Phase，

10、操作如下图：2)进入下图， 选择讨论哪个审查者审查出来的问题。3)点击“Finish”按钮，进入BUG的浏览界面面，如下图：4)那么如何讨 论一个审查出来的BUG呢，双击“Review Table”里面的一个Bug，在Eclipse的编辑区即可导航到该代码行，而在“Review Edit”则打开该Bug的具体描述，可以指定给那个开发人员修改默认是在设定改ReviewID时指定的Session Author ，可以设定“Resolution”的选项，并添加备注。如下图：5)最后点击保 存，结束一个Bug的讨论。3、结束Team Phase依次循环， 逐个解决审查出来的Bug，并提交.review

11、文件到版本控制器，并邮件通知代码修改人员。每个Bug都应该得到重视，讨论时一种很好的传播方式，所以 在结束Team Phase前，一定要把问题总结出来，尽可能的避免下次再次 出现。六、在Rework Phase修改Bug1、Rework Phase的目标Rework Phase的目标就是每个开发人员去看看被检查出来的bug，并彻底的修复它，不要留下任何给检查者在Reopen的机会。2、Rework Phase的过程1)进入Rework Phase，操作如下图：2)同样需要选 择对应的项目和对应的Review信息，如下图：3)一般这时候 不一定可以在“Review Table”看得到BUG记录，

12、需要选择“Review Table”的过滤按钮才能看到Bug记录。4)Ok，逐个双击，导航到代码，逐个修改，修改之后在“Review Editer”调整该Bug的信息。如下图：其中状态可 以改成Resolved，表示已经解决问题；或是Closed表示直接关闭，或是Reopen，重新开启（最好不要被重新开启）。3、结束Rework Phase逐个解决Bug，逐个修改它的状态，最后提交.review文件到版本控制系统，并邮件通知代码审查人员可以 重新审查已经修改的Bug了。七、确认修改1、可能不需要 这一步骤有些团队可 能不需要这一步骤，但是这只是建议，应为他们的人手不够，而且每个开发人员都值得信

13、任，每个修改者在修改完bug之后直接close了bug。直接进入报表生成阶段。而我觉得这一步骤在很多 场合很有必要，比如需要有人来证明你的bug确实解决了。2、如何重新审 查进入重新审 查的过程和进入Rework Phase的过程一样，只需要查看Bug修改情况和调整Bug的状态即可。3、结束审查结束审查之 后需要邮件通知所有相关人员您的重新审查情况。八、分析.review文件.review文件以xml格式为结构，具体的每个标签标示一个实际的意义， 我们来看看它的描述问题方式： 2010-06-30 : 15:38:57:144 CST2010-07-01 : 14:18:02:631 CST吕

14、宽沟谷子地src/com/jem/report/exam/xml/XmlDataSourceExample.javaitem.type.label.programLogicitem.severity.label.normal多余代码这个语句在这里是多余的语句，没有实际的用处。也就是这样的就是啊item.resolution.label.validFixlateritem.status.label.closed九、把.review文件变成报表因为到最后 可能有很多的.review文件，我们需要把他们全比合并起来，于是我们可以 写一个Eclipse插件或是写一个独立的应用来完成这个工作，把多个.review文件合并成一个.review文件，合并的目的在于我们要利用iReport来帮我们完成报表的建立。如何制作一个报表参考iReport的使用。本文完成 时，“JE”合并工具还没有最后完成，但是界面已经出来，可 以先拿来参考，最后的报表也还没有实现，这部分内容需要通过iReport实现，放在后续的文章说明。