敏捷高质量编程.pdfVIP

Java Java 敏捷开发中高质量 JJaavvaa 代码开发实践 王 永魁, 软件工程师,IBM 王 兆丽, 软件工程师,IBM 刘 颖, 软件工程师,IBM 简介： 本文将介绍在敏捷开发过程中如何通过采取一系列的步骤来保证和提高整个项目的代码质量，阐述 了每一步可以利用的工具和最佳实践，从而使开发过程更加规范化，成就高质量的代码。 内容 • 概述 • 步骤一：统一编码规范、代码样式 • 步骤二：静态代码分析 • 步骤三：单元测试 • 步骤四：持续集成 • 步骤五：代码评审和重构 • 结论 • 参考资料 • 作者简介 • 建议 概述 Java 项目开发过程中，由于开发人员的经验、代码风格各不相同，以及缺乏统一的标准和 管理流程，往往导致整个项目的代码质量较差，难于维护，需要较大的测试投入和周期等问 题。这些问题在一个项目组初建、需求和设计均具有不完全可预期性和完备性的全新项目中 将尤为突出。本文将结合敏捷开发周期短，变化快等特点，介绍如何通过在开发过程中采取 一系列步骤来保证和提高整个开发团队的代码质量，并阐述了每一步可以利用的工具和最佳 实践，从而使开发过程更加规范化，成就高质量的代码，减少测试的投入，并促进整个团队 的技能提高，最终提高开发效率和质量。 如图 1 所示，敏捷开发过程经历需求调研，用例分析和用例分解，进入开发迭代阶段。在 每个迭代过程中，可以采用以下五个步骤来保证和提高整个项目的代码质量：统一编码规范、 代码样式；静态代码分析（staticcodereview）；单元测试；持续集成；代码评审和重构（Review Refactor）。下文将针对每个步骤和其所使用的工具、方法进行详细描述。 1. Java 1. Java 图 11.. 敏捷开发中的 JJaavvaa 代码质量保证步骤 回页首 步骤一：统一编码规范、代码样式 规范统一的编码会增加项目代码的可读性和可维护性，但实际情况往往是项目组内的 Java 代码开发人员的编码风格常常各不相同，这可能是由于不同的经验习惯或者缺乏编码规范方 面的学习造成的。这样一来，其他项目成员或者维护人员在阅读项目代码时就需要花费更多 的时间来理解代码作者的意图，所以制定并采取统一的编码规范就显得很重要。编码规范主 要应包含以下几个方面： • 一般规则和格式规范。例如代码缩进、程序块规范、每行最大代码长度等。 • 命名规则。例如包名、类名、变量、方法、接口、参数等命名规范 • 文档规范。例如类文件头声明、类注释、成员变量和方法注释等规范。 • 编程规范。例如异常、并发、多线程等方面的处理方式。 • 其他规范。例如日志格式、属性文件格式，返回值和消息格式。 项目的编码规范可以参考已有的一些 Java 编程规范书籍和其他相关资料并结合项目的本 身来制定，可供参考的书籍有《 Java 编程风格》（英文书名为：TheElementsofJavaStyle）。 编码规范要形成文档，而且要简洁明了，并组织项目成员一起学习，确保所有成员正确理解 所有条目。 一旦编码规范确定，就可以利用 Eclipse 自身提供的功能来控制代码样式和格式。具体做法 Windows-Preference Preferences Windows-Preference Preferences 是，点击 Eclipse 的 WWiinnddoowwss--PPrreeffeerreennccee 菜单项，在打开的 PPrreeffeerreenncceess 对话框的左侧 CodeStyle CodeStyle 栏中找到 Java 节点下的子项 CCooddeeSSttyyllee（如图 2），该项和它的子项允许您对 Java 代码 的样式进行控制。 2.Eclipse 2.Eclipse 图 22..EEcclliippssee 代码样式设置窗口 例如，为了使用自动格式化