PRIMETON TECHNOLOGIES, LTD.
上海普元信息技术有限责任公司
××银行××××系统
项目开发规范
版本: 1.0
日期:2006 年 9 月
××银行××××系统开发规范
目录
1. 引言................................................................................................................................................5
1.1. 编写目的.............................................................................................................................5
1.2. 背景.....................................................................................................................................5
1.3. 定义.....................................................................................................................................5
2. 环境说明........................................................................................................................................6
2.1. 开发工具.............................................................................................................................6
2.2. 开发环境.............................................................................................................................6
2.3. 运行环境.............................................................................................................................6
3. 应用系统命名规范........................................................................................................................6
3.1. 系统的描述.........................................................................................................................6
3.2. 统一英文缩写或名词约定列表.........................................................................................7
3.3. 开发目录编排与命名.........................................................................................................8
3.3.1. 文档目录..................................................................................................................8
3.3.2. 文档规范..................................................................................................................9
3.3.3. 需求/功能编号规范.................................................................................................9
3.3.4. 二级模块与构件包定义..........................................................................................9
3.3.5. 程序目录命名........................................................................................................11
3.3.5.1. EOS Server 文件目录及说明.....................................................................11
3.3.5.2. JBOSS Server 文件目录及说明.................................................................11
3.4. 数据库命名规范...............................................................................................................13
3.4.1. 表命名规范............................................................................................................13
3.4.2. 字段命名规范........................................................................................................13
3.4.3. 属性默认类型定义(Oracle 参考)....................................................................14
3.4.4. 设计规范................................................................................................................14
3.4.5. 其他........................................................................................................................17
3.5. EOS 构件命名规范..........................................................................................................18
3.5.1. 构件包及构件命名规范........................................................................................18
3.5.2. 运算逻辑命名规范................................................................................................19
3.5.3. handle 命名规范....................................................................................................20
3.5.4. Tag 命名规范.........................................................................................................20
3.5.5. 业务逻辑命名规范................................................................................................20
3.5.6. 展现逻辑命名规范................................................................................................20
3.5.7. 查询实体的命名规范............................................................................................21
3.5.8. JSP/HTML 命名规范............................................................................................21
4. 应用系统开发规范......................................................................................................................22
4.1. 应用架构介绍...................................................................................................................22
4.2. EOS 构件开发规范..........................................................................................................24
4.2.1. 运算逻辑开发规范................................................................................................24
4.2.2. 数据逻辑开发规范................................................................................................26
4.2.3. 业务逻辑开发规范................................................................................................26
共 90 页 第 2 页
××银行××××系统开发规范
4.2.4. 展现逻辑开发规范................................................................................................31
4.2.5. Tag 开发规范.........................................................................................................32
4.2.6. handle 开发规范....................................................................................................32
4.2.7. 页面逻辑(JSP)开发规范.......................................................................................32
4.2.7.1. JSP/HTML 代码编写规范.........................................................................32
4.2.7.2. 其他规范.....................................................................................................34
4.2.7.3. 页面框架与布局.........................................................................................36
4.2.7.4. 基于性能方面的有关原则.........................................................................44
4.3. 数据总线的使用规范.......................................................................................................46
4.4. 主要运算逻辑的使用规范...............................................................................................46
4.5. 公共构件的开发规范.......................................................................................................46
4.6. HTTPSession 操作限制....................................................................................................46
4.7. Java 程序代码开发规范...................................................................................................47
4.8. 业务字典的命名规则.......................................................................................................50
4.9. 数据库操作规范...............................................................................................................51
4.10. 其他规范.........................................................................................................................51
5. 应用系统设计规范......................................................................................................................51
5.1. Richclient 使用限制..........................................................................................................51
5.2. 代码字段如何获得对应的代码描述...............................................................................52
5.3. 空节点的判断...................................................................................................................52
5.3.1. 问题说明................................................................................................................52
5.3.2. 修改建议................................................................................................................53
5.4. 字符串的比较方案...........................................................................................................53
5.4.1. 问题说明................................................................................................................53
5.4.2. 修改意见................................................................................................................54
6. 工作流开发规范..........................................................................................................................55
7. 其他规范......................................................................................................................................55
7.1. 公共模块的使用方法.......................................................................................................55
7.1.1. 分页模块的使用....................................................................................................55
7.1.2. 排序模块................................................................................................................55
7.1.3. 日志模块................................................................................................................55
7.1.4. 权限校验模块........................................................................................................56
7.1.5. 公用页面................................................................................................................56
7.2. 菜单编号、自定义业务字典代码命名规范..................................................................56
7.3. 系统错误码使用规范.......................................................................................................57
7.3.1. 错误码编码规则....................................................................................................57
7.3.2. 错误码定义和使用................................................................................................57
7.3.3. 错误码分配............................................................................................................57
7.4. 数据权限级别定义:.......................................................................................................57
7.5. 配置管理规范...................................................................................................................58
7.5.1. CVS 操作规范.......................................................................................................58
7.5.1.1. 基本概念.....................................................................................................58
7.5.1.2. 设置示例.....................................................................................................58
7.5.1.3. 开发使用规范.............................................................................................59
共 90 页 第 3 页
××银行××××系统开发规范
7.5.2. Bug 管理规范........................................................................................................72
7.5.2.1. 登陆系统.....................................................................................................72
7.5.2.2. 注销系统.....................................................................................................73
7.5.2.3. 查看问题.....................................................................................................73
7.5.2.4. 创建、维护版本.........................................................................................74
7.5.2.5. 创建 bug......................................................................................................76
7.5.2.6. 上传附件.....................................................................................................77
7.5.2.7. 修改 bug......................................................................................................79
7.5.2.8. 重开 bug......................................................................................................80
7.5.2.9. 关闭 bug......................................................................................................81
7.5.2.10. 分配 bug....................................................................................................83
7.5.2.11. 回复 bug....................................................................................................84
7.5.2.12. Bug 生命周期...........................................................................................86
7.6. SQL 语言开发规范..........................................................................................................87
7.6.1. SQL 命令的类型...................................................................................................87
7.6.2. SQL 命令的格式...................................................................................................87
7.6.3. SQL 命令的语法...................................................................................................88
7.6.4. 高效的 SELECT 语句...........................................................................................90
7.6.5. 在程序中嵌入 SQL 语句时要注意的问题..........................................................90
共 90 页 第 4 页
××银行××××系统开发规范
1. 引言
1.1. 编写目的
为了保证××银行的××××系统的开发过程中各个小组和成员的程序结构和开发框架的一
致性以及增强代码的可维护性,在遵循 EOS 框架规则的基础上,建立×××××系统的项目开
发规范,作为本项目相关的其他人员开展工作的基础和依据,并作为项目质量评估的重要
标准。
1.2. 背景
软件系统名称:
任务提出单位:××银行开发中心
任务开发单位:
系统最终用户:
1.3. 定义
1) EOS:上海普元公司提供的面向构件的中间件平台,作为本项目应用软件的技术平台
2) 构件:本规范所提到的构件及构件包的概念,均指 EOS 中的构件与构件包
3) FBFRAME:基础业务框架
共 90 页 第 5 页