软件概要设计说明书范例

1、.1*概要设计说明书拟 制*日 期2021年10月20日审 核日 期批 准日 期文档修改记录修改日期版本/状态作者修改章节修改描述2021-10-17V1.0*初版V1.0发布填写说明1. 系统构造的定义本体系对整个软件系统按如下构造方式进展划分：系统 子系统 模块 子模块其中：1“系统 子系统划分属于“系统设计，在系统设计说明书中予以描述。2“子系统 模块划分属于“概要设计，在本说明书中予以描述。3“模块 子模块划分属于“详细设计，在详细设计说明书中予以描述。如果系统相对简单，可以省略“子模块这一层次。2. 如果填写了系统设计说明书，则在本说明书中略过“系统 子系统划分的相关容即第2章。3.

2、 如果系统相对简单，不需要做“系统 子系统划分，这种情况下，取消填写系统设计说明书，只须填写本说明书，直接套用“子系统 模块划分即第3章进展“系统 模块划分把其中“子系统一词替换为“系统，并删除本说明书中“系统 子系统划分的相关容第2章。目 录 TOC o 1-3 h z u HYPERLINK l _Toc3804225501.简介 PAGEREF _Toc380422550 h 1HYPERLINK l _Toc3804225511.1.背景和目的 PAGEREF _Toc380422551 h 1HYPERLINK l _Toc3804225521.2.围 PAGEREF _Toc380

3、422552 h 1HYPERLINK l _Toc3804225531.3.术语和缩略语 PAGEREF _Toc380422553 h 1HYPERLINK l _Toc3804225562.系统总体设计 PAGEREF _Toc380422556 h 1HYPERLINK l _Toc3804225572.1.任务概述 PAGEREF _Toc380422557 h 2HYPERLINK l _Toc3804225582.1.1.目标 PAGEREF _Toc380422558 h 2HYPERLINK l _Toc3804225592.1.2.需求概述 PAGEREF _Toc3804

4、22559 h 2HYPERLINK l _Toc3804225602.2.设计概述 PAGEREF _Toc380422560 h 2HYPERLINK l _Toc3804225612.2.1.总体约束 PAGEREF _Toc380422561 h 2HYPERLINK l _Toc3804225622.2.2.系统外部接口 PAGEREF _Toc380422562 h 2HYPERLINK l _Toc3804225632.2.3.设计方案概述 PAGEREF _Toc380422563 h 2HYPERLINK l _Toc3804225642.3.系统架构设计 PAGEREF _

5、Toc380422564 h 3HYPERLINK l _Toc3804225652.3.1.系统的逻辑架构设计 PAGEREF _Toc380422565 h 3HYPERLINK l _Toc3804225662.3.2.系统的物理架构设计 PAGEREF _Toc380422566 h 4HYPERLINK l _Toc3804225672.4.子系统定义 PAGEREF _Toc380422567 h 5HYPERLINK l _Toc3804225682.4.1.子系统列表 PAGEREF _Toc380422568 h 5HYPERLINK l _Toc3804225692.4.2

6、.子系统间关系 PAGEREF _Toc380422569 h 5HYPERLINK l _Toc3804225703.子系统1设计 PAGEREF _Toc380422570 h 6HYPERLINK l _Toc3804225723.1.任务概述 PAGEREF _Toc380422572 h 6HYPERLINK l _Toc3804225733.1.1.目标 PAGEREF _Toc380422573 h 6HYPERLINK l _Toc3804225743.1.2.需求概述 PAGEREF _Toc380422574 h 6HYPERLINK l _Toc3804225753.2.

7、设计概述 PAGEREF _Toc380422575 h 6HYPERLINK l _Toc3804225763.2.1.总体约束 PAGEREF _Toc380422576 h 6HYPERLINK l _Toc3804225773.2.2.子系统外部接口 PAGEREF _Toc380422577 h 7HYPERLINK l _Toc3804225783.2.3.设计方案概述 PAGEREF _Toc380422578 h 8HYPERLINK l _Toc3804225793.3.子系统架构设计 PAGEREF _Toc380422579 h 8HYPERLINK l _Toc3804

8、225803.4.模块定义 PAGEREF _Toc380422580 h 10HYPERLINK l _Toc3804225853.4.1.模块列表 PAGEREF _Toc380422585 h 10HYPERLINK l _Toc3804225863.4.2.模块间关系 PAGEREF _Toc380422586 h 11HYPERLINK l _Toc3804225873.4.3.模块描述 PAGEREF _Toc380422587 h 11HYPERLINK l _Toc3804225884.非功能性需求的实现方案 PAGEREF _Toc380422588 h 12HYPERLIN

9、K l _Toc3804225896.1.性能的考虑 PAGEREF _Toc380422589 h 12HYPERLINK l _Toc3804225906.2.兼容性的考虑 PAGEREF _Toc380422590 h 13HYPERLINK l _Toc3804225916.3.平安的考虑 PAGEREF _Toc380422591 h 13HYPERLINK l _Toc3804225926.4.可移植性的考虑 PAGEREF _Toc380422592 h 13HYPERLINK l _Toc3804225936.5.集成与测试的考虑 PAGEREF _Toc380422593 h

10、 13HYPERLINK l _Toc3804225946.6.可扩展性的考虑 PAGEREF _Toc380422594 h 13HYPERLINK l _Toc3804225956.7.可靠性的考虑 PAGEREF _Toc380422595 h 13HYPERLINK l _Toc3804225966.8.可维护性的考虑 PAGEREF _Toc380422596 h 14HYPERLINK l _Toc3804225975.难点及解决方案 PAGEREF _Toc380422597 h 14HYPERLINK l _Toc3804225986.参考资料 PAGEREF _Toc3804

11、22598 h 14HYPERLINK l _Toc3804225997.附录 PAGEREF _Toc380422599 h15.1简介背景和目的本文档编制的目的是说明对软件系统的设计考虑，包括软件系统的根本处理流程，软件系统的组织构造、模块划分、功能分配、接口设计、运行设计、数据构造设计和出错处理设计等，为软件的详细设计奠定根底。围本文档适用于消息推送工程二期产品的效劳端。术语和缩略语缩略语英文全名中文解释*MPPThe E*tensible Messaging and Presence Protocol可扩展通讯和表示协议系统总体设计 裁剪说明：如果已编写系统设计说明书，或工程不做“系统

12、 子系统划分，此章省略；否则部的各节必须按要求填写。“系统 子系统划分。 目的：1设计系统整体框架：系统最高层次的逻辑构造、物理构造；2子系统的划分与依赖关系定义、子系统之间的接口定义、子系统功能定义。任务概述目标实现目标和功能。需求概述参考“软件需求规格说明书。设计概述总体约束系统外部接口设计方案概述建立一套即时通讯&消息推送的解决方案：云端运用spring+mina+jgroups建立一个分布式的效劳端系统，以*MPP协议提供接口；终端运用smack建立一个*MPP协议的客户端，调用协议接口实现消息接收和终端展示。系统架构设计系统的逻辑架构设计单IDC效劳器架构图分六层构造：负载均衡层、接

13、入层、逻辑处理层、数据层、数据层、WEB层。负载均衡层：TV终端通过域名云端，DNS智能解析终端的IP地址让它连接就近的分发效劳器，从分发效劳器获取接入效劳器列表，然后断开*MPP连接；接入层：TV终端和接入效劳器建立*MPP长连接，创立会话；逻辑处理层：终端协议效劳器、推送效劳器RS、统计效劳器。终端协议效劳器：终端往接入效劳器发送协议包，接入效劳器转发给终端协议效劳器处理；推送效劳器：负责从MQ取出消息、解析消息条件体和消息体、终端在线和离线查询、按各接入效劳器有哪些终端登录把消息包分发给接入效劳器；统计效劳器：运用quartz执行定时任务，实现终端每天在线数、终端每小时在线数、终端每天激

14、活数、终端登录次数、消息推送结果等统计功能。数据层：提供数据组件，如Mysql JDBC接口、jedis缓存接口。提供第三方推送接口，供第三方云端调用的API，提供单点推送明消息/暗消息、条件区域+机型推送、regid推送。数据层： Mongodb集群，Mysql数据库主从+读写别离，ActiveMQ消息队列，Redis缓存效劳器。WEB层：运营平台、第三方推送平台。多IDC效劳器架构图需要整理系统的物理架构设计子系统定义子系统列表子系统编号子系统名称标识功能描述开发方式1运营平台子系统由超级管理员和运营人员使用，提供第三方管理、根底数据、消息管理、运维、统计、系统设置、日志查询等功能。自行开

15、发2第三方推送接口子系统供第三方云端调用的API，提供单点推送明消息/暗消息、条件区域+机型推送、regid推送。自行开发3第三方推送平台子系统给第三方使用，提供开发者账号注册、应用管理、消息发布、消息推送结果查询等功能。自行开发4推送效劳器子系统云端的一个逻辑效劳器，实现从MQ取出消息、解析消息条件体和消息体、终端在线和离线查询、按各接入效劳器有哪些终端登录把消息包分发给接入效劳器。自行开发5后台任务子系统云端的后台任务系统，运用quartz执行定时任务，实现终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、消息推送结果等统计功能。自行开发6云端与终端接口：分发效劳器、接入效劳

16、器、终端协议效劳器为消息盒子终端提供云端接口，用*MPP协议。提供获取接入效劳器列表、电视终端获取唯一标识userid、以userid登录认证、建立会话及长连接、推送消息、反响消息接收和点击情况、终端应用激活上报等协议。自行开发7云端集群在云端用JGroups技术组建一个集群，管理各逻辑效劳器，实现各成员之间的通讯、成员状态反响、成员列表维护等功能。自行开发注：开发方式可选：采购、外包、自行开发、复用。子系统间关系 裁剪说明：必填 明确子系统之间的调用关系、子系统间的接口消息、数据构造以及相关子系统之间的协同工作，可以使用构造图、交互事务图、消息序列图、ER图描述。子系统1设计 裁剪说明：必填

17、 标题上参加子系统的编号及名称标识“子系统 模块划分。 目的：1设计子系统整体框架：子系统的逻辑构造；2模块的划分与依赖关系定义、模块之间的接口定义、模块功能定义。任务概述目标 裁剪说明：可选 说明设计意图目标总目标、分期目标、作用围等。需求概述 裁剪说明：可选 解释软件产品将完成或不完成的功能可以直接描述也可以参考相关文档设计概述总体约束开发规 裁剪说明：可选。如果已填写在2.2.1.1，此处则略。 1编码约定 规定代码体系、模块之间的接口和命名规则。2文件约定 规定子系统的所有配置、日志等文件命名方式与格式。3目录约定 规定子系统的目录构造，包括运行目录、源文件目录、配置目录、日志目录、数

18、据目录等。约束 裁剪说明：可选。如果已填写在2.2.2.2，此处则略。 列出对软件设计有重要影响的系统外部约束和限制，可选的约束包括：用户环境存或其它资源限制数据存储和分发需求平安和可靠性需求性能需求测试和可维护性需求子系统外部接口 裁剪说明：如果第2章已删除，这里必填如果有。 描述该软件子系统与外部实体的接口，包括用户界面、软件接口、硬件接口和通信接口。 软件子系统的外部实体，包括：操作系统、驱动程序、硬件、中断、其它软件子系统等。 描述待开发软件子系统与外部实体的关系，可以使用系统架构图、顶层数据流图、事务图等来描述系统构造和交互关系，并标示出外部实体和本系统相互作用的性质比方：消息、库调

19、用和类型比方：OS效劳、通信效劳、系统工具等。 详细描述子系统外部接口的参数，如：接口名称调用方式传输的数据：哪些数据项.数据格式.长度.类型.频度实时/批处理数据同步机制平台无关性遵循的标准提供的功能前置条件后置条件设计方案概述 裁剪说明：必填。如果在“3.1设计概述中已描述过的局部，可略。 描述容包括： 1整个设计所采用的方法：面向对象设计还是构造化设计2采用的系统架构：例如MVC架构、N层架构3使用的相应技术和工具：例如OMT、Rose、Visio4采用的框架技术的形式5使用的设计模式：层模式、微核模式、代理模式等6描述资源/存分配，Flash资源/文件分配7描述哪些模块采用软件复用 子

20、系统架构设计 裁剪说明：必填 定义子系统的总体逻辑构造，定义模块划分以及模块之间的依赖关系。 可以采用分层构造描述如何将子系统分解为模块。 构造描述可以使用构造图、层次分解图、数据流图，并用文字说明相互间的关系。 举例，绘制构造图如下：具有继承等关系的类图的可使用UML等工具画出关系图，如下：模块定义模块列表 裁剪说明：必填 列举模块时，可以采用表格方式编号可以省略。模块编号模块名称标识功能简述开发方式注：开发方式可选：采购、外包/自行开发/复用模块间关系 裁剪说明：必填 明确模块之间的调用关系、模块间的接口消息、数据构造以及相关模块之间的协同工作，如模块间时序图，协作图，以及系统之间状态切换

21、流程图。模块描述模块1 标题上参加模块的编号及名称标识1功能描述 裁剪说明：必填 说明该模块具备什么样的根本功能，以及每个功能之间的相互关系。2性能描述 裁剪说明：必填 说明对模块的性能要求，包括精度、时间特性和处理速度。3接口描述 裁剪说明：必填 说明与其它模块的接口，与其它系统或硬件的接口。 对于接口函数，可以采用以下形式描述：接口1：形式：输入：输出：返回：描述返回什么。描述：总体描述该接口实现的目的。 需要明确的信息包括：1输入项列出模块每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效围、输入方式、数量和频度、输入介质等；可以是逻辑层面的输入项，如：图片资源、媒体流、网络数据等，也可以是具体的物理层面的输入项，如变量1、变量2，等等。2输出项列出模块每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效围、输出方式、数量和频度、输出介质等。4配置描述 裁剪说明：可选 说明该模块所处的逻辑位置、物理位置，如指明模块放在哪个应用效劳器或客户端的哪个目录、哪个文件库，或是在数据库部建立的对象。模块2 同3.3.