文档介绍：JAVA 编程规范
版本变更
Date
Version
Auther
Profile
目录
1. 适用范围 3
2. 设计类和方法 4
创建具有很强内聚力的类 4
创建松散连接和高度专用的方法 4
3. 编程原则 6
4. 命名约定 7
其他 8
5. 常量 9
10
定义有焦点的变量 10
只对常用变量名和长变量名进行缩写 10
使用统一的量词 10
使用肯定形式的布尔变量 10
为每个变量选择最佳的数据类型 10
尽量缩小变量的作用域 10
7. 格式化 12
对代码进行格式化时,要达到的目的 12
编程原则 12
8. 注释 14
目的 14
编程原则 14
注释哪些部分 16
示例 16
块注释 16
行注释 17
尾随注释 17
行尾注释 17
文档注释 17
9. 表达式和语句 18
每行只有一条语句 18
[if-else]、[if-else if]、[for]、[while]、[do…while()]语句,任何情况下,都应该有“{”,“}”, 18
switch语句,每个switch里都应包含default子语句 18
try-catch 18
10. 错误处理和异常事件 19
11. 封装与事务 19
12. 可移植性 19
适用范围
本规范适用于采用J2EE/或者使用Java开发的项目,所有项目中的JAVA代码(含JSP,SERVLET,JAVABEAN,EJB,ANDROID)均应遵守这个规范。同时,也可作为其它项目的参考。
设计类和方法
创建具有很强内聚力的类
类:将相关的方法组织在一起。
类的基本目的:创建相对独立的程序单元。
类创建的原则:“模块化”不同的程序单元。
方法的重要性往往比类的重要性更容易理解,方法是指执行一个统一函数的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥,将他们的所有方法放入单个类之中。之所以不能正确的认识类的功能,原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时,如果所有方法都放在单个类中或者放在几十个类中,这没有任何关系。虽然类的数量对代码的执行并无太大的影响,但当创建便于调试和维护的代码时,类的数量有时会带来很大的影响。
当类包含一组紧密关联的方法时,该类可以说具有强大的内聚力。当类包含许多互不相关的方法时,该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。
大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下,可以为这些不合群的方法创建一个综合性收容类。
创建松散连接和高度专用的方法
使所有方法都执行专门的任务
每个方法都应执行一项特定的任务,它应出色的完成这项任务。避免创建执行许多不同任务的方法。
创建专用方法有如下好处:
调试将变得更加容易。
维护变得更加简单。
可扩展性变得更加出色。
复用性变得更加简单。
业务逻辑组织变得更加清晰、简洁。
尽量使方法自成一体
通用方法建立的原则:
独立性:减少使用类变量。
形参:使用参数代替全局变量、静态变量。
当一个方法依赖于其他方法的调用时,称为与其他方法紧密连接的方法。紧密连接的方法会使调试和修改变得比较困难,因为它牵涉到更多的因素。松散连接的方法优于紧密连接,但不可能使每个方法都成为独立的方法。
创建方法时,设法将每个方法视为一个黑箱,其他例程不应要求了解该方法的内部工作情况,该方法也不应要求了解它外面的工程情况。
创建专用方法时,请考虑下列指导原则:
将复杂进程放入专用方法。如果应用程序使用复杂的数学公式,请考虑将每个公式放入它自己的方法中。这样使用这些公式的其他方法就不包含用于该公式的实际代码。这样也可以更容易发现与公式相关的问题。
将数据输入/输出(I/O)放入专用方法。
将专用方法中可能要修改的代码隔离。如果你知道某个进程经常变更,请将这个多变的代码放入专用方法,以便以后可以更容易的进行修改,并减少无意中给其他进程带来问题的可能性。
将业务规则封装在专用方法中。业务规则常属于要修改的代码类别,应与应用程序的其余部分隔开。其他方法不应知道业务规则,只有要调用的方法才使用这些规则。
设计类和方法的目的
创建更加容易调试和维护的方法。
创建具有强大内聚力的类。
创建高度专用的方法。
创建松散连接的方法。
尽量使方法具有独立性