软件概要设计说明书范例

某某某日日日期期期2018年10月20日文档修改记录修改日期2017-10-17作者某某某修改描述版本/状态修改日期2017-10-17作者某某某修改描述版本/状态V1.0初版V1.0发布填写说明本体系对整个软件系统按如下结构方式进行划分：系统子系统模块子模块（1）“系统子系统”划分属于“系统设计”，在系统设计说明书中予以描述。（2）“子系统模块”划分属于“概要设计”，在本说明书中予以描述。（3）“模块子模块”划分属于“详细设计”，在详细设计说明书中予以描述。如果系统相对简单，可以省略“子模块”这一层次。2.如果填写了系统设计说明书，则在本说明书中略过“系统子系统”划分的相关内容（即第23.如果系统相对简单，不需要做“系统子系统”划分，这种情况下，取消填写系统设计说明书，只须填写本说明书，直接套用“子系统模块”划分（即第3章）进行“系统模块”划分（把其中“子系统”一词替换为“系统”），并删除本说明书中“系统子系统”划分的相关内 2 2 2 2 2 2 2 3 3 4 5 5 5 6 6 6 6 6 6 7 8 8 10 10 10 104.非功能性需求的实现方案 11 12 12 12 12 12 12 13 13 13 13 141.1.背景和目的本文档编制的目的是说明对软件系统的设计考虑，包括软件系统的基本处理流程，软件系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为软件的详本文档适用于消息推送项目二期产品的服务端。1.3.术语和缩略语英文全名The英文全名TheExtensibleMessagingXMPPandPresence可扩展通讯和表示协议XMPP2.系统总体设计{裁剪说明：如果已编写系统设计说明书，或项目不做“系统子系统”划分，此章省略；否则内2）子系统的划分与依赖关系定义、子系统之间的接口定义、子系统功能定义。}2.1.任务概述参考“软件需求规格说明书_V1.0.doc”。2.2.设计概述2.2.3.设计方案概述建立一套即时通讯&消息推送的解决方案：1)云端运用spring+mina+jgroups建立一个分布式的服务端系统，以XMPP协议提供接口；2)终端运用smack建立一个XMPP协议的客户端，调用协议接口实现消息接收和终端展示。2.3.系统架构设计分六层结构：负载均衡层、接入层、逻辑处理层、数据访问层、数据层、WEB层。服务器，从分发服务器获取接入服务器列表，然后断开XMPP连接；2)接入层：TV终端和接入服务器建立XMPP长连接，创建会话；3)逻辑处理层：终端协议服务器、推送服务器（RS）、统计服务器。a)终端协议服务器：终端往接入服务器发送协议包，接入服务器转发给终端协议服务器处b)推送服务器：负责从MQ取出消息、解析消息（条件体和消息体）、终端在线和离线查询、按各接入服务器有哪些终端登录把消息包分发给接入服务器；c)统计服务器：运用quartz执行定时任务，实现终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、消息推送结果等统计功能。4)数据访问层：提供数据访问组件，如MysqlJDBC接口、jedis缓存接口。提供第三方推送接5)数据层：Mongodb集群，Mysq6)WEB层：运营平台、第三方推送平台。2.4.子系统定义1234567运营平台子系统第三方推送接口子系统第三方推送平台子系统推送服务器子系统后台任务子系统云端与终端接口：分发服务器、接入服务器、终端协议服务器云端集群由超级管理员和运营人员使用，提供第三方管理、基础数据、消息管理、运维、统计、系统设置、日志查询等功能。供第三方云端调用的API，提供单点推送（明消息/暗消息）、条件（区域+机型）推给第三方使用，提供开发者账号注册、应用管理、消息发布、消息推送结果查询等功云端的一个逻辑服务器，实现从MQ取出消息、解析消息（条件体和消息体）、终端在线和离线查询、按各接入服务器有哪些终端登录把消息包分发给接入服务器。云端的后台任务系统，运用quartz执行定时任务，实现终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、为消息盒子终端提供云端接口，用XMPP协议。提供获取接入服务器列表、电视终端获取唯一标识userid、以userid登录认证、建立会话及长连接、推送消息、反馈消息接收和点击情况、终端应用激活上报等协在云端用JGroups技术组建一个集群，管理各逻辑服务器，实现各成员之间的通讯、成员状态反馈、成员列表维护等功能。注：开发方式可选：采购、外包、自行开发、复用。{裁剪说明：必填}{明确子系统之间的调用关系、子系统间的接口（消息、数据结构）以及相关子系统之间的协同}{裁剪说明：必填}{“子系统──>模块”划分。}}3.1.任务概述{裁剪说明：可选}}{裁剪说明：可选}3.2.设计概述}}}{规定子系统的目录结构，包括运行目录、源文件目录、}3.2.1.2.XX约束}{列出对软件设计有重要影响的系统内外部约束和限制，可选的约束包括：.用户环境.内存或其它资源限制.数据存储和分发需求.安全和可靠性需求.性能需求.测试和可维护性需求}}{描述该软件子系统与外部实体的接口，包}}{描述待开发软件子系统与外部实体的关系，可以使用系统架构图、顶层数据流图、事务图等来描述系统结构和交互关系，并标示出外部实体和本系统相互作用的性质（比如：消息、库调用）和类}.接口名称.调用方式.传输的数据：•频度（实时/批处理）•数据同步机制•平台无关性•遵循的标准•提供的功能•前置条件•后置条件}3.2.3.设计方案概述}（1）整个设计所采用的方法：面向对象设计还是结构化设计（3）使用的相应技术和工具：例如OMT、Rose、Visio（4）采用的框架技术的形式（5）使用的设计模式：层模式、微内核模式、代理模式等（7）描述哪些模块采用软件复用}3.3.子系统架构设计{裁剪说明：必填}}}}具有继承等关系的类图的可使用UML等工具画出关系图，如下：}3.4.模块定义3.4.1.模块列表{裁剪说明：必填}}注：开发方式可选：采购、外包/自行开发/复用{裁剪说明：必填}{明确模块之间的调用关系、模块间的接口（消息、数据结构）以及相关模块之间的协同工作，}{裁剪说明：必填}}2）性能描述{裁剪说明：必填}}3）接口描述{裁剪说明：必填}{说明与其它模块的接口，与其它系统或硬件的接口。}描述：总体描述该接口实现的目的。}（1）输入项列出模块每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入可以是逻辑层面的输入项，如：图片资源、媒体流、网络数据等，也可以是具体的物理层面的输入项，如变量1、变量2，等等。（2）输出项列出模块每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围、输出方式、数量和频度、输出介质等。}4）配置描述{说明该模块所处的逻辑位置、物理位置，如指明模块放在哪个应用服务器或客户端的哪个目录、哪个文件（库或是在数据库内部建立的对象。}4.非功能性需求的实现方案{如：为满足延时、吞吐量等性能，在既定硬件环境约束下所采取的设计方案。}{如：作为应用软件，在安全方面更多的是考虑访问控制，包括使用什么样的权限管理、分配、{系统如果有跨平台的需求，要考虑操作系统、中间件、应用服务器特性、数据库及第三方服务{各个子系统以及模块以什么先后次序进行开发、集成（组装）和测试，即是采用自底向上法还{不仅有对系统功能扩展的设计考虑，还要考虑系统的性能扩展，即可伸缩性。即考虑：（2）如何最低成本的复制一个新系统，并且新旧系统可以做成统一体？}{对故障检测、故障隔离、故障恢复、容错、冗余、备份的设计考虑。}（1）系统模块是否可以装配？功能模块是否可以配置？整个系统是否已经参数化？