Java项目组开发规范.docxVIP

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