正 文

J2EE项目执行:若干最佳实践


www.7dspace.com  更新日期:2006-1-14 5:58:57  七度空间


  虽然在几乎所有的项目中一些相同的问题不断重复出现,但是我们仍然缺少明确的方法来解决它们。在软件开发的职业生涯中,我使用了一些方法来解决这些重复出现的困扰我的大部分开发项目的问题,这些方法真正有助于项目执行效率的提升。本文中,我将与各位分享3项项目执行的最佳实践,其中的某几个方法有充分的资格可以被认定为模式(pattern)。

  · 使用模板代码

  · 编写高效的开发手册

  · 执行自动化代码检查

  使用模板代码

  开发者可以从参考简单的业务用例和复杂的业务用例的示例代码实现中获得帮助,编写出有效、高效率的代码。考虑下面的一些经常困扰软件开发项目的因素:

  · 技术始终在变化,要找到对于新技术具有使用经验的有竞争力的技术人员是很困难的事情(译注: 去做猎头吧!)。另一方面,开发新手可能不具备编写有效正确代码的经验。模板代码为开发者的工作提供了良好的参考,使得学习新技术变的相对简单。

  · 学习利用新技术需要时间,而且如果使用不当可能导致一团混乱,因此强迫开发者自己学习新技术不是很好的途径。 作为替代方法,提供模板代码作为开发者编码的参考使得开发者在开发过程中获得了学习新技术的良好起点。

  · 许多项目必须由有限的人员在紧迫的期限内完成。项目团队中的每个人都不应该重新造轮子。高级技术人员可能在设计阶段提供帮助,不过项目进行到实现阶段可能就要求程序员自助了。一不留意的小问题,到了发现的时候可能已经造成了混乱。问问自己,使用Javadoc工具的时候,有几次遵循了标准的格式和文档生成指导方针呢?代码是否遵循了定义良好的习惯用法和最佳实践呢?那么如何贯彻这些良好实践呢?此处,可视的模板代码能够提供比技术书籍或者参考手册更有效的帮助,因此,应该使用模板代码。

  · 许多软件项目不仅体积庞大,而且分布式地进行开发。有时,项目的执行是同时在世界上的不同地点展开的。作为开发人员你不想看到——当你的项目部分接近完成时,你的代码的客户惊奇的发现你的代码没有满足他们的需求。应该在开始编写代码实现功能前,将示例代码送给你的客户评审,并记录反馈。这些示例代码不应该仅仅是类似”世界,你好”的程序,应该具有代表性,与实际编写的代码很接近。

  · 通常开发者都有一堆参考手册、标准、程序框架等资料,可以在项目中通过它们来获得帮助。但是,即使已经完成了设计工作,编码的风格也不是显而易见的,难以遵守。可视的模板代码可以提供这方面的帮助。除非开发者可以看到真实的代码例程,否则他们对当前项目的解释彼此间可能有些许的出入。一个简单功能由多个开发者来实现,其实现方式可能是不同的,甚至可能没有一个与推荐的模拟最佳实现的方式相同。

  模板代码的实现

  首先,召集一组专家(技术上的和业务上的)从目标项目的问题域中甄别出简单用例和复杂用例各一个,并在现有设计的基础上分别实现这两个用例。这样,项目组就拥有了自己的模板代码。下面列出了一些编写模板代码的小技巧

  · 模板代码中应该包含立即可用的编译和部署脚本。否则,在开发的构建阶段解决这些问题又要浪费不少时间。

  · 项目的基本目录结构应该准备完毕,并且包含了欲在项目中使用的各种库。

  · 模板代码应该遵循项目中使用的命名规范、代码风格、其它标准以及应用框架的要求。

  · 模板代码中应该使用定义良好的Javadoc模板(比如、基于Eclipse的Javadoc模板),以帮助开发人员编写javadoc注释。编写良好的javadoc注释是很重要的,通常这些注释可能是代码维护和再开发团队的唯一可用的文档。

  · 程序语言中明确的编码惯用法应该在模板代码中使用,这有助于开发者编写有效的代码。

  · 模板代码应该明确定义使用开发框架的标准方法。对于新的开发者来说,在项目的初始构建阶段编写基于特定框架的实现类是很困难的任务。示例代码有助于新的开发者理解框架等概念。即使框架有许多文档,利用框架进行有效率的开发也并不都是很容易。

  · 模板代码应该展示如何利用JUnit或其他测试框架编写测试用例(test cases)。

  · 客户的技术团队应该评审这些模板代码,这样他们对于在项目构建阶段结束时的代码质量具有更明确的认识,而不会在最后时刻感到意外。

  · 模板代码应该从头到尾的涵盖用例,比如从表示层到数据层。

  · 对于模板代码的各种细枝末节应该进行一次详尽的介绍,使得开发者熟悉它们。开发者应该理解在架构的每个层次需要做那些工作、使用了(或者可能使用)那些编码惯用法和最佳实践,以及为什么使用它们。

  使用模板代码的好处

  · 开发者获得开始编写代码的参考

  · 客户与开发者就项目预期质量达成一致,因而避免了通常由于理解差异产生的各种问题。

  · 开发者拥有了开始编码工作的骨架。

  · 开发者更容易掌握并应用项目中使用的开发框架和各种外部API,这有助于提高开发效率。

  · 开发者没有重新造轮子。大部分的最佳开发实践和编码惯用法都摆在了他们面前,这也可以提高开发效率。

4页,页码:[1] [2] [3] [4] 

上一篇:网络冲突是怎样发生的?
下一篇:SOAP封装的问题
标题:J2EE项目执行:若干最佳实践 作者:ShriKant Vashishthav 来源:matrix
收藏此页】【打印】【关闭
站 内 搜 索
 

热 点 导 读
特 别 推 荐