JAVA应用系统开发规范.doc

PAGE 2 应用系统项目开发规范 软件开发规范文档说明书V1.3 文档修订控制 序号 版本号 修订日期 修订概述 修订人 审批人 备注 项目环境概述： 框架版本 spring-framework-3.1.1 struts- mybatis-3.1.1 jquery-easyui-1.3.2 开发环境 JDK 1.6 ORACLE 11g MyEclipse 10.7 中间件 Tomcat 6 WebLogic 11 目录 TOC \o 1-7 \h \z \u 1 目录 3 2 引言 6 3 综述 6 4 开发规范 6 4.1 系统命名规则 6 4.1.1 包命名： 6 4.1.2 类命名： 7 4.1.3 接口命名： 7 4.1.4 方法命名： 7 4.1.5 变量命名： 7 4.1.6 常量命名： 8 4.1.7 参数命名： 8 4.1.8 Mapper命名： 8 4.1.9 CRUD操作命名： 9 4.1.10 视图层命名规则： 9 4.2 系统编码规范 10 4.2.1 注释规范： 10 4.2.2 DAO层编码规范： 10 4.2.3 MyBatis Mapper规范： 14 包名规范： 14 命名规范： 14 指向规范： 14 示例代码： 14 注意事项： 15 4.2.4 Model层编码规范： 16 4.2.5 Service层编码规范： 16 4.2.6 Controller层编码规范： 19 4.2.7 Utils工具类编码规范： 21 4.2.8 AOP类编码规范： 22 4.2.9 Exception类编码规范： 23 4.2.10 Spring注解规范： 24 4.2.11 单元测试规范： 27 单元测试目录结构图： 28 单元测试目录结构介绍： 28 4.3 数据库设计规范 28 4.3.1 命名约定 28 4.3.2 命名规范 29 表 29 字段 29 主键 29 索引 30 外键 30 视图 30 存储过程 30 触发器 30 函数 30 0 包 30 1 序列 30 4.3.3 数据类型 31 日期类型 31 大字段 31 字符型 31 数字类型（或整型） 31 Identity和sequence使用 32 可移植数据类型 32 4.3.4 设计规范 32 范式 32 索引 33 主键 33 外键 33 NULL值 33 注释 33 移植性 33 4.4 系统包目录结构 34 4.4.1 下面是系统包目录结构： 34 src目录结构： 35 .1 市民网项目包名 35 .1.1 系统公共模块 common 35 .1.2 市民网子系统模块 citizen 36 .1.2.1 市民网-民办模块 36 .1.2.2 市民网-消息推送模块 36 .1.2.3 市民网-用户模块 36 .1.2.4 市民网-外部服务模块 36 .1.2.5 市民网-互动模块 37 .1.3 系统配置模块 config 37 WebRoot目录结构： 37 .1 皮肤资源目录 37 .2 公共资源目录 38 .3 JSP资源目录 38 5 附录 38 5.1 SQL优化 38 5.1.1 选择最有效的表名顺序： 39 5.1.2 WHERE子句中的连接顺序： 39 5.1.3 SELECT子句中避免使用“*”： 39 5.1.4 减少访问数据库的次数： 39 5.1.5 使用DECODE函数来减少处理时间： 39 5.1.6 高效的删除重复记录： 39 5.1.7 删除表数据时用TRUNCATE替代DELETE： 40 5.1.8 尽量多使用COMMIT： 40 5.1.9 用WHERE子句替换HAVING子句： 40 5.1.10 通过内部函数提高SQL效率： 41 5.1.11 使用表的别名(Alias)： 41 5.1.12 用EXISTS替代IN、用NOT EXISTS替代NOT IN： 41 5.1.13 用索引提高效率： 42 5.1.14 SQL语句使用大写： 42