Java项目组开发规范.docx

Java项目组开 发规范
第一章概述2
1. 1编写目2
1' 2面向读2
3名词讲2
第二章程序构 3
八4
1包结构3
2. 2有关类3
第三章JAVA规范 4
3. 1核心原4
3： 2命名规4 ・ ■ •
2. 1 包、接口 4
2. 2方法4
2. 3变量4
2. 4常量5
3代码结6 t ，
3. 1缩进6
3. 2行宽6
3. 3换行6
3. 4长度8
3. 5括号9
3. 6注释9
3. 7 声明 11
语句 11

37 5其他规16
第四章JSP 范 17
1 JSP文件名命名规 4'2 JSP头格式17
17
3 JSP页面中按钮的快捷键18
4SERVLET命名规则18
4. 5 HTML 格式 18
6web. xml书写规范19
7其他规范19
第五章数据库规范20
1命名规则20
1. 1差不多规则20

2数据类型20
2. 1差不多规则20

3 SQL 语句 21
4注释规则21
5 JDBC 操作 21
6优化规则22
7注意事项22
概述
编写目的
为规范FSOP项目的开发实施工作，特制定本规范。
为了提升软件开发质量，降低开发周期，增强代码的可重用性和易读 性，使软件便于爱护，开发人员间便于交流和协作，特总结出开发规范，以 为参考。
面向读者
从事FSOP项目的开发、实施工作的有关人员。
名词讲明本节对手册中涉及到的术语进行简单描述。
程序结构
包结构
项目中的所有代码，必须符合如下的结构：
1、各子系统的模块：
com. icss. f sop. {subsys). {module}. servlet. [xxServlet] 其中 subsys是子系统的名称，module是模块的名称，xxServlet和xxH andler是模块下面的Servlet和Handler,承诺有多个Servlet和 Handler同时 存在，建议同一个模块下，用多套Servlet和Handler处 理不同的业务对象；util存放该模块专用的类；package/class能够任 意级不的包或者类；
2、子系统之外的模块：
com. icss. f sop. sm. {module}. servlet. [xxServlet] 其中 sm 是 system manage的简写，其他同上；
3、公共的类：
含义同上。
有关类
1、关于Servlet,必须继承ServletBase,必须在Servlet中处 理与reque st和response有关的操作，一样是取参数和设置属性等操 作；
2、关于Handler,必须继承HandlerBase,该类的方法中，不能用 requ est和response作为参数，更不能用Servlet作为参数；
3、程序中使用到的SQL, 一律在XXXSQLBuilder中进行拼写，该类 属于util包，需要继承SQLBuilderBase,其构造函数为私有类型，同 时要 实现静态方法getSQLBui Ider (conn),按照不用的数据库类型，返 回不同的实例。
JAVA规范
核心原则
.软件工程化
.面向对象
.能简单不复杂
.强调团队协作
命名规范 程序内的所有标识符(包括包名、类名、接口名、方法名、变 量名)都应由字母、数字和下划线组成，并以字母开头；统一采纳英文命 名，用词应当准确，禁止使用中英文混合的方式命名，如果可能的话，尽量 使用有意义的英文单词或多个单词的缩写命名(缩写应该是被广泛使用的缩 写)，做到见名知意；标识符的长度应当符合“ min-length && maxinformation" 原则；程序中不要显现仅靠大小写区分的相似的标识符；在 使用英文字母起标识作用时要注意，尽量不使用“。”，"Z”，“I”等单 个字
符，以幸免与数字“ 0”，“ 2”，“1”混淆。
包、类和接口
1、所有包名全部小写，只能使用英文字母，不得使用数字和其他符 号；
2、类名使用有意义的英文单词或单词的组合，每个单词的首字母大 写，如果是实现接口的类，可酌情使用Imp结尾，英文单词一样为名词。
3、接口名使用有意义的名词和形容词的组合，每个单词的首字母大 写，名称前不需要添加前缀“ I ”，英文字母i的大写。
方法
方法命名使用动词或“动词+名词”的组合，名称的首字母小写，名称 中其他词的首字母大写。关于取值的方法(getter method),加“get” 作前缀；关于设置的方法(setter method),加“ set”作前