ABFrame项目设计与开发规范.doc

PRIMETON TECHNOLOGIES, LTD. 上海普元信息技术有限责任公司 ABFrame(Application Base Framework) 项目设计开发规范 版本： 1.2 日期：2008年7月 目录 1. 引言 2 1.1. 编写目的 2 1.2. 背景 2 1.3. 名词定义 2 1.4. 使用原则 2 2. 环境说明 2 2.1. 开发工具 2 2.2. 开发环境 2 2.3. 运行环境 2 3. 总体规范 2 3.1. 统一缩写或名词约定 2 3.2. 需求/功能编号规范 2 3.3. 子系统及构件包规划 2 3.4. 应用架构介绍 2 3.5. 其他 2 4. 配置规范 2 4.1. 配置工具 2 4.2. 配置目录 2 5. 文档规范 2 5.1. 文档命名规范 2 5.2. 文档编写要求 2 6. 数据库规范 2 6.1. 操作规范 2 6.2. 命名规范 2 6.2.1. 数据库对象命名规范 2 6.2.2. 字段命名规范 2 6.2.3. 前缀约定 2 6.2.4. 属性默认类型定义 2 6.3. 设计规范 2 6.4. SQL语言开发规范 2 6.4.1. SQL命令的类型 2 6.4.2. SQL命令的格式 2 6.4.3. SQL命令的语法 2 6.4.4. 高效的SELECT语句 2 6.4.5. 在程序中嵌入SQL语句时要注意的问题 2 7. 构件设计开发规范 2 7.1. 命名规范 2 7.1.1. 总体命名规范 2 7.1.2. 构件包 2 7.1.3. 逻辑构件 2 7.1.4. 逻辑流 2 7.1.5. Java构件 2 7.1.6. 组合构件 2 7.1.7. 运算逻辑 2 7.1.8. 页面流 2 7.1.9. 工作流 2 7.1.10. 数据集 2 7.1.11. 命名Sql集 2 7.1.12. 命名Sql 2 7.1.13. 页面资源 2 7.1.14. Java 2 7.1.15. 配置信息 2 7.1.16. 包 2 7.1.17. WEB目录 2 7.2. 设计开发规范 2 7.2.1. 构件包 2 7.2.2. 逻辑构件 2 7.2.3. 逻辑流 2 7.2.4. Java构件 2 7.2.5. 组合构件 2 7.2.6. 运算逻辑 2 7.2.7. 页面流 2 7.2.8. 工作流 2 7.2.9. 数据集 2 7.2.10. 命名Sql 2 7.2.11. Java开发 2 7.2.12. Tag 2 7.2.13. Filter 2 7.2.14. Servlet 2 8. 流程设计开发规范 2 8.1. 命名规范 2 8.2. 设计规范 2 8.2.1. 流程设计原则 2 8.2.2. 流程设计方法 2 8.2.3. 流程设计注意事项 2 8.3. 开发规范 2 8.3.1. 流程相关数据的使用 2 9. UI规范 2 10. 其他规范 2 10.1. 基础构件库使用、开发规范 2 10.1.1. 公共技术构件的开发规范 2 10.2. 数据总线的使用规范 2 10.3. Session使用规范 2 10.3.1. EOS6 Session管理机制 2 10.3.2. ABFrame Session内容 2 10.4. 业务日志 2 10.5. 异常处理 2 10.6. 业务字典的命名规则 2 10.7. 操作提示信息的规范 2 10.8. 公共模块的使用方法 2 10.8.1. 分页模块 2 10.8.2. 通用数据选择构件使用规范 2 . 使用场景 2 . 功能描述 2 10.9. 菜单命名规范 2  文档修订记录 序号 版本号 修订日期 修订概述 修订人 审核人 批准人 备注 1.0 2008-7-14 创建 蔡述尧 1.1 2008-07-18 修改 蔡述尧 1.2 2008-07-29 修改 耿大伟 引言 编写目的 为了保证ABFrame系统的开发过程中各个小组和成员的设计模式、程序结构和开发框架的一致性以及增强代码的可维护性，在遵循EOS6平台和J2EE相关规则的基础上，建立本系统的项目设计开发规范，作为与本项目及未来接入该平台的应用项目相关人员开展设计、开发工作的基础和依据，并作为项目质量评估的重要标准。 背景 软件系统名称：ABFrame 任务提出单位：普元信息技术有限公司 任务开发单位：PSO售后服务部 系统最终用户：使用EOS6的开发人员 名词定义 ABFrame：应用基础框架，为基于EOS6开发的各个应用提供模型和实现一致的基础框架，提供了用户权限、组织机构、和基础服务（如业务字典、业务日志等）功能 EOS：上海普