说明书的详细设计

中国移动无线城市集中运营服务平台系统项目 详细设计说明书 文档标识： 当前版本： 1.0 当前状态： 草稿 发布日期： 2012-8-28 发布  修改历史 日期 版本 作者 修改内容 评审号 变更控制号 2012-8-28 1.0 拓维 新建 目 录 1 总则 2 1.1 编写目的 2 1.2 读者对象 2 1.3 参考文档 2 1.4 术语与缩写 2 2 系统概述 2 2.1 模块结构 2 2.2 采用技术 3 3 模块设计 4 3.1 模块1 4 3.2 模块2…… 9 4 模块详细设计 9 4.1 模块1 9 4.2 模块2…… 12 1 总则 1.1 编写目的 明确任务和需求，使得软件开发人员知道软件开发流程，软件测试时更有条理 1.2 读者对象 描述该文档的阅读对象。 1.3 参考文档 描述该文档的参考文档。 1.4 术语与缩写 描述该文档的术语及解释。 2 系统概述 2.1 模块结构 描述软件系统的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明系统结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的方案，或者基于原有体系结构的限制）。 示例： 2.2 采用技术 描述该系统所采用的技术。 示例： 数据ETL采用C++编程技术，经过FtpMain从外围系统抽取数据，Transfer_Main对数据进行清洗，load_data对清洗后的数据进行加载，完成ETL处理过程；前台流程配置界面采用JAVA编程技术，流程调度通过调度控件完成调度控制。 数据处理层（存储层、应用层、访问层）通过DB2存储过程技术实现对数据流的规则定义，通过调度程序完成数据流的流向控制。 最终展现，通过JAVA、JSP、HTML、GIS，视频监控等编程技术完成代码开发，并部署到WEB应用服务器（WebSphere等），主题采用BRIO工具结合WEB页面，地图技术，视频技术进行多维展现。 3 模块设计 按照需求进行模块分析和设计。 3.1 模块1 3.1.1 模块说明 描述该模块的功能，对该模块进行说明。 示例： 实体渠道：提供渠道发展用户分析、业务受理分析、渠道构成分析、资源分析、考核分析，监控和评估渠道的运营状况和管理能力。 如果采用面向对象的设计模式，则可以使用用例图等来说明这些设计类之间如何交互，实现本模块的典型功能。 示例： 用例主要包括购卡支付、购卡冲正、折扣查询、购卡历史记录查询等， 由于采用异步通信方式将支付、冲正分为请求和响应两个子用例。 用例说明： 购卡支付请求：该用例说明用户通过短消息、wap、web等通信接入手段购买卡系统提供的各种卡，以短信为例，用户通过短消息向系统提交购卡指令，系统查询卡类型及金额，如卡类型正确则生成订单消息，并向用户的银行帐号扣款的支付请求。 购卡支付响应：若支付请求返回正确响应，系统查询原订单和交易记录，返回相应的卡号和密码，以短消息形式通知用户；如出现超时或数据库操作异常，系统自动发起冲正请求 3.1.2 模块设计 描述模块设计。可以用流程图表示。 示例： 也可以用类图体现。 【利用Rose工具给出系统的主要类框图，描述系统的静态行为】 示例： 主要类说明 MpcpParseChainBean 包名 com.talkweb.card.buzi 类名 MpcpParseChainBean 父类名 ChainBean 责任描述  XML解析  短信指令解析  消息协议转换（MPCP2SpDeliverMsg－>TradeInfo） 协同类 使用MPCP2SpDeliverMsg的unmarshal进行XML的解析； 使用TradeInfo作为内部交易协议； 使用DefaultDAO读取数据库中操作； 使用Log提供日志服务 属性 类型 描述 Logger Log 日志管理器 方法说明 方法名 process（） 类型 protected Description 解析MPCP2SpDeliverMsg消息的XMLString转换为内部TradeInfo消息 Input InputMsg Output InputMsg Process  进行XML解析  调用MPCP2Trade（）进行消息转换 方法名 MPCP2Trade（） 类型 private Description MPCP2SpDeliverMsg消息转换TradeInfo Input MPCP2SpDeliverMsg（MPCP短消息） Output TradeInfo（本地交易报文） Process  调用parseCommand（）解析短消息内容  将MPCP短消息转换为本地交易报文 方法名 parseCommand（） 类型 private Description 解析短信内容为功能码 Input String（短信内容） Output Int（功能码） BUY_CARD= 100; QUERY_MONEY= 110; QUERY_FACE= 111; QUERY_HIS = 120; REPORT= 130; HELP = 140; UNKNOW_COMMAND= 0; Process 根据短信息内容产生功能码 3.1.3 数据结构 描述该模块对应的数据模型。 3.2 模块2…… 同3.1章节。 4 模块详细设计 4.1 模块1 4.1.1 功能点1 4.1.1.1 功能说明 对该功能点进行描述（比如：新增，修改，删除，查询等功能）； 或者对该功能点的具体信息进行描述。 示例： 渠道发展用户日分析: 通过时间、地域、品牌、地理位置类型、排他性等角度分析各类渠道每日新增及离网用户的情况，实现对渠道的整体分析和监控。 支持切片、钻取，旋转等分析操作,以图表形式展现, 能够打印图表,并且能将图,表分别以图片格式,excel格式导出. 4.1.1.2 数据设计 描述后台的数据设计（存储过程）。 A示例（功能点）： 存 储 过 程 名： CHLDW.ETL2_CUB_COUNTY_ADD_USER_DAY 分 析 类 型: 主题 结 果 表： CHLWI.CUB_CHL_ADD_USER_DAY 运 行 周 期： 日 调 用 方 式： CALL CHLDW.ETL2_CUB_COUNTY_ADD_USER_DAY (YYYYMMDD,0,999,?); 前 驱： 版 本： 1．0 设 计 人： 需 求 分 析 章 节: 1．5．1 需 求 编 码: WCMN000000001M 变 更 情 况： 统计步骤: 1) 开号用户数：取基础层的用户信息表（CHLODS.ODS_USR_INFO）与基本信息表（chlwi.t_channel_basicinfo）用渠道标志（CHANNEL_ID）关联，根据状态标志STS_ID＝18,统计开号用户数量. 2) 销号用户数: 取基础层的用户信息表（CHLODS.ODS_USR_INFO）与基本信息表（chlwi.t_channel_basicinfo）用渠道标志（CHANNEL_ID）关联，根据状态标志STS_ID ＝ 20,统计开号用户数量. 3) 预销号用户数：取基础层的用户信息表（CHLODS.ODS_USR_INFO）与基本信息表（chlwi.t_channel_basicinfo）用渠道标志（CHANNEL_ID）关联，根据状态标志STS_ID IN (19,21),统计开号用户数量. 或采用Sequence图来表示。 示例： 4.1.1.3 界面设计 示例: 主界面： 新增修改界面： 4.1.1.4 接口设计 描述接口。 4.1.2 功能点2….. 同4.1.1章节。 4.2 模块2…… 同4.1章节。