敏捷开发中高质量Java代码开发实践.docx

本文将介绍在敏捷开发过程中如何通过采取一系列的步骤来保证和提高整个工程的代码质 量， 阐述了每一步可以利用的工具和最正确实践， 从而使开发过程更加标准化， 成就高质量 的代码。 概述 Java 工程开发过程中，由于开发人员的经验、代码风格各不相同，以及缺乏统一的标准和 管理流程， 往往导致整个工程的代码质量较差， 难于维护， 需要较大的测试投入和周期等问 题。 这些问题在一个工程组初建、 需求和设计均具有不完全可预期性和完备性的全新工程中 将尤为突出。 本文将结合敏捷开发周期短， 变化快等特点， 介绍如何通过在开发过程中采取 一系列步骤来保证和提高整个开发团队的代码质量， 并阐述了每一步可以利用的工具和最正 确实践，从而使开发过程更加标准化，成就高质量的代码，减少测试的投入，并促进整个团 队的技能提高，最终提高开发效率和质量。 如图 1 所示，敏捷开发过程经历需求调研，用例分析和用例分解，进入开发迭代阶段。在 每个迭代过程中， 可以采用以下五个步骤来保证和提高整个工程的代码质量： 统一编码标准、 代码样式；静态代码分析〔 static code review 〕；单元测试；持续集成；代码评审和重构 〔Review Refactor 〕。下文将针对每个步骤和其所使用的工具、方法进行详细描述。 图 1. 敏捷开发中的 Java 代码质量保证步骤 步骤一：统一编码标准、代码样式 标准统一的编码会增加工程代码的可读性和可维护性，但实际情况往往是工程组内的 Java 代码开发人员的编码风格常常各不相同， 这可能是由于不同的经验习惯或者缺乏编码标准方 面的学习造成的。 这样一来， 其他工程成员或者维护人员在阅读工程代码时就需要花费更多 的时间来理解代码作者的意图， 所以制定并采取统一的编码标准就显得很重要。 编码标准主 要应包含以下几个方面： ? ? ? ? ? 一般规那么和格式标准。例如代码缩进、程序块标准、每行最大代码长度等。 命名规那么。例如包名、类名、变量、方法、接口、参数等命名标准 文档标准。例如类文件头声明、类注释、成员变量和方法注释等标准。 编程标准。例如异常、并发、多线程等方面的处理方式。 其他标准。例如日志格式、属性文件格式，返回值和消息格式。 工程的编码标准可以参考已有的一些 Java 编程标准书籍和其他相关资料并结合工程的本 身来制定， 可供参考的书籍有 ? Java 编程风格 ?〔英文书名为： The Elements of Java Style 〕。 编码标准要形成文档， 而且要简洁明了， 并组织工程成员一起学习， 确保所有成员正确理解 所有条目。 一旦编码标准确定，就可以利用 Eclipse 自身提供的功能来控制代码样式和格式。具体做 法是，点击 Eclipse 的 Windows - Preference 菜单项，在翻开的 Preferences 对话框 的左侧栏中找到 Java 节点下的子项 Code Style 〔如图 2 〕，该项和它的子项允许您对 Java 代码的样式进行控制。 图 2. Eclipse 代码样式设置窗口 例如，为了使用自动格式化工具，可以在 Eclipse 提供的默认代码格式配置的根底上建立 自定义的格式。在 Formatter 面板中，点击 New，输入新的名字并选择一个默认的配置作 为初始化格式，如图 3 所示。 图 3. 创立新的代码格式配置 单击 OK 后就可以在新翻开的窗口中进行修改定制自己需要的格式。如图 4 所示。 图 4. 创立新的代码格式配置 修改完成后点击 Apply 保存所作修改。同时可以点击 Export 个 XML 文件， 这样工程组的其他成员就可以很方便通过点击图 该 XML 文件来使用同一个代码格式定义。 这样每次在提交代码到版本控制效劳器前就可以通过 Eclipse 将当前的格式定义导出成一 3 中的 Import 按钮来导入 界面里的 Sou