社保核心平台三版本地化开发规范_概要设计

n 文档编号B11-RC-C04-JB_HXPT-01 版本号1.0 发放号F01 受控状态受控 社会保险管理信息系统核心平台三版社会保险管理信息系统核心平台三版 本地化开发规范本地化开发规范 概要设计规范概要设计规范 编制部门：社会保险管理信息系统核心平台三版项目组 编制人：魏文麟编制日期：2007-8-6 审核人：魏文麟审核日期：2007-8-13 批准人：批准日期： 北京利博赛社保信息技术有限公司北京利博赛社保信息技术有限公司 社会保险管理信息系统核心平台三版本地化开发规范 第 1 页 文档修改历史 版本版本修改记录修改记录修改日期修改日期修改人修改人 1.0初稿20080710魏文麟 社会保险管理信息系统核心平台三版本地化开发规范 第 2 页 目录目录 1引言引言.4 1.1 目的.4 1.2 背景.4 1.3 输入的文档.4 1.4 术语.4 1.5 参考资料.5 1.6 读者对象.5 2核心平台需求分析设计文档衔接阅读指导核心平台需求分析设计文档衔接阅读指导.6 2.1 目的.6 2.2 需求分析设计文档衔接关系总图.6 2.3 需求说明书与UI 设计说明书的衔接关系.8 2.3.1衔接图.8 2.3.2衔接说明.10 2.4 UI 设计说明书与概要设计说明书的衔接关系.10 2.4.1衔接图.10 2.4.2衔接说明.12 2.5 概要设计说明书与详细设计说明书的衔接关系.12 2.5.1衔接图.12 2.5.2衔接说明.14 3概要设计规范概要设计规范.14 3.1 业务设计规范.14 3.1.1总体结构.14 3.1.2业务拆分与技术架构的结合.15 3.1.3UI请求与VS的关系.15 3.1.4业务领域模型分析参考.15 3.1.4.1主要业务概念.15 3.1.4.2主要业务概念之间的关系.19 3.2 技术分层规范.20 3.2.1请求处理层规范.20 3.2.1.1职责.20 3.2.1.2实现方式.20 3.2.1.3命名规范.20 3.2.1.4类的继承规范.20 3.2.2视图服务层规范.21 社会保险管理信息系统核心平台三版本地化开发规范 第 3 页 3.2.2.1职责.21 3.2.2.2实现方式.21 3.2.2.3命名规范.21 3.2.2.4类的继承规范.21 3.2.3业务组件层.22 3.2.3.1组件接口层规范.22 3.2.3.2组件处理层规范.22 3.2.3.3数据访问层规范.23 3.2.3.4业务实体层规范.24 3.2.3.5业务传输对象层规范.24 社会保险管理信息系统核心平台三版本地化开发规范 第 4 页 1引言引言 1.1 目的目的 统一项目组概要设计阶段在系统设计上的要求。 1.2 背景背景 项目用户劳动和社会保障部项目经理魏文麟 系统用途 社保核心平台三版的总体建设目标为，按照金保工程的总体规划，以社保 核心平台一、二版为基础，以城市级社会保险经办业务为核心，以实现基 本养老保险、失业保险、基本医疗保险、工伤保险、生育保险主体业务经 办和基金管理过程信息化为最终目标，在总结各地业务经办模式的基础上， 面向最新的业务模式，研究制定一套面向经办的参考标准规范，并基于该 标准规范开发一套实用、适用、灵活的软件平台，进一步降低应用软件本 地化工作量，实现与金保工程其他统一应用软件的对接。 立项时间2006 年 12 月 当前阶段概要设计阶段 备注 1.3 输入的文档输入的文档 无 1.4 术语术语 无 社会保险管理信息系统核心平台三版本地化开发规范 第 5 页 1.5 参考资料参考资料 无 1.6 读者对象读者对象 项目经理 软件工程负责人 愿意了解核三概要设计的方法、规范的人员 社会保险管理信息系统核心平台三版本地化开发规范 第 6 页 2核心平台需求分析设计文档衔接阅读指导核心平台需求分析设计文档衔接阅读指导 2.1 目的目的 本章节帮助相关人员进一步了解核心平台三版的需求说明书、UI 设 计说明书、概要设计说明书、详细设计说明之间的衔接关系。 2.2 需求分析设计文档衔接关系总图需求分析设计文档衔接关系总图 社会保险管理信息系统核心平台三版本地化开发规范 第 7 页 社会保险管理信息系统核心平台三版本地化开发规范 第 8 页 2.3 需求说明书需求说明书与与UI 设计说明书设计说明书的衔接关系的衔接关系 2.3.1 衔接图衔接图 社会保险管理信息系统核心平台三版本地化开发规范 第 9 页 社会保险管理信息系统核心平台三版本地化开发规范 第 10 页 2.3.2 衔接说明衔接说明 需求说明书主要用 BPD 的方法进行业务流程分解与细化。业务步骤 级流程通过界面交互分析、界面职责分配、业务岗位分析得出页面流设计及每 个页面向后台发送请求及参数的说明，这些说明在UI 设计说明书中体现。 在需求说明书与UI 设计说明书的衔接上主要是要了解业务步骤与 UI 之间的映射关系。这一点在UI 设计说明书中有所描述。具体的映射关 系应根据页面的职责分配、组织的职责分配来决定。主体业务流程会表现为主 UI 流程。业务步骤与 UI 之间不一定存在一对一的映射关系。多个业务步骤如 果为一个业务岗位完成则可能在一个页面内完成，多个个业务步骤如果为多个 业务岗位完成则一定在多个页面内完成。 2.4 UI 设计说明书设计说明书与与概要设计说明书概要设计说明书的衔接关系的衔接关系 2.4.1 衔接图衔接图 社会保险管理信息系统核心平台三版本地化开发规范 第 11 页 社会保险管理信息系统核心平台三版本地化开发规范 第 12 页 2.4.2 衔接说明衔接说明 概要设计的主要任务是： 1、系统拆分 2、分析出基于接口层面的系统任务模型 3、分析出基于接口层面的系统能力模型 在概要设计说明书中系统拆分主要体现在业务模块上的拆分，技术层 面表现为包结构的拆分上。系统任务模型主要体现在视图服务层上的视图服务 接口的设计。系统能力模型主要体现在业务组件的打包及对外暴露的组件服务 接口上。具体能力模型的建立依据主要是业务领域模型分析的结果。 UI 设计说明书与概要设计说明书的衔接主要为一个业务单元内的 所有请求对应一个视图服务接口的映射关系。 2.5 概要设计说明书概要设计说明书与与详细设计说明书详细设计说明书的衔接关系的衔接关系 2.5.1 衔接图衔接图 社会保险管理信息系统核心平台三版本地化开发规范 第 13 页 社会保险管理信息系统核心平台三版本地化开发规范 第 14 页 2.5.2 衔接说明衔接说明 详细设计说明书是针对概要设计说明书提出的接口要求予以具体 实现，并且根据架构设计的成果将技术层面的实现层次模型进行具体实现。如 果将概要设计的重点描述为“软件应该干什么？”的话，详细设计的重点就是 “软件应该怎么干”。详细设计说明书会以类图及时序图的方式解说系统 的实现过程。 概要设计说明书与详细设计说明书的衔接体现在详细设计会按照 架构设计的指导补全概要设计中忽略的技术实现层次，。如：增加 Action 层的 设计，对视图服务接口进行具体实现，对业务组件内部的结构进行设计，用以 实现业务组件的 Facade 接口。 3概要设计规范概要设计规范 3.1 业务设计业务设计规范规范 3.1.1 总体结构总体结构 业务=业务领域 业务领域=业务组 业务组=业务单元 业务单元=业务交互 业务交互=业务组件服务 业务组件服务=业务数据+业务规则 社会保险管理信息系统核心平台三版本地化开发规范 第 15 页 3.1.2 业务拆分与技术架构的结合业务拆分与技术架构的结合 3.1.3 UI 请求与请求与 VS 的关系的关系 一个业务单元内的所有请求对应一个 VS 接口。概要设计时由于 Action 层 是纯技术层，没有任何业务意义，可以先不予分析。 3.1.4 业务领域模型分析参考业务领域模型分析参考 概要设计阶段的数据库设计及组件职责、接口的设计都要参考下文所规定 的业务概念及概念的关系来进行分析。 3.1.4.1 主要业务概念主要业务概念 7 个主要业务概念：具体是三个基础业务概念：当事人（参与者）、资产、 产品，四个关联业务概念：协议、基金、资产流动账、账户。如下图所示： 社会保险管理信息系统核心平台三版本地化开发规范 第 16 页 产品（社保险种） “产品”是对所有社会保险险种的统称，具体阐明了社会保险险种的适用 的参保对象范围、参保对象应该履行的责任义务、参保对象可获得的权益。 产品概念如下图所示： 产产品品 (社社保保险险种种) 什么样的单位/个人可以参 加保险?如何划分群体? 参保后应该及怎样 缴纳社会保险费?应 该履行什么样的义 务和责任? 什么情况下可以 拥有享受待遇的 权利?可以享受什 么样的权益? 覆覆盖盖群群体体 责责任任义义务务 拥拥有有权权利利 社会保险管理信息系统核心平台三版本地化开发规范 第 17 页 当事人（社保资源） 通常当事人是指任意类型的实体，是具有独立行为能力的个体）、群体、 政治实体、法律实体、组织机构的统称。核三用“当事人”来抽象社保业务中 的所有参与方，包括提供、开展、进行、享受社保业务和服务的目标或对象。 在当事人模型中，我们引入了当事人角色和当事人关系的概念。 当事人可以扮演不同的角色参与系统交互，主要设计目的是为了满足特定 的业务功能需求、描述当事人出于特定身份的情况下能够进行哪种业务。如： 社保管理机构既是社保服务的提供方（操作者、管理者）又是社保服务的享受 方。 当事人关系是通过两个当事人及它们各自的角色定义的，每个关系类型只 对一组具体角色或对担当具体角色对的一组当事人有效。当事人关系与当事人 角色一般是同时出现的，一旦单独脱离使用可能出现歧义。 当事人的概念模型如下所示： 在逻辑模型阶段，核三的当事人建模如下所示： 社会保险管理信息系统核心平台三版本地化开发规范 第 18 页 当当 事事 人人 角角 色色 的的 实实 例例 管管 理理 当当事事人人 人人员员组组织织 履履行行义义务务人人员员待待遇遇享享受受人人员员服服务务提提供供者者服服务务享享受受者者 养养老老参参保保人人员员 工工伤伤参参保保人人员员 失失业业参参保保人人员员 生生育育参参保保人人员员 养养老老待待遇遇人人员员 工工伤伤待待遇遇人人员员 失失业业待待遇遇人人员员 生生育育待待遇遇人人员员 社社保保机机构构 发发放放机机构构 征征缴缴机机构构 医医疗疗机机构构 参参保保组组织织(单单位位) 家家庭庭 学学校校 社社区区 医医疗疗待待遇遇人人员员医医疗疗参参保保人人员员 物理模型阶段，核三当事人模型如下所示： 人人员员组组织织家家庭庭 物物理理模模型型建建模模阶阶段段,考考虑虑到到家家庭庭的的信信息息与与其其他他 组组织织的的信信息息基基本本没没有有共共同同性性,将将家家庭庭从从组组织织中中 独独立立处处理理直直接接继继承承了了当当事事人人 当当事事人人 资产 资产用于抽象社保业务各参与方（重点指社保机构、参保单位或参保个人） 拥有或控制的并可作用于社保业务的经济资源。 社会保险管理信息系统核心平台三版本地化开发规范 第 19 页 3.1.4.2主要业务概念之间的关系主要业务概念之间的关系 协议 在具体事务中各参与方权责利的一种约定和认可。核三中协议指当事人选 择了具体社会保险险种（产品）的证明和约定，它界定了各方在该项社会保险 具体社会保险业务中应履行的责任义务及可获得的权利，（如参保个人/参保单 位、经办机构建立的参保关系）。 基金 针对具体产品（险种），约定了具体收入和支付方式（如征收来源、征收 方式、支付对象、支付渠道）的具有产品专属性质的资产。核三中特指由参保 单位或参保个人等主体缴纳的社会保险费、其他渠道划拨资金、利息等组成的 社会保险基金。 资产流动账 各方当事人在履行社会保险责任和义务或行使社会保险权利的过程中有关 资产的变化过程记录。如社会保险缴费、退费、享受待遇等业务记录。 账户 针对具体当事人、具体产品，约定了积累和支出方式（如收入来源、收入方式、 支出场景）的具有当事人和产品双重专属性质的资产。核三中特指为参保个人 建立的养老保险、医疗保险等个人账户。 社会保险管理信息系统核心平台三版本地化开发规范 第 20 页 3.2 技术分层规范技术分层规范 3.2.1 请求处理层规范请求处理层规范 请求处理层可细分为：处理浏览器请求与处理 soap 请求。 3.2.1.1 职责职责 （1） 处理浏览器请求： 处理一次浏览器请求，并为客户端返回本次请求所要求的数据，指定 返回客户端的页面。 （2） 处理 soap 请求： 处理一次传统客户端请求，并为客户端返回本次请求所要求的数据， 将请求端请求的 Soap 数据对象转换为业务参数 Javabean 对象，将业务返 回的数据转换为 Soap 对象返回框架。 3.2.1.2 实现方式实现方式 请求处理层实现方式：Javaclass 3.2.1.3 命名规范命名规范 请求处理层的命名规范为：业务术语前缀Class 类型缩写的形式，即 XXXAction。 3.2.1.4 类的继承规范类的继承规范 Action 需要继承框架提供的父类。 （1）如果 Action 中包括分页查询，那么需要继承 CommonQueryAction /CommonSQLQueryAction/ListPageQueryActon 中任一个 Action 类； （2）如没有分页查询，则需继承 BizDispatchAction； （3）如为传统客户端请求，则需继承 AbstractSoapAction。 社会保险管理信息系统核心平台三版本地化开发规范 第 21 页 3.2.2 视图服务层规范视图服务层规范 视图服务层可细分为：视图服务接口层与视图服务时限层。 3.2.2.1 职责职责 （1） 视图服务接口层： 视图服务接口层为视图提供纯业务接口，这一层不依赖于任何组件技 术（如 EJB、POJO 等），这一层为 PO 方法调用规定了接口。 （2） 视图服务时限层： 视图服务实现层是组件相关技术实现，这一层实现了具体的组件技术 （如 EJB、POJO 等），这一层不实现具体的业务逻辑，通过组装业务组件 的服务完成视图层的要求 3.2.2.2 实现方式实现方式 (1) 视图服务接口层实现方式：Java Interface (2) 视图服务实现层实现方式：Javaclass 3.2.2.3 命名规范命名规范 视图服务层的命名规范为：业务术语前缀Class 类型缩写的形式，即视 图服务接口层：XXXVS，视图服务实现层：XXXVSImp。 3.2.2.4 类的继承规范类的继承规范 视图服务接口层不需要继承框架提供的任何父类，视图服务实现层需实现 对应的视图服务接口。 社会保险管理信息系统核心平台三版本地化开发规范 第 22 页 3.2.3 业务组件层业务组件层 业务组件层可细分为：组件接口层、组件处理层、数据访问层等。 3.2.3.1 组件接口层规范组件接口层规范 3.2.3.1.1 职责职责 组件接口层负责为业务组件提供一个一致的对外接口。 3.2.3.1.2 实现方式实现方式 组件接口层实现方式： Javaclass 3.2.3.1.3 命名规范命名规范 组件接口层的命名规范为：业务术语前缀Class 类型缩写的形式，即 XXXFacade。 3.2.3.1.4 类的继承规范类的继承规范 组件接口层不需要继承框架提供的任何父类。 3.2.3.2 组件处理层规范组件处理层规范 3.2.3.2.1 职责职责 组件处理层负责实现具体业务逻辑。 3.2.3.2.2 实现方式实现方式 组件处理层实现方式： Javaclass 社会保险管理信息系统核心平台三版本地化开发规范 第 23 页 3.2.3.2.3 命名规范命名规范 组件处理层的命名规范为：业务术语前缀Class 类型缩写的形式，即 XXXPO。 3.2.3.2.4 类的继承规范类的继承规范 组件处理层不需要继承框架提供的任何父类 3.2.3.3 数据访问层规范数据访问层规范 3.2.3.3.1 职责职责 数据访问层负责实现查询语句的生成和其它一些特定于数据库的操作。数 据访问层由业务 DAO 对象、IPersistence 接口、Platform 工厂类组成。其中业务 DAO 对象通过 IPersistence 接口访问数据库，IPresistence 接口提供了访问数据 库的方法，Platform 工厂类提供了获取 IPersistence 接口对象的工厂方法 getPersistence。I