项目编码规范

项目代码编程规范

1.应用范围

本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）JS代码、HTML代码及数据库设计均应遵守这个规范。同时，也可作为其它项目的参考。

2.设计类和方法

2.1. 创建具有很强内聚力的类

方法的重要性往往比类的重要性更容易理解，方法是指执行一个独立逻辑的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。

之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。

类应该用来将相关的方法组织在一起。

当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。

大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。

创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。

2.2. 创建松散连接和高度专用的方法

2.2.1.使所有方法都执行专门的任务

每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。

创建专用方法有许多好处。首先调试将变得更加容易。

2.2.2.尽量使方法成为自成一体的独立方法

当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法

会使调试和修改变得比较困难，因为它牵涉到更多的因素。松散连接的方法优于紧密连接的方法，但你不可能使每个方法都成为独立的方法。

若要使方法具备较强的独立性，方法之一是尽量减少类变量。

创建方法时，设法将每个方法视为一个黑箱，其他例程不应要求了解该方法的内部工作情况，该方法也不应要求了解它外面的工程情况。这就是为什么你的方法应依靠参数而不应依靠全局变量的原因。

创建专用方法时，请考虑下列指导原则：

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)给方法命名时应大小写字母混合使用。如果句子全使用大写字母，那么阅读起来就非常困难，而大小写字母混合使用的句子，阅读起来就很容易。

2)定义方法名时不要使用缩写。如果你认为应用程序中的某些工程应使用缩写，那么请将这些情况加上注释，并确保每个人在所有时间内都使用这些缩写。决不要在某些方法中对某些单词进行缩写，而在别的方法中却不使用缩写。

3)定义方法名要统一使用英文单词或者计算机专业英语，要做到见名知意。

2.4.2.创建方法时，始终都应显式地定义它的作用域。

1) 如果你真的想创建一个公用方法，请向代码阅读者说明这一点。

2) 通过为每个方法赋予一个明确定义的作用域，可以减少代码阅读者需要投入的工作量。应确保你为方法赋予最有意义的作用域。如果一个方法只被同一类中的另一个方法调用，那么请将它创建成私有方法。如果该方法是从多个类中的多个方法中调用，请将该说明为公用方法。

2.4.

3.用参数在方法之间传递数据

应尽量避免使用类变量。一般来说，变量的作用域越小越好。为了减少类变量，方法之一是将数据作为参数在不同方法之间传递，而不是让方法共享类变量。

1)为每个参数指定数据类型。

2)始终要对数进行检验，决不要假设你得数据没有问题。程序员常犯的一个错误是在编写方法时假设数据没有问题。在初始编程阶段，当编写调用方法时，这样的假设并无大碍。这时你完全能够知道什么是参数的许可值，并按要求提供这些值。但如果你不对参数的数据进行检验，那么下列情况就会给你带来很大麻烦：另外某个人创建了一个调用方法，但此人不知道允许的值；你在晚些时候添加了新的调用方法，并错误的传递了坏数据。

2.4.4.其他编程建议

1.注意释放资源，如文件关闭，数据库操作后关闭ResultSet, Statement, Connection等，其

他涉及IO操作的如:各种Reader，Writer，InputStream，OutputStream等等。

2.使用StringBuffer 对象

3.在处理String 的时候要尽量使用StringBuffer 类，StringBuffer 类是构成String 类的基

础。String 类将StringBuffer 类封装了起来，（以花费更多时间为代价）为开发人员提供

了一个安全的接口。当我们在构造字符串的时候，我们应该用StringBuffer 来实现大部

分的工作，当工作完成后将StringBuffer 对象再转换为需要的String 对象。比如：如果

有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用

StringBuffer 对象和它的append() 方法。如果我们用String 对象代替StringBuffer 对象

的话，会花费许多不必要的创建和释放对象的CPU 时间。

4.避免太多的使用synchronized 关键字

5.避免不必要的使用关键字synchronized，应该在必要的时候再使用它，这是一个避免死

锁的好方法。必须使用时，也尽量控制范围，最好在块级控制。

6.避免使用等那些在前就有的集合类

7.因为"Unlike the new collection implementations, Vector is synchronized."，所以使用类在性

能上会有所减低。

8.尽量使用接口而不是一个具体的类

9.比方如下需求，给定一个SQL语句，返回一个对象的列表，实现中用实现，于是定义方

法为：

10.public getObjectItems(String sql)

11.上面的方法存在一个问题，当getObjectItems内改用Vector或LinkedList实现，外部类

必须做相应更改。一个更好的方法是定义返回值为更合适：

12.public getObjectItems(String sql)

13.这样即使更改实现，外部类也不必做相应更改。

14.避免使用索引来调用数据库中间层组件返回的结果集

15.如：

16.for(int i=1; i<=(); i++)

{ String field1 = (i, 0).toString(); ……}

而应用字段名来存取结果集：

for(int i=1; i<=(); i++)

{ String field1 = (i, "field1").toString(); ……}

这样在数据库设计更改或查询的SQL语句发生变化时，不会影响到程序的执行。

3.命名约定

所有变量的定义应该遵循匈牙利命名法，由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。

3.1. 工程的命名

3.1.1.工程的命名

直接使用projectname.

3.1.2.工程目录的分配(参照各类开发工具的设置)

1.设计文档(design)：design

2.源代码(source)：src.

3.引用的库文件(library)：lib

4.生成的代码(class)：classes

5. 生成的文档(document)：docs

3.2. 包

3.2.1.约定

●根级目录以com.**开头！

●各项目名称为下一级包！本级目录为项目的控制类所在(即：实现主要流程的类和涉及项目系统

管理的类)。

●再下级的主要并列目录名：

1)Cloudframework 云存储开发框架包

2)Cngi 具体的应用系统名

●全部小写

●使用英语单词，不要使用汉语拼音

●标识符用点号分隔开来

3.2.2.举例

3.3. 类，接口

3.3.1.约定

●类的名字应该使用名词

●使用英语单词，不要使用汉语拼音

●每个单词首字母应该大写

●避免使用单词的缩写，除非它的缩写已经广为人知，如HTTP

●实现类一般采用接口类名+Impl来展现

3.3.2.举例

Class Hello;

Class HelloWorld ;

Interface Apple;

Class AppleImpl implements Apple;

3.4. 方法

3.4.1.约定

●第一个单词一般是动词。

●使用英语单词，不要使用汉语拼音

●第一个单词是小写，但是中间单词的首字母是大写。

●如果方法返回一个成员变量的值，方法名一般为get+成员变量名，如若返回的值是bool

变量，一般以is作为前缀。

●如果方法修改一个成员变量的值，方法名一般为：set+成员变量名。

3.4.2.举例

getName();

setName();

isFirst();

3.5. 变量

3.5.1.约定

●单词的首字母大写；但是首个单词字母都必须小写

●使用英语单词，不要使用汉语拼音

●不要用_或&作为第一个字母。

●尽量使用短而且具有意义的单词。

●单字符的变量名一般只用于生命期非常短暂的变量。i,j,k,m,n一般用于int/integers；

c,d,e一般用于characters。

●如果变量是集合，则变量名应用复数。

●boolean/ Boolean类型的使用is前缀

●命名组件采用匈牙利命名法。

3.5.2.举例

String fileName;

int[] students;

int i;

int n;

boolean isPass;

3.6. 常量

3.6.1.约定

●所有常量名均全部大写，单词间以‘_’隔开。

●使用英语单词，不要使用汉语拼音

●特殊情况下可以使用全拼，但是请注释说明

3.6.2.举例

int I_MAX_NUM;

3.7. jsp,html,xml等文件

3.7.1.约定

●使用英语单词，不要使用汉语拼音

●首单词小写，其它单词首字母应该大写

●避免使用单词的缩写，除非它的缩写已经广为人知，如HTTP

3.7.2.举例

注册，新增

查询页面视图

维护页面视图

按日期查询页面视图

3.8. 数据库表、视图

3.8.1.约定

●全部小写

●以“_”分隔单词

●尽量表义

●使用英语单词，不要使用汉语拼音

●主表用“info”表示，

●每个表名都加“t_”用来识别为表对象

3.8.2.举例

t_user_info 缩写ui 用户主表

t_user_type 用户类型字典表

3.9. 数据库字段

3.9.1.约定

●首单词小写，其他单词首字母大写

●使用英语单词，不要使用汉语拼音

3.9.2.举例

id

name

userType

userId

4.使用常量

4.1. 常数很容易在数据输入时出错

常数存在的主要问题之一是你很容易在键入数字时出错，从而颠倒了数字的位置。例如，当你键入数字10876时，很容易的键入10867或18076。与处理变量和保留字的方法不同，编译器并不在乎颠倒了位置和不正确的数字，有时简单的错误造成的问题不会立即表现出来，而当问题表现出来时，它们会以随机的计算错误的形式出现，这些错误很难准确定位。用常量来取代常数时，编译器将在编译时检查常量的有效性。如果常量不存在，编译器便将这一情况通知你，并拒绝进行编译，这可以消除错误键入的数字带来的问题，只要常量拥有正确的值，使用该常量的所有代码也有使用该正确值。

4.2. 常数很难不断更新

4.3. 常量使代码更容易阅读

使用常量后，得到的一个额外好处是可使创建的代码更容易阅读。常数很不直观。也许你对常数非常了解，但其他人则根本看不明白。通过合理的给常量命名，使用这些常量的代码就变得比较直观了，更容易阅读。

为常量赋予较宽的作用域，这与使用变量时的情况不同。在一个应用程序中你决不应该两次创建相同的常量。如果你发现自己复制了一个常量，请将原始的常量说明转至较宽的作用域，直到该常量可供引用它的所有方法为止。

5.变量

5.1. 定义有焦点的变量

用于多个目的的变量称为无焦点（多焦点）的变量。无焦点变量所代表的意义与程序的执行流程有关，当程序处于不同位置时，它所表示的意义是不固定的，这样就给程序的可读性和可维护性带来了麻烦。

5.2. 只对常用变量名和长变量名进行缩写

如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性。例如，如果在代码的某些区域中使用Cnt，而在另一些区域中又使用Count，就会给代码增加不必要的复杂性。

变量名中尽量不要出现缩写。

5.3. 使用统一的量词

通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。例如，请使用strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。

量词列表：First、Last、Next、Prev、Cur

量词后缀

说明

First 一组变量中的第一个

Last 一组变量中的最后一个

Next 一组变量中的下一个变量

Prev 一组变量中的上一个

Cur 一组变量中的当前变量

5.4. 使用肯定形式的布尔变量

给布尔变量命名时，始终都要使用变量的肯定形式，以减少其它开发人员在理解布尔变量所代表的意义时的难度。

5.5. 为每个变量选择最佳的数据类型

这样即能减少对内存的需求量，加快代码的执行速度，又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下，编译器不会产生运行期错误，它只是迫使该值符合数据类型的要求。这类问题极难查找。

5.6. 尽量缩小变量的作用域

如果变量的作用域大于它应有的范围，变量可继续存在，并且在不再需要该变量后的很长时间内仍然占用资源。

它们的主要问题是，任何类中的任何方法都能对它们进行修改，并且很难跟踪究竟是何处进行修改的。

占用资源是作用域涉及的一个重要问题。对变量来说，尽量缩小作用域将会对应用程序的可靠性产生巨大的影响。

6.代码的格式化

6.1. 对代码进行格式化时，要达到的目的

1.通过代码分割成功能块和便于理解的代码段，使代码更容易阅读和理解；

2.使用空行和注释行，将程序中逻辑上不相关的代码块分开。比如：变量声明部分和代码语句间的分隔；较长的方法中，完成不同功能的代码块间的分隔。要避免出现逻辑上混乱的分隔，如：某一逻辑功能代码块中间用空行进行了分隔，但是在相邻功能代码块之间却没有分隔，这样会给程序阅读者造成错觉。

3.减少为理解代码结构而需要做的工作；

4.使代码的阅读者不必进行假设；

5.使代码结构尽可能做到格式清楚明了。

6.2. 编程原则

1.不要将多个语句放在同一行上。不论是变量声明，还是语句都不要在一行上书写多个。

2.缩进后续行

当你将变量设置为某个值时，所有后续行的缩进位置应与第一行的变量值相同；

当你调用一个方法时，后续行缩进到第一个参数的开始处；

当你将变量或属性设置为等于表达式的计算结果时，请从后面分割该语句，以确保该表达式尽可能放在同一行上。

3.在if语句后缩进；

在else语句后缩进

在switch语句后缩进

在case语句后缩进

在do句后缩进

已经用行接续符分割的语句的各个行要缩进

对从属于行标注的代码进行缩进。

4.在执行统一任务的各个语句组之间插入一个空行。好的代码应由按逻辑顺序排列的进程或相关语句组构成。

7.代码的注释

7.1. 使用代码注释的目的

1.文字说明代码的作用(即为什么要用编写该代码,而不是如何编写);

2.确指出该代码的编写思路和逻辑方法;

3.方便人们注意到代码中的重要转折点;

4.使代码的阅读者不必在他们的头脑中仿真运行代码的执行方法.

5.说明代码的使用条件。

7.2. 编程原则

7.2.1.用文字说明代码的作用:

简单的重复代码做写什么,这样的注释几乎不能给注释增加什么信息.如果你使用好的命名方法来创建直观明了的代码那么这些类型的注释绝对增加不了什么信息.

7.2.2.如果你想违背好的编程原则,请说明为什么

有的时候你可能需要违背好的编程原则，或者使用了某些不正规的方法，.遇到这种情况时,请用内部注释来说明你在做什么和为什么要这样做。

技巧性特别高的代码段，一定要加详细的注释，不要让其他开发人员花很长时间来研究一个高技巧但不易理解的程序段。

7.2.3.用注释来说明何时可能出错和为什么出错

7.2.4.在编写代码前进行注释

给代码加注释的方法之一是在编写一个方法前首先写上注释.如果你愿意,可以编写完整句子的注释或伪代码.一旦你用注释对代码进行了概述,就可以在注释之间编写代码.

7.2.5.在要注释的代码前书写注释

注释一定出现在要注释的程序段前，不要在某段程序后书写对这段程序的注释，先看到注释对程序的理解会有一定帮助。

如果有可能，请在注释行与上面代码间加一空行。

7.2.6.纯色字符注释行只用于主要注释

注释中要分隔时，请使用一行空注释行来完成，不要使用纯色字符，以保持版面的整洁、清晰。

7.2.7.避免形成注释框

用星号围成的注释框，右边的星号看起来很好,但它们给注释增加了任何信息吗?实际上这会给编写或编辑注释的人增加许多工作。

7.2.8.增强注释的可读性

注释是供人阅读的，而不是让计算机阅读的。

1)使用完整的语句。虽然不必将注释分成段落（最好也不要分成段落），但你应尽量将注释写成完整的句子。

2)避免使用缩写。缩写常使注释更难阅读，人们常用不同的方法对相同的单词进行缩写，这会造成许多混乱，如果必须对词汇缩写，必须做到统一。

3)将整个单词大写，以突出它们的重要性。若要使人们注意注释中的一个或多个单词，请全部使用大写字母。

7.2.9.对注释进行缩进，使之与后随的语句对齐。

注释通常位于它们要说明的代码的前面。为了从视觉上突出注释与它的代码之间的关系，请将注释缩进，使之与代码处于同一个层次上。

7.2.10.为每个方法和类赋予一个注释标头

每个方法都应有一个注释标头。方法的注释标头可包含多个文字项，比如输入参数、返回值、原始作者、最后编辑该方法的程序员、上次修改日期、版权信息。

7.2.11.当行尾注释用在上面这种代码段结构中时，它们会使代码

更难阅读。

使用多个行尾注释时（比如用于方法顶部的多个变量说明），应使它们互相对齐。这可使它们稍容易阅读一些。

7.2.12.何时书写注释

1)请在每个if语句的前面加上注释。

2)在每个switch语句的前面加上注释。与if语句一样，switch语句用于评估对程序执行产生

影响的表达式。

3)在每个循环的前面加上注释。每个循环都有它的作用，许多情况下这个作用不清楚直观。

7.3. 注释那些部分

7.3.1.类

类的目的

参数：参数类型参数用来做什么

任何约束或前提条件

已知的问题

类的开发/维护历史

注释出采用的不变量

并行策略

编译单元

每一个类/类内定义的接口，含简单的说明

文件名和/或标识信息

版权信息

7.3.2.接口

目的

它应如何被使用以及如何不被使用

7.3.3.类属性

用处

目的

不同值的含义

7.3.4.成员函数注释

成员函数做什么以及它为什么做这个

哪些参数必须传递给一个成员函数

成员函数返回什么

已知的问题

任何由某个成员函数抛出的异常

可见性决策

成员函数是如何改变对象的

包含任何修改代码的历史

如何在适当情况下调用成员函数的例子适用的前提条件和后置条件

7.3.5.成员函数内部注释

控制结构

代码做了些什么以及为什么这样做

局部变量

难或复杂的代码

处理顺序

对if-else语句的各个条件，要说明其含义。

7.4. 示例

7.4.1.块注释：

主要用来描述文件，类，方法，算法等。一般用在文档和方法的前面，也可以放在文档的任何地方。以‘/*’开头，‘*/’结尾。例：

……

/*

* 注释

*/

……

7.4.2.行注释：

主要用在方法内部，对代码，变量，流程等进行说明。与块注释格式相似，但是整个注释占据一行。例：

……

/* 注释 */

……

7.4.3.尾随注释：

与行注释功能相似，放在代码的同行，但是要与代码之间有足够的空间，便于分清。例：

int m=4 ; /* 注释 */

如果一个程序块内有多个尾随注释，每个注释的缩进应该保持一致。

7.4.4.行尾注释：

与行注释功能相似，放在每行的最后，或者占据一行。以‘商务公用组件单独封装

2.每一个业务流程单独封装

3.一次方法（组件）的调用应能完成某一项功能或流程，即符合完整性

4.一次方法（组件）的调用符合ACID事务性

5.多次方法（组件）的调用应包含在一个事务中

8.可移植性

1.尽量不要使用已经被标为不赞成使用的类或方法。

2.如果需要换行的话，尽量用 println 来代替在字符串中使用"\n"。

3.用separator()方法代替路径中的“/”或“\”。

4.用pathSeptarator()方法代替路径中的“: ”或“;”。

9.最要注意的问题

1、缩进

缩进以4个空格为单位。预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书写。

语句块的"{"、"}"配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个"{"、"}"单独占一行，便于匹对。

2、空格

变量、类、常量数据和函数在其类型，修饰名称之间空格并据情况对齐。

3、对齐

原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在","处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“{”应与首行对齐。

4、空行

不得存在无规则的空行。程序文件结构各部分之间空两行，各函数实现之间一般空两行，有函数说明或注释，只需空一行或不空。对自己写的函数，加上“//------”做分隔。

5、注释

注释是软件可读性的具体体现。程序注释量一般占程序编码量的20%，软件工程要求不少于20%。程序注释不能用抽象的语言，类似于"处理"、"循环"这样的计算机抽象

语言，要精确表达出程序的处理说明。注释必不可少，但也不应过多，不要被动的为写注释而写注释。

6、代码长度

对于每一个函数建议尽可能控制其代码长度为53行左右，超过53行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该一不破坏原有算法为基础，同时拆分出来的部分应该是可以重复利用的。

7、页宽

页宽应该设置为80字符。源代码一般不会超过这个宽度, 并导致无法完整显示。

8、符号风格

对于各种符号的定义，应该使用有实际意义的英文单词或英文单词的缩写，不要使用简单但没有意义的字串，尽可能不使用阿拉伯数字，更切忌使用中文拼音的首字母。