EOS应用项目开发规范.doc

中国证券登记结算有限责任公司 深圳分公司 EOS应用项目开发规范 （Version 1.0） For ××××系统 编写：夏健辉、唐伟佳、袁义等 审核： 批准： 技术开发部 2009.02 文档修订和审批记录 序号 版本号 修订日期 修订概述 修订人 审核人 批准人 备注 0.9 2009-2-15 初稿创建 袁义 目 录 1. 引言 6 1.1. 编写目的 6 1.2. 适用范围 6 1.3. 项目背景 6 1.4. 名词定义 6 1.5. 文档使用约定 7 2. 总体规范 7 2.1. 统一缩写或名词约定 7 2.2. 需求/功能编号规范 8 2.3. 子系统及构件包规划 9 2.4. EOS应用的技术架构介绍 10 2.5. 技术环境说明 12 2.5.1. 设计开发工具 12 2.5.2. 测试环境 12 2.5.3. 运行环境 12 2.6. 其他 13 3. 配置管理规范 13 3.1. 配置工具与管理规范 13 3.2. 配置目录 13 4. 文档规范 14 4.1. 文档命名规范 14 4.2. 文档编写要求 15 5. 数据库规范 15 5.1. 操作规范 15 5.2. DB2数据库命名规范 16 5.2.1. 数据库对象命名规范 16 5.2.2. 字段命名规范 16 5.2.3. 前缀约定 17 5.2.4. 属性默认类型定义 17 5.3. AS400命名规范 18 5.4. 数据库设计规范 18 5.5. 数据源定义规范 21 5.6. SQL语言开发规范 24 5.6.1. SQL命令的类型 24 5.6.2. SQL命令的格式 24 5.6.3. SQL命令的语法 24 5.6.4. 高效的SELECT语句 27 5.6.5. 在程序中嵌入SQL语句时要注意的问题 27 6. EOS平台设计开发规范 27 6.1. 主要概念与总体规范 27 6.2. 构件包 32 6.3. 逻辑构件 33 6.4. 逻辑流 33 6.5. 组合构件 37 6.6. 运算逻辑 37 6.7. 页面流 39 6.8. 工作流 40 6.9. 数据集 41 6.10. 命名Sql集 41 6.11. 命名Sql 41 6.12. 页面资源 42 6.13. Java 44 6.14. Tag 48 6.15. Filter 48 6.16. Handle 48 6.17. Servlet 49 6.18. 配置信息 49 6.19. 包 49 6.20. WEB目录 49 6.21. 国际化资源文件 50 7. EOS流程设计开发规范 51 7.1. 命名规范 51 7.2. 设计规范 51 7.2.1. 流程设计原则 51 7.2.2. 流程设计方法 52 7.2.3. 流程设计注意事项 54 7.3. 开发规范 54 7.3.1. 流程相关数据的使用规范 54 8. JAVA代码编写规范 54 9. WEB界面开发规范 55 10. 业务字典规范 55 11. 通用构件开发、使用和管理规范 55 11.1. 基础构件库使用、开发规范 55 11.1.1. 公共构件的开发规范 55 11.2. 公共模块的使用方法 56 11.2.1. 分页模块 56 12. 其他设计开发规范 56 12.1. Session使用规范 56 12.1.1. EOS6 Session管理机制 56 12.1.2. BPM系统的Session内容 57 12.2. 业务日志 59 12.3. 异常处理 60 12.4. 操作提示信息的规范 61 12.5. 菜单命名规范 61 13. 测试、上线规范 62 14. 开发测试系统管理规范 62 15. 其他管理规范 62 引言 编写目的 为了保证中国结算深圳分公司基于EOS应用平台的应用系统的设计、开发、测试、上线、运行过程中，各个小组和成员的设计模式、程序结构和开发框架的一致性以及增强代码的可维护性，在遵循EOS6平台和J2EE相关规则的基础上，结合本公司的具体情况，建立统一的项目设计开发规范，作为应用项目相关人员开展设计、开发工作的基础和依据，并作为项目质量评估的重要标准。 适用范围 本规范在中国结算深圳分公司技术部门和合作开发厂商采用EOS平台实施开发系统应用时使用，软件管理人员、设计人员、开发人员应遵守此规范。 项目背景