敏捷开发中高质量Java代码开发实践 - 编程入门网
敏捷开发中高质量Java代码开发实践时间:2011-06-16 IBM / 王永魁 王兆丽 刘颖概述 Java 项目开发过程中,由于开发人员的经验、代码风格各不相同,以及缺乏 统一的标准和管理流程,往往导致整个项目的代码质量较差,难于维护,需要较 大的测试投入和周期等问题。这些问题在一个项目组初建、需求和设计均具有不 完全可预期性和完备性的全新项目中将尤为突出。本文将结合敏捷开发周期短, 变化快等特点,介绍如何通过在开发过程中采取一系列步骤来保证和提高整个开 发团队的代码质量,并阐述了每一步可以利用的工具和最佳实践,从而使开发过 程更加规范化,成就高质量的代码,减少测试的投入,并促进整个团队的技能提 高,最终提高开发效率和质量。 如图 1 所示,敏捷开发过程经历需求调研,用例分析和用例分解,进入开发 迭代阶段。在每个迭代过程中,可以采用以下五个步骤来保证和提高整个项目的 代码质量:统一编码规范、代码样式;静态代码分析(static code review); 单元测试;持续集成;代码评审和重构(Review & Refactor)。下文将针 对每个步骤和其所使用的工具、方法进行详细描述。 图 1. 敏捷开发中的 Java 代码质量保证步骤
步骤一:统一编码规范、代码样式 规范统一的编码会增加项目代码的可读性和可维护性,但实际情况往往是项 目组内的 Java 代码开发人员的编码风格常常各不相同,这可能是由于不同的经 验习惯或者缺乏编码规范方面的学习造成的。这样一来,其他项目成员或者维护 人员在阅读项目代码时就需要花费更多的时间来理解代码作者的意图,所以制定 并采取统一的编码规范就显得很重要。编码规范主要应包含以下几个方面: 一般规则和格式规范。例如代码缩进、程序块规范、每行最大代码长度等。 命名规则。例如包名、类名、变量、方法、接口、参数等命名规范 文档规范。例如类文件头声明、类注释、成员变量和方法注释等规范。 编程规范。例如异常、并发、多线程等方面的处理方式。 其他规范。例如日志格式、属性文件格式,返回值和消息格式。 项目的编码规范可以参考已有的一些 Java 编程规范书籍和其他相关资料并 结合项目的本身来制定,可供参考的书籍有《 Java 编程风格》(英文书名为: The Elements of Java Style)。编码规范要形成文档,而且要简洁明了,并组 织项目成员一起学习,确保所有成员正确理解所有条目。 敏捷开发中高质量Java代码开发实践(2)时间:2011-06-16 IBM / 王永魁 王兆丽 刘颖一旦编码规范确定,就可以利用 Eclipse 自身提供的功能来控制代码样式和 格式。具体做法是,点击 Eclipse 的 Windows -> Preference 菜单项,在打开的 Preferences 对话框的左侧栏中找到 Java 节点下的子项 Code Style (如图 2),该项和它的子项允许您对 Java 代码的样式进行控制。 图 2. Eclipse 代码样式设置窗口 例如,为了使用自动格式化工具,可以在 Eclipse 提供的默认代码格式配置 的基础上建立自定义的格式。在Formatter面板中,点击New,输入新的名字并选 择一个默认的配置作为初始化格式,如图 3 所示。 图 3. 创建新的代码格式配置 敏捷开发中高质量Java代码开发实践(3)时间:2011-06-16 IBM / 王永魁 王兆丽 刘颖单击OK后就可以在新打开的窗口中进行修改定制自己需要的格式。如图 4 所 示。 图 4. 创建新的代码格式配置 修改完成后点击Apply保存所作修改。同时可以点击Export将当前的格式定义 导出成一个 XML 文件,这样项目组的其他成员就可以很方便通过点击图 3 中的 Import按钮来导入该 XML 文件来使用同一个代码格式定义。 这样每次在提交代码到版本控制服务器前就可以通过 Eclipse 界面里的 Source->Format菜单来对代 |
凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务,公司网站:http://www.lingzhong.cn 为了给广大客户了解更多的技术信息,本技术文章收集来源于网络,凌众科技尊重文章作者的版权,如果有涉及你的版权有必要删除你的文章,请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息,谢谢! |