PRIMETON TECHNOLOGIES, LTD. 上海普元信息技术有限责任公司
ABFrame(Application Base Framework)
项目设计开发规范
版本： 1.2 日期：2008年7月
ABFrame系统设计开发规范
目录
1. 引言 ........................................................................................................................................... 6
1.1. 编写目的 ................................................................................................................... 6 1.2. 背景 ........................................................................................................................... 6 1.3. 名词定义 ................................................................................................................... 6 1.4. 使用原则 ................................................................................................................... 6 2. 环境说明 ................................................................................................................................... 7
2.1. 开发工具 ................................................................................................................... 7 2.2. 开发环境 ................................................................................................................... 7 2.3. 运行环境 ................................................................................................................... 7 3. 总体规范 ................................................................................................................................... 7
3.1. 统一缩写或名词约定 ............................................................................................... 7 3.2. 需求/功能编号规范 .................................................................................................. 8 3.3. 子系统及构件包规划 ............................................................................................... 8 3.4. 应用架构介绍 ........................................................................................................... 9 3.5. 其他 ......................................................................................................................... 10 4. 配置规范 ................................................................................................................................. 10
4.1. 配置工具 ................................................................................................................. 10 4.2. 配置目录 ................................................................................................................. 11 5. 文档规范 ................................................................................................................................. 12
5.1. 文档命名规范 ......................................................................................................... 12 5.2. 文档编写要求 ......................................................................................................... 12 6. 数据库规范 ............................................................................................................................. 13
6.1. 操作规范 ................................................................................................................. 13 6.2. 命名规范 ................................................................................................................. 13
6.2.1. 数据库对象命名规范 ..................................................................................... 13 6.2.2. 字段命名规范 ................................................................................................. 14 6.2.3. 前缀约定 ......................................................................................................... 14 6.2.4. 属性默认类型定义 ......................................................................................... 15 6.3. 设计规范 ................................................................................................................. 15 6.4. SQL语言开发规范 ................................................................................................ 18
6.4.1. SQL命令的类型 ............................................................................................ 18 6.4.2. SQL命令的格式 ............................................................................................ 19 6.4.3. SQL命令的语法 ............................................................................................ 19 6.4.4. 高效的SELECT语句 .................................................................................... 21 6.4.5. 在程序中嵌入SQL语句时要注意的问题 ................................................... 22
7. 构件设计开发规范 ................................................................................................................. 22
7.1. 命名规范 ................................................................................................................. 22
7.1.1. 总体命名规范 ................................................................................................. 26 7.1.2. 构件包 ............................................................................................................. 26 7.1.3. 逻辑构件 ......................................................................................................... 27
共61页 第2页
ABFrame系统设计开发规范
7.1.4. 逻辑流 ............................................................................................................. 27 7.1.5. Java构件 ......................................................................................................... 27 7.1.6. 组合构件 ......................................................................................................... 27 7.1.7. 运算逻辑 ......................................................................................................... 28 7.1.8. 页面流 ............................................................................................................. 28 7.1.9. 工作流 ............................................................................................................. 29 7.1.10. 数据集 ............................................................................................................. 29 7.1.11. 命名Sql集 ..................................................................................................... 29 7.1.12. 命名Sql .......................................................................................................... 30 7.1.13. 页面资源 ......................................................................................................... 30 7.1.14. Java .................................................................................................................. 31 7.1.15. 配置信息 ......................................................................................................... 32 7.1.16. 包 ..................................................................................................................... 32 7.1.17. WEB目录 ....................................................................................................... 33 7.2. 设计开发规范 ......................................................................................................... 34
7.2.1. 构件包 ............................................................................................................. 34 7.2.2. 逻辑构件 ......................................................................................................... 34 7.2.3. 逻辑流 ............................................................................................................. 34 7.2.4. Java构件 ......................................................................................................... 38 7.2.5. 组合构件 ......................................................................................................... 38 7.2.6. 运算逻辑 ......................................................................................................... 38 7.2.7. 页面流 ............................................................................................................. 40 7.2.8. 工作流 ............................................................................................................. 41 7.2.9. 数据集 ............................................................................................................. 41 7.2.10. 命名Sql .......................................................................................................... 41 7.2.11. Java开发 ......................................................................................................... 41 7.2.12. Tag ................................................................................................................... 44 7.2.13. Filter ................................................................................................................ 44 7.2.14. Servlet ............................................................................................................. 44
8. 流程设计开发规范 ................................................................................................................. 45
8.1. 命名规范 ................................................................................................................. 45 8.2. 设计规范 ................................................................................................................. 45
8.2.1. 流程设计原则 ................................................................................................. 45 8.2.2. 流程设计方法 ................................................................................................. 46 8.2.3. 流程设计注意事项 ......................................................................................... 47 8.3. 开发规范 ................................................................................................................. 47
8.3.1. 流程相关数据的使用 ..................................................................................... 48
9. UI规范 ................................................................................................................................... 48 10. 其他规范 ......................................................................................................................... 48
10.1. 基础构件库使用、开发规范 ................................................................................. 48
10.1.1. 公共技术构件的开发规范 ............................................................................. 48 10.2. 数据总线的使用规范 ............................................................................................. 48 10.3. Session使用规范 .................................................................................................... 48
10.3.1. EOS6 Session管理机制 ................................................................................. 48
共61页 第3页
ABFrame系统设计开发规范
10.3.2. ABFrame Session内容 ................................................................................... 49 10.4. 业务日志 ................................................................................................................. 52 10.5. 异常处理 ................................................................................................................. 53 10.6. 业务字典的命名规则 ............................................................................................. 54 10.7. 操作提示信息的规范 ............................................................................................. 54 10.8. 公共模块的使用方法 ............................................................................................. 56
10.8.1. 分页模块 ......................................................................................................... 56 10.8.2. 通用数据选择构件使用规范 ......................................................................... 57
10.8.2.1. 使用场景 ............................................................................................... 57 10.8.2.2. 功能描述 ............................................................................................... 60
10.9. 菜单命名规范 ......................................................................................................... 61
共61页 第4页
ABFrame系统设计开发规范
文档修订记录
序版本号 号 1. 1.0 2. 1.1 3. 1.2 4. 5. 6. 7.
修订日期 2008-7-14 2008-07-18 2008-07-29 修订概述 创建 修改 修改 修订人 蔡述尧 蔡述尧 耿大伟 审核人 批准人 备注
共61页 第5页