项目编码规范.pdfVIP

项目编码规范 应用研发中心 项目代码编程规范 1. 应用范围 本规范应用于采用 J2EE 规范的项目中， 所有项目中的 JAVA代码 （含JSP，SERVLET，JAVABEAN， EJB）JS 代码、 HTML代码及数据库设计均应遵守这个规范。同时，也可作为其它项目的参考。 2. 设计类和方法 2.1. 创建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解，方法是指执行一个独立逻辑的一段代码。类 常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的 发挥，将他们的所有方法放入单个类之中。 之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一 个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然 类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时 会带来很大的影响。 类应该用来将相关的方法组织在一起。 当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关 的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。 大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以 为这些不合群的方法创建一个综合性收容类。 创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程 序单元。 2.2. 创建松散连接和高度专用的方法 2.2.1. 使所有方法都执行专门的任务 每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同 任务的方法。 创建专用方法有许多好处。首先调试将变得更加容易。 2.2.2. 尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法 第 1 页 总计 19 页 项目编码规范 应用研发中心 会使调试和修改变得比较困难，因为它牵涉到更多的因素。松散连接的方法优于紧密连接的方 法，但你不可能使每个方法都成为独立的方法。 若要使方法具备较强的独立性，方法之一是尽量减少类变量。 创建方法时，设法将每个方法视为一个黑箱，其他例程不应要求了解该方法的内部工作情 况，该方法也不应要求了解它外面的工程情况。这就是为什么你的方法应依靠参数而不应依靠 全局变量的原因。 创建专用方法时，请考虑下列指导原则： 1) 将复杂进程放入专用方法。如果应用程序使用复杂的数学公式，请考虑将每个公式放入它自 己的方法中。这样使用这些公式的其他方法就不包含用于该公式的实际代码。这样也可以更容 易发现与公式相关的问题。 2) 将数据输入 / 输出（ I/O ）放入专用方法。 3) 将专用方法中可能要修改的代码隔离。如果你知道某个进程经常变更，请将这个多变的代码 放入专用方法， 以便以后可以更容易的进行修改， 并减少无意中给其他进程带来问题的可能性。 4) 将业务规则封装在专用方法中。业务规则常属于要修改的代码类别，应与应用程序的其余部 分隔开。其他方法不应知道业务规则，只有要调用的方法才使用这些规则。 2.3. 设计类和方法时，要达到下列目的： 1) 创建更加容易调试和维护的方法 2) 创建具有强大内聚力的类 3) 创建高度专用的方法 4) 创建松散连接的方法 5) 尽量使方法具有独立性 6) 提高方法的扇入性 7) 降低方法的扇出性 2.4. 编程原则 2.4.1. 为方法和类赋予表义性强的名字 为了使代码更加容易理解，最容易的方法之一是为你的方法赋予表义性强的名字。函数名 DoIt 、GetIt 的可读性很难与 CalculateSalesTax 、 RetrieveUserID 相比。 由缩写方法名组成的代码很难理解和维护，没有理由再这样做了。 给方法正确的命名，可使程序工程的调试和维护工作大大的改观。请认真对待方法命名的 工作，不要为了减少键入操作量而降低方法的可理解度。 实际应用举例： 1