ABFrame系统设计开发规范
1. 引言
1.1. 编写目的
为了保证ABFrame系统的开发过程中各个小组和成员的设计模式、程序结构和开发框架的一致性以及增强代码的可维护性，在遵循EOS6平台和J2EE相关规则的基础上，建立本系统的项目设计开发规范，作为与本项目及未来接入该平台的应用项目相关人员开展设计、开发工作的基础和依据，并作为项目质量评估的重要标准。
1.2. 背景
? ? ? ?
软件系统名称：ABFrame
任务提出单位：普元信息技术有限公司 任务开发单位：PSO售后服务部
系统最终用户：使用EOS6的开发人员
1.3. 名词定义
1) ABFrame：应用基础框架，为基于EOS6开发的各个应用提供模型和实现一致的基础框
架，提供了用户权限、组织机构、和基础服务（如业务字典、业务日志等）功能
2) EOS：上海普元公司提供的面向构件的SOA中间件平台，作为本项目应用软件的技术
平台
3) 构件：本规范所提到的构件及构件包的概念，均指EOS中的构件与构件包
1.4. 使用原则
1) 本规范由项目设计组维护，并指定专门的规范维护人员
2) 本规范作为基于ABFrame开发项目的规范指导性文件，允许在设计开发中进行补充、
完善或修正
3) 在项目开始正式开发之前，要求对项目组进行本规范的集中培训 4) 培训之后产生的零星规范性变动（如调整、补充、完善），需要在项目组中进行通告 5) 开发过程中，开发人员要随时查阅规范，以便了解开发要求，对于本规范文档不包含的
新的规范性要求，需要及时向规范维护人员提出 6) 开发阶段要求将规范性走查纳入项目计划，以便及时监控规范性执行情况，并挖掘新的
规范要求
共61页 第6页
ABFrame系统设计开发规范
2. 环境说明
2.1. 开发工具
使用EOS6.0作为本项目的技术架构和开发工具。
2.2. 开发环境
EOS6.0 Studio； DB：
配置管理：cvs客户端
配置要求：P4 2.0以上 内存1G以上 建议2G
2.3. 运行环境
3. 总体规范
3.1. 统一缩写或名词约定
本项目中，无论数据库设计、程序文件命名、文档文件命名、变量命名，对于同一概念，如果需要使用缩写，统一使用如下定义。 词语/缩写 EOS ABFrame info doc src demo fea req query add update 英文描述 Enterprise Operation System Application's Basic Framework 中文描述 普元面向构件的SOA中间件平台 基于EOS6实现的应用基础框架 信息 文档 源码 项目的静态页面原型 功能点，指经过设计后分解的功能 需求点，指需求调研后形成的用户需求 查询，在定义程序文件名称时，“查询”功能使用的英文为query，例如account_query.jsp 增加，在定义程序文件名称时，“增加”功能使用的英文名称为”add”，例如account_add.jsp 编辑，在定义程序文件名称时，“修改”功能使
共61页 第7页
Information Document Source Code Feature Requirement ABFrame系统设计开发规范
用的英文名称为“update”，例如account_update.jsp input delete list import export rtn success fault error 业务字典 Delete import export Return Success fault Error 输入，在定义程序文件名称时，“输入”功能使用英文名称为”input”，例如account_input.jsp 删除，在定义程序文件名称时，“删除”功能使用的英文名称为“delete”，例如account_delete.jsp 结果列表使用的英文名称，例如account_list.jsp 导入，在定义程序文件名称时，“导入”功能使用的英文名称为“import”，例如dict_import.jsp 导出，在定义程序文件名称时，“导出”功能使用的英文名称为“emport”，例如dict_export.jsp 返回，系统中表示返回的英文缩写 系统中表示成功的英文单词均使用success 系统中表示失败的英文单词均使用Fault 系统中表示错误的英文缩写 系统中与业务相关的代码及对代码的描述，例如，用cson_authlevel表示用户认证等级，而0：所有用户，1：登录用户，2：产品绑定用户等。 EOS提供了对业务字典的管理，通过EOS业务字典功能，为系统实现提供的大量构件，方便开发。
3.2. 需求/功能编号规范
需求编号规范：“req”+“-”+一级模块编号+“-”+二级模块编号+“-”+功能点编号
功能点（用例）代码编号规范：“fea”+“-”+一级模块编号+“-”+二级模块编号+“-”+功能点编号 注：
1． “fea”表示功能（Feature），“req”表示需求（Requirement） 2． 一级模块对应一个构件包（编号为01-99），二级模块对应构件包下的构件（编号
为01-99），功能点为构件下的具体功能（编号为01-99）
3.3. 子系统及构件包规划
根据《系统功能分解矩阵》，一级模块与EOS构件包命名最后一段一致：小写英文单词组成
的业务描述。如：权限管理(auth) 子系统 ABFrame 构件包中文名 权限管理与控制 构件包名称 auth 共61页 第8页
构件中文名称 认证管理 构件名称 auth
ABFrame系统设计开发规范
权限管理 组织机构管理 应用基础服务 应用基础工具 应用功能管理 菜单管理 角色管理 操作员管理 数据权限管理 机构管理 岗位管理 人员管理 职务管理 工作组管理 业务机构管理 单点登录 业务字典 业务日志 元数据管理 基础构件 文件上传 通用数据选择 function menu role operator dataright organization position person duty workgroup busiorg sso busidict busilog metadata comm fileupload datachoose privilege organization common Utility 说明：
1． 构件包和构件名称全部使用英文小写
2． 构件包名称建议采用长命名空间的方式，如com.primeton.abframe.auth 3． 更细的功能分解，参见项目文档《功能分解与跟踪矩阵》
3.4. 应用架构介绍
本应用采用J2EE架构，应用系统的功能开发，将通过Primeton EOS6.0以面向构件和SOA的方式进行构造，应用的总体架构参见下图：
共61页 第9页
ABFrame系统设计开发规范
图形说明：
1、 Primeton EOS：普元公司提供的面向构件中间件，在本应用中需要用到EOS的以下
部分：EOS Server、EOS Studio、EOS Component、EOS Governor、EOS Workflow等，详细信息参见普元EOS产品的有关资料
2、 有关应用架构的详细信息，请参阅系统设计说明书
3.5. 其他
在编码过程中，要求尽量使用公用模块，以减少系统编码、维护工作量，使程序具有良好的结构性。
满足以下任一种情况，请抽象公用模块： ? 超过三个地方使用的相同逻辑的代码；
4. 配置规范
4.1. 配置工具
1） 项目内部版本控制使用cvs服务器。 2）
共61页 第10页