《Java项目组开发规范》由会员分享，可在线阅读，更多相关《Java项目组开发规范（36页珍藏版）》请在金锄头文库上搜索。
1、用户使用手册目 录第一章 概述21.1 编写目的21.2 面面向读者者21.3 名名词解释释2第二章 程程序结构构32.1 包包结构32.2 相相关类3第三章 JJAVAA规范53.1 核核心原则则53.2 命命名规范范53.2.11 包、类类和接口口53.2.22 方法法53.2.33 变量量63.22.4 常量73.3 代代码结构构73.3.11 缩进进73.3.22 行宽宽83.3.33 换行行83.3.44 长度度103.3.55 括号号103.3.66 注释释113.3.77 声明明133.3.88 语句句143.4 异异常处理理183.5 其其他规范范19第四章 JJSP规规范20
2、4.1 JJSP文文件名命命名规则则204.2 JJSP头头格式204.3 JJSP页页面中按按钮的快快捷键214.4 SSERVVLETT命名规规则214.5 HHTMLL格式224.6 wweb.xmll书写规规范224.7 其其他规范范22第五章 数数据库规规范245.1 命命名规则则245.1.11 基本本规则245.1.22 常用用名称245.2 数数据类型型255.2.11 基本本规则255.2.22 常用用类型255.3 SSQL语语句255.4 注注释规则则265.5 JJDBCC操作265.6 优优化规则则265.7 注注意事项项27第一章 概述1.1 编写目的为规范FSSO
3、P项项目的开开发实施施工作，特特制定本本规范。为了提高软软件开发发质量，降降低开发发周期，增增强代码码的可重重用性和和易读性性，使软软件便于于维护，开开发人员员间便于于交流和和协作，特特总结出出开发规规范，以以为参考考。1.2 面向读者从事FSOOP项目目的开发发、实施施工作的的相关人人员。1.3 名词解释本节对手册册中涉及及到的术术语进行行简单描描述。第二章 程序结构2.1 包结构项目中的所所有代码码，必须须符合如如下的结结构：1、各子系系统的模模块：com.iicsss.fssop.suubsyys.moodulle.serrvleet.xxSSmmonn.uttil.xxxUmmonn.
4、haandeer.xxHHmmonn.sqql.xxSSmmonn.enntitty.xxxxx其中subbsyss是子系系统的名名称，mmoduule是是模块的的名称，xxServlet和xxHandler是模块下面的Servlet和Handler，允许有多个Servlet和Handler同时存在，建议同一个模块下，用多套Servlet和Handler处理不同的业务对象；util存放该模块专用的类；package/class可以任意级别的包或者类；2、子系统统之外的的模块：com.iicsss.fssop.sm.moddulee.sservvlett.xxxSeervlletcom.iics
5、ss.fssop. sm.ccommmon.utiil.xxUUtillcom.iicsss.fssop. sm.ccommmon.hannderr.xxxHaandeercom.iicsss.fssop. sm.ccommmon.sqll.xxxSqqlcom.iicsss.fssop. sm.ccommmon.enttityy.xxxxxx其中sm是是sysstemm maanagge的简简写，其其他同上上；3、公共的的类：mmonn.ppackkagee/cllasss含义同上。2.2 相关类1、对于SServvlett，必须须继承SServvlettBasse，必必须在SServvle
6、tt中处理理与reequeest和和ressponnse相相关的操操作，一一般是取取参数和和设置属属性等操操作；2、对于HHanddlerr，必须须继承HHanddlerrBasse，该该类的方方法中，不不能用rrequuestt和reespoonsee作为参参数，更更不能用用Serrvleet作为为参数；3、程序中中使用到到的SQQL，一一律在XXXXSSQLBBuillderr中进行行拼写，该该类属于于utiil包，需要继承SQLBuilderBase，其构造函数为私有类型，并且要实现静态方法getSQLBuilder(conn)，根据不用的数据库类型，返回不同的实例。第三章 JAVA规规
7、范3.1 核心原则1 软件件工程化化2 面向向对象3 能简简单不复复杂4 强调调团队协协作3.2 命名规范程序内的所所有标识识符（包包括包名名、类名名、接口口名、方方法名、变量名）都应由字母、数字和下划线组成，并以字母开头；统一采用英文命名，用词应当准确，禁止使用中英文混合的方式命名，如果可能的话，尽量使用有意义的英文单词或多个单词的缩写命名（缩写应该是被广泛使用的缩写），做到见名知意；标识符的长度应当符合“min-length & max-information”原则；程序中不要出现仅靠大小写区分的相似的标识符；在使用英文字母起标识作用时要注意，尽量不使用 “O”，“Z”，“I”等单个字符，
8、以避免与数字“0”，“2”，“1”混淆。3.2.1 包、类和接接口1、所有包包名全部部小写，只只能使用用英文字字母，不不得使用用数字和和其他符符号；2、类名使使用有意意义的英英文单词词或单词词的组合合，每个个单词的的首字母母大写，如果是是实现接接口的类类，可酌酌情使用用Impp结尾，英文单词一般为名词。3、接口名名使用有有意义的的名词和和形容词词的组合合，每个个单词的首首字母大大写，名名称前不不需要添添加前缀缀“I”，英文文字母ii的大写写。3.2.2 方法方法命名使使用动词词或“动词+名名词”的组合合，名称称的首字字母小写写，名称称中其他他词的首首字母大大写。对对于取值值的方法法(geett
9、eer mmethhod)，加“gett”作前缀缀；对于设设置的方方法(ssettter metthodd)，加加“sett”作前缀缀；对于布布尔型的的方法(boooleaan mmethhod)，加“is”作前缀缀；用正确确的反义义词组命命名具有有互斥意意义或相反动动作的函函数，例例如geetVaaluee(),settVallue()。 3.2.3 变量变量命名使使用名词词或名词词 “形形容词名词”的组合，名称的首字母小写，名称中其他词的首字母大写。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m 和n，它们一般用于整型；c，d，e，它们一般用于字符型。
10、用正确的反反义词组组命名具具有互斥斥意义的的变量，例如： innt mminVValuue和intt maaxVaaluee。尽量避免名名字中出出现数字字编号，如如Vallue11,Vaaluee2等，除除非逻辑辑上的确确需要编编号。命名应尽量量使用匈匈牙利命命名法，成成员变量量用长名名字，参参数和局局部变量量用短名名字，一一般由小写字字母开头头的单词词组合而而成。类类成员变变量前一一般应加加上m_，静态态变量应应加上ss_,紧紧接着是是变量的的类型（只只限于JJDK内内置类型型）。临时变变量应参参照如下下类似的的格式书书写，如如ltmmp ,tmmpSttr,ttemppStrr等。例如：m
11、_nTootallNumm,m_strrPatth,ss_bRRcviing类型前缀整型n,i长整型l无符号整型型u字符ch布尔量b浮点数f双精度浮点点d字符串str,ssz3.2.4 常量常量(sttatiic ffinaal 变变量)名名字的每每个字母母都大写写，并且且指出完完整含义义，词与与词之间间用下划划线分隔隔。3.3 代码结构代码组织要要清晰，严格控制函数的长度和每行代码的长度，,(,),if,else,do,while,for,case等要对应整齐，缩进全部用Tab键（4个空格）。变量的定义要集中，函数间要有空行分开，一个程序中的空行数目最好占8%-16%。多态函数和功能相近的函
12、数集中放在一起。代码应该简洁、清楚并讲述了所发生的一切，我们的目标应该是写出最清晰的代码，而不是最巧妙的代码。有些不易理理解的变变量或函函数应作作注释，难难懂的代代码要有有注解，在在文件的的开始处处有该文文件的用用途描述述。一定定要保持持注释的的一致性性。代码的重用用要仔细细，删掉掉从来没没有用过过的函数数或变量量，大篇篇幅注释释掉的代代码行也也应删除除，以免免使程序序混乱难难读。工工程中不不起作用用的文件件或类应应删除，工工程目录录下的非非工程文文件也应应该移走走，保持持工程的的清洁，避避免混淆淆难于管管理。3.3.1 缩进代码缩进是是指通过过在每行行代码前前键入空空格或制制表符的的方式，表
13、表示每行行代码之之间的层层次关系系。任何何编程语语言都需需要代码码缩进规规范程序序的结构构，采用用代码缩缩进的编编程风格格有利于于代码的的阅读和和理解。在本项目的开发中，统一采用TAB（4个空格）进行代码缩进。在遇到有关关类、结结构、函函数或过过程、以以及枚举举等等复复杂程序序结构的的定义的的时候，我我们通常常需要将将它的内内容缩进进一层。在在 C/C+/C#/Jaava 语言中中，大括括号是一一个非常常明显的的标志，凡凡是遇到到大括号号，都应应该直接接联想到到缩进。3.3.2 行宽当一条语句句太长而而超出一一定的宽宽度时，应应该折行行书写，尽尽量避免免一行的的长度超超过800 个字字符。3.
14、3.3 换行需要折行时时，从第第二行起起到该语语句结束束之间的的各行应应该缩进进一层，至至下一条条语句时时再恢复复原来的的缩进位位置。这这一点我我相信大大家都能能理解并并愿意遵遵循，然然而问题题的焦点点并不在在于要不不要换行行，而在在于在什什么位置置换行。当一个表达达式不能能在一行行内写完完，参照照下面的的标准换换行：逗逗号后换换行，操操作符后后换行，换换行时保保证代码码意义的的连贯性性。在换行时，我我们通常常在一个个变量或或者常量量之前换换行，把把逗号之之类的分分隔符、运运算符留留在前一一行的行行尾。函函数调用用时，如如果参数数个数很很多，或或者要传传递的表表达式写写起来很很长，那那么也会会涉及到到长语句句换行问问题；在在一些必必要的情情况下，我我们为了了清晰地地列出函函数的每每一个参参数，可可以每行行只书写写一个参参数，原原则是：尽可能能地在参参数与参参数之间间换行，并并将逗号号保留在在上一行行行末。下面是经常常使用的的一些换换行的示示例代码码：代码示例11：由于于代码过过长而进进行断行行bitmaap = neew BBitmmap(sizze.WWidtth, sizze.HHeiggh
