练习 1.2:运行代码复审并应用快速修订
本练习假设您已经完成了练习 1.1:导入要求的资源。在练习中您将先读到一个用户场景。然后,您就担当用户场景中描述的软件开发人员的角色。
用户场景
一大组地理位置分散的开发人员正在为一个新的软件应用程序编码。开发人员例行地运行代码复审来在代码中查找问题,这一点很重要。
其中一个开发人员想要运行代码复审来看看自己总体的工作情况如何。为了复审新编写的代码来评估多个领域中最佳实践的遵守情况,开发人员就运行自动快速代码复审。此复审将所提供的数个类别的规则应用于代码。每个类别的规则都在特定领域(如性能)中检查代码质量。
代码复审完成后,您会看到一列发现的结果。每个发现结果都代表不严格遵守应用规则的一串代码。这些发现结果中有一个提供了快速修订,所以开发人员应用自动解决方案,立刻更正该问题。
在练习的第一部分,您执行以下任务来运行代码复审:
- 选择要运行的代码复审。
- 查看代码复审中应用的规则。
- 选择对什么代码运行复审。
- 运行代码复审。
- 查看代码复审的发现结果。
- 选择一个发现结果,查看它的以下信息:
接着,为对代码复审中的一个发现结果应用快速修订,您就要执行以下任务:
- 找出发现结果何时有快速修订。
- 看到快速修订将对代码作出的一列更改。
- 应用快速修订前先预览原始的和重构后的代码。
- 应用快速修订,重构代码。
- 应用快速修订后收到确认。
练习
选择代码复审
要选择快速代码复审:
- 在“代码复审”视图的工具栏上,单击管理规则图标,
。

- 在选择代码复审列表中,单击快速代码复审。将显示您选择的代码复审的相应规则文件夹,如以下屏幕捕捉所示:

- 要查看某个将在代码复审中应用的规则,请展开 J2SE 最佳实践文件夹,然后展开 Null 子文件夹。Null 文件夹显示一个带问题严重性级别的规则,如以下屏幕捕捉所示:

作为复审,严重性级别图标显示在以下图示中:

- 单击确定来选择“快速代码复审”。
选择要复审的代码库
要选择项目作为要复审的代码库:
- 在“代码复审”视图的工具栏上,单击复审图标(
)> 项目 > 复审 CodeReview_Example。
运行代码复审
一旦选择了要复审的代码库,代码复审就开始运行。您可以通过检查视图右下角的进度条,来跟踪代码复审的状态。
查看代码复审的发现结果
代码复审完成后,发现结果会显示在“代码复审”视图中,如以下屏幕捕捉所示:

“代码复审”视图提供以下信息:
- 代码复审统计信息:发现结果上面的行显示关于最近的代码复审的信息:类型、范围、所包含的规则和文件的个数以及发现结果的个数和严重性。
- 代码复审发现结果:代码复审的发现结果列出在“代码复审”视图中,位于文件夹内。每个文件夹名称都告诉您所应用的规则的类别以及发现结果的个数。
获得关于代码复审发现结果的更多信息
要获得关于代码复审中的发现结果的更多信息:
- 在“代码复审”视图中,滚动到 J2SE 最佳实践:比较文件夹。然后展开文件夹来显示其中的发现结果,如以下的屏幕捕捉所示:

- 第一个发现结果以 EqualsHashCode_Example.java 开头。后面注出了应用的规则:
始终覆盖 java.lang.Object.equals() 和 java.lang.Object.hashCode()
- 双击第一个发现结果。关于它的详细信息出现在两个地方,如以下各点和屏幕捕捉所概述:
- 源代码:显示发现结果所处的代码,并突出显示它的确切位置。
- “代码复审详细信息”视图:更详细地描述发现结果,并提供更正它的示例和解决办法。

选择有快速修订的发现结果
您可以看出“最佳实践:比较”文件夹中的两个发现结果都有以图标标示的快速修订。作为复审,快速修订图标显示在以下图示中:

- 右键单击列表中的第一个发现结果,如下一个屏幕捕捉所示。
- 快速修订弹出菜单选项因解决方案而异。对于您选择的发现结果,修订是实施 hashCode 和 equals。

- 单击快速修订:实施 hashCode 和 equals。
应用快速修订
对于您选择的发现结果,适用的快速修订是实施 hashCode 和 equals。
要复审并将快速修订应用于发现结果:
- 您将看到代码的并排视图,如以下屏幕捕捉所示。原始的源代码在左边,将由快速修订创建的重构源代码在右边。如果您决定应用快速修订,它将追加突出显示的缺失代码行。

- 在要执行的更改部分中展开列表,查看快速修订确切地将更改什么以及如何更改,如以下屏幕捕捉所示:

- 复审列表中的更改。然后单击确定,将快速修订应用于列表中所有选中的更改。
- 应用快速修订后,您将看到您解决的发现结果旁有一个选中标记。

在选中标记旁,您将看到以下信息:
- 您应用的快速修订
- 发现结果所在的源代码行号
- 代码复审中未遵守的规则
您已经完成了“练习:运行代码复审并应用快速修订”。
练习总结
您已经执行了“练习:运行代码复审并应用快速修订”中的所有任务。
运行代码复审的任务
当您运行此代码复审时,您执行了以下任务:
- 选择了要运行的代码复审。
- 查看了代码复审中应用的规则。
- 选择了对什么代码主体运行复审。
- 运行了代码复审。
- 查看了代码复审的发现结果。
- 选择了一个发现结果,查看它的以下信息:
应用快速修订的任务
当您应用快速修订时,您执行了接下来的一组任务:
- 找出了发现结果何时有快速修订。
- 看到了快速修订将对代码作出的一列更改。
- 预览了原始的和重构后的代码。
- 应用了快速修订,重构代码。
- 收到了快速修订已经应用的确认。
利用代码复审的能力
通过主动运行代码复审,您可以在早期分析发现结果。这意味着您还可以在早期处理它们,避免它们造成以下问题:
- 影响您的应用程序的性能、维护或可伸缩性
- 花费您的公司的金钱、时间和资源
利用快速修订的能力
通过应用提供的快速修订,您就有了解决常见发现结果的自动方法。快速修订用以下方法帮助您:
- 每次都一致地更正问题
- 让您腾出来处理代码,而花费较少的时间来更正错误
通过复习摘要:运行代码复审中的学习目标,完成教程。