软件概要设计说明书模板样本.doc

软件概要设计阐明书

拟 制
某某某
日 期
10月20日
审 核

日 期

批 准

日 期

文档修改记录
修改日期
版本/状态
作者
修改章节
修改描述
-10-17
V1.0
某某某

初版V1.0发布

填写阐明
1. 系统构造定义
本体系对整个软件系统按如下构造方式进行划分：系统 à 子系统 à 模块 à 子模块
其中：
（1）“系统 à 子系统”划分属于“系统设计”，在系统设计阐明书中予以描述。
（2）“子系统 à 模块”划分属于“概要设计”，在本阐明书中予以描述。
（3）“模块 à 子模块”划分属于“详细设计”，在详细设计阐明书中予以描述。如果系统相对简朴，可以省略“子模块”这一层次。
2. 如果填写了系统设计阐明书，则在本阐明书中略过“系统 à 子系统”划分有关内容（即第2章）。
3. 如果系统相对简朴，不需要做“系统 à 子系统”划分，这种状况下，取消填写系统设计阐明书，只须填写本阐明书，直接套用“子系统 à 模块”划分（即第3章）进行“系统 à 模块”划分（把其中“子系统”一词替代为“系统”），并删除本阐明书中“系统 à 子系统”划分有关内容（第2章）。
目 录
1. 简介 1
1.1. 背景和目 1
1.2. 范畴 1
1.3. 术语和缩略语 1
2. 系统总体设计 1
2.1. 任务概述 2
2.1.1. 目的 2
2.1.2. 需求概述 2
2.2. 设计概述 2
2.2.1. 总体约束 2
2.2.2. 系统外部接口 2
2.2.3. 设计方案概述 2
2.3. 系统架构设计 3
2.3.1. 系统逻辑架构设计 3
2.3.2. 系统物理架构设计 4
2.4. 子系统定义 5
2.4.1. 子系统列表 5
2.4.2. 子系统间关系 5
3. 子系统1设计 6
3.1. 任务概述 6
3.1.1. 目的 6
3.1.2. 需求概述 6
3.2. 设计概述 6
3.2.1. 总体约束 6
3.2.2. 子系统外部接口 7
3.2.3. 设计方案概述 8
3.3. 子系统架构设计 8
3.4. 模块定义 10
3.4.1. 模块列表 10
3.4.2. 模块间关系 11
3.4.3. 模块描述 11
4. 非功能性需求实现方案 12
6.1. 性能考虑 12
6.2. 兼容性考虑 13
6.3. 安全考虑 13
6.4. 可移植性考虑 13
6.5. 集成与测试考虑 13
6.6. 可扩展性考虑 13
6.7. 可靠性考虑 13
6.8. 可维护性考虑 14
5. 难点及解决方案 14
6. 参照资料 14
7. 附录 15

1. 简介
1.1. 背景和目
本文档编制目是阐明对软件系统设计考虑，涉及软件系统基本解决流程，软件系统组织构造、模块划分、功能分派、接口设计、运营设计、数据构造设计和出错解决设计等，为软件详细设计奠定基本。
1.2. 范畴
本文档合用于消息推送项目二期产品服务端。
1.3. 术语和缩略语
缩略语
英文全名
中文解释
XMPP
The Extensible Messaging and Presence Protocol
可扩展通讯和表达合同

1.
2.
2. 系统总体设计
{ 裁剪阐明：如果已编写系统设计阐明书，或项目不做“系统 à 子系统”划分，此章省略；否则内部各节必要按规定填写。}
{“系统 ──> 子系统”划分。}
{ 目：1）设计系统整体框架：系统最高层次逻辑构造、物理构造；
2）子系统划分与依赖关系定义、子系统之间接口定义、子系统功能定义。}
2.1. 任务概述
2.1.1. 目的
实现目的和功能。
2.1.2. 需求概述
参照“软件需求规格阐明书_V1.0.doc”。
2.2. 设计概述
2.2.1. 总体约束
2.2.2. 系统外部接口
2.2.3. 设计方案概述
建立一套即时通讯&消息推送解决方案：
1) 云端运用spring+mina+jgroups建立一种分布式服务端系统，以XMPP合同提供接口；
2) 终端运用smack建立一种XMPP合同客户端，调用合同接口实现消息接受和终端展示。
2.3. 系统架构设计
2.3.1. 系统逻辑架构设计
2.3.1.1. 单IDC服务器架构图

分六层构造：负载均衡层、接入层、逻辑解决层、数据访问层、数据层、WEB层。
1) 负载均衡层：TV终端通过域名访问云端，DNS智能解析终端IP地址让它连接就近分发服务器，从分发服务器获取接入服务器列表，然后断开XMPP连接；
2) 接入层：TV终端和接入服务器建立XMPP长连接，创立会话；
3) 逻辑解决层：终端合同服务器、推送服务器（RS）、记录服务器。
a) 终端合同服务器：终端往接入服务器发送合同包，接入服务器转发给终端合同服务器解决；
b) 推送服务器：负责从MQ取出消息、解析消息（条件体和消息体）、终端在线和离线查询、按各接入服务器有哪些终端登录把消息包分发给接入服务器；
c) 记录服务器：运用quartz执行定期任务，实现终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、消息推送成果等记录功能。
4) 数据访问层：提供数据访问组件，如Mysql JDBC接口、jedis缓存接口。提供第三方推送接口，供第三方云端调用API，提供单点推送（明消息/暗消息）、条件（区域+机型）推送、regid推送。
5) 数据层： Mongodb集群，Mysql数据库（主从+读写分离），ActiveMQ消息队列，Redis缓存服务器。
6) WEB层：运营平台、第三方推送平台。
2.3.1.2. 多IDC服务器架构图
需要整顿
2.3.2. 系统物理架构设计

2.4. 子系统定义
2.4.1. 子系统列表
子系统编号
子系统名称（标记）
功能描述
开发方式
1
运营平台子系统
由超级管理员和运营人员使用，提供第三方管理、基本数据、消息管理、运维、记录、系统设立、日记查询等功能。
自行开发
2
第三方推送接口子系统
供第三方云端调用API，提供单点推送（明消息/暗消息）、条件（区域+机型）推送、regid推送。
自行开发
3
第三方推送平台子系统
给第三方使用，提供开发者账号注册、应用管理、消息发布、消息推送成果查询等功能。
自行开发
4
推送服务器子系统
云端一种逻辑服务器，实现从MQ取出消息、解析消息（条件体和消息体）、终端在线和离线查询、按各接入服务器有哪些终端登录把消息包分发给接入服务器。
自行开发
5
后台任务子系统
云端后台任务系统，运用quartz执行定期任务，实现终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、消息推送成果等记录功能。
自行开发
6
云端与终端接口：分发服务器、接入服务器、终端合同服务器
为消息盒子终端提供云端接口，用XMPP合同。提供获取接入服务器列表、电视终端获取唯一标记userid、以userid登录认证、建立会话及长连接、推送消息、反馈消息接受和点击状况、终端应用激活上报等合同。
自行开发
7
云端集群
在云端用JGroups技术组建一种集群，管理各逻辑服务器，实现各成员之间通讯、成员状态反馈、成员列表维护等功能。
自行开发
注：开发方式可选：采购、外包、自行开发、复用。
2.4.2. 子系统间关系
{ 裁剪阐明：必填 }
{ 明确子系统之间调用关系、子系统间接口（消息、数据构造）以及有关子系统之间协同工作，可以使用构造图、（交互）事务图、消息序列图、ER图描述。}

1
2
3
3.1
3.2
3.3
3.4
3.5
3.6
3.6.1
3.6.2
3.6.3
3. 子系统1设计
{ 裁剪阐明：必填 }
{ 标题上加入子系统编号及名称（标记）}
{“子系统 ──> 模块”划分。}
{ 目：1）设计子系统整体框架：子系统逻辑构造；
2）模块划分与依赖关系定义、模块之间接口定义、模块功能定义。}
3.
3.1. 任务概述
3.1.1. 目的
{ 裁剪阐明：可选 }
{ 阐明设计意图目的（总目的、分期目的）、作用范畴等。}

3.1.2. 需求概述
{ 裁剪阐明：可选 }
{ 解释软件产品将完毕或不完毕功能（可以直接描述也可以参照有关文档）}

3.2. 设计概述
3.2.1. 总体约束
3.2.1.1. 开发规范
{ 裁剪阐明：可选。如果已填写在2.2.1.1，此处则略。}
（1）编码商定
{ 规定代码体系、模块之间接口和命名规则。}

（2）文献商定
{ 规定子系统所有配备、日记等文献命名方式与格式。}

（3）目录商定
{ 规定子系统目录构造，涉及运营目录、源文献目录、配备目录、日记目录、数据目录等。}

3.2.1.2. ＸＸ约束
{ 裁剪阐明：可选。如果已填写在2.2.2.2，此处则略。}
{ 列出对软件设计有重要影响系统内外部约束和限制，可选约束涉及：
•  顾客环境
•  内存或其他资源限制
•  数据存储和分发需求
•  安全和可靠性需求
•  性能需求
•  测试和可维护性需求 }

3.2.2. 子系统外部接口
{ 裁剪阐明：如果第2章已删除，这里必填（如果有）。}
{ 描述该软件子系统与外部实体接口，涉及顾客界面、软件接口、硬件接口和通信接口。}
{ 软件子系统外部实体，涉及：操作系统、驱动程序、硬件、中断、其他软件子系统等。}
{ 描述待开发软件子系统与外部实体关系，可以使用系统架构图、顶层数据流图、事务图等来描述系统构造和交互关系，并标示出外部实体和本系统互相作用性质（例如：消息、库调用）和类型（例如：OS服务、通信服务、系统工具等）。}
{ 详细描述子系统外部接口参数，如：
• 接口名称
• 调用方式 
• 传播数据：
–哪些数据项？ 
–数据格式？ 
–长度？ 
–类型？ 
• 频度（实时/批解决） 
• 数据同步机制 
• 平台无关性 
• 遵循原则 
• 提供功能 
• 前置条件 
• 后置条件 }

3.2.3. 设计方案概述
{ 裁剪阐明：必填。如果在“3.1设计概述”中已描述过某些，可略。}
{ 描述内容涉及：
（1）整个设计所采用办法：面向对象设计还是构造化设计
（2）采用系统架构：例如MVC架构、N层架构
（3）使用相应技术和工具：例如OMT、Rose、Visio
（4）采用框架技术形式
（5）使用设计模式：层模式、微内核模式、代理模式等
（6）描述资源/内存分派，Flash资源/文献分派
（7）描述哪些模块采用软件复用
}

3.3. 子系统架构设计
{ 裁剪阐明：必填 }
{ 定义子系统总体逻辑构造，定义模块划分以及模块之间依赖关系。}
{ 可以采用分层构造描述如何将子系统分解为模块。}
{ 构造描述可以使用构造图、层次分解图、数据流图，并用文字阐明互相间关系。}
{ 举例，绘制构造图如下：

具备继承等关系类图可使用UML等工具画出关系图，如下：
}

3.4. 模块定义
3.1.
3.2.
3.3.
3.4.
3.4.1. 模块列表
{ 裁剪阐明：必填 }
{ 列举模块时，可以采用表格方式（编号可以省略）。}
模块编号
模块名称（标记）
功能简述
开发方式

注：开发方式可选：采购、外包/自行开发/复用
3.4.2. 模块间关系
{ 裁剪阐明：必填 }
{ 明确模块之间调用关系、模块间接口（消息、数据构造）以及有关模块之间协同工作，如模块间时序图，协作图，以及系统之间状态切换流程图。}

3.4.3. 模块描述
3.4.3.1. 模块1
{ 标题上加入模块编号及名称（标记）}
1）功能描述
{ 裁剪阐明：必填 }
{ 阐明该模块具备什么样基本功能，以及每个功能之间互有关系。}

2）性能描述
{ 裁剪阐明：必填 }
{ 阐明对模块性能规定，涉及精度、时间特性和解决速度。}

3）接口描述
{ 裁剪阐明：必填 }
{ 阐明与其他模块接口，与其他系统或硬件接口。}
{ 对于接口函数，可以采用如下形式描述：
接口1：
形式：
输入：
输出：
返回：描述返回什么。
描述：总体描述该接口实现目。}
{ 需要明确信息涉及：
（1）输入项
列出模块每一种输入项特性，涉及名称、标记、数据类型和格式、数据值有效范畴、输入方式、数量和频度、输入介质等；
可以是逻辑层面输入项，如：图片资源、媒体流、网络数据等，也可以是详细物理层面输入项，如变量1、变量2，等等。
（2）输出项
列出模块每一种输出项特性，涉及名称、标记、数据类型和格式，数据值有效范畴、输出方式、数量和频度、输出介质等。}

4）配备描述
{ 裁剪阐明：可选 }
{ 阐明该模块所处逻辑位置、物理位置，如指明模块放在哪个应用服务器或客户端哪个目录、哪个文献（库），或是在数据库内部建立对象。}

3.4.3.2. 模块2
{ 同3.3.3.1。}

4. 非功能性需求实现方案
{ 裁剪阐明：整章可选 }
6.1. 性能考虑
{ 如：为满足延时、吞吐量等性能，在既定硬件环境约束下所采用设计方案。}

6.2. 兼容性考虑
{ 对此前版本兼容，以及平滑升级考虑。}

6.3. 安全考虑
{ 如：作为应用软件，在安全面更多是考虑访问控制，涉及使用什么样权限管理、分派、验证方案。}

6.4. 可移植性考虑
{ 系统如果有跨平台需求，要考虑操作系统、中间件、应用服务器特性、数据库及第三方服务移植。描述如何在不同平台移植，与否为可配备？ }

6.5. 集成与测试考虑
{ 各个子系统以及模块以什么先后顺序进行开发、集成（组装）和测试，即是采用自底向上法还是自顶向下法。}

6.6. 可扩展性考虑
{ 不但有对系统功能扩展设计考虑，还要考虑系统性能扩展，即可伸缩性。即考虑：
（1）如何最低成本地添加新功能？
（2）如何最低成本复制一种新系统，并且新旧系统可以做成统一体？}

6.7. 可靠性考虑
{ 对故障检测、故障隔离、故障恢复、容错、冗余、备份设计考虑。}

6.8. 可维护性考虑
{ 内容应涉及：
（1）系统模块与否可以装配？功能模块与否可以配备？整个系统与否已经参数化？
（2）提供什么样维护方式、接口及介面？
描述为了系统维护而在系统设计中作出安排，涉及在程序中专门安排用于系统检查与维护检测点和专用模块，如打印信息打印规则设计（含打印形式，关闭和打开打印调试信息办法等）。
（3）有哪些寻常维护需求，并且如何解决？}

5. 难点及解决方案
{ 裁剪阐明：可选 }
{ 列出也许疑难问题，并尽量能给出基本解决思路（涉及核心算法、时序、数据构造等）。可采用表格方式。}

难点描述
可采用解决方案

6. 参照资料
{ 裁剪阐明：可选 }
{ 列举编写软件产品概要设计报告时所用到项目中其她文档或资料。}

7. 附录
{ 裁剪阐明：可选 }
{ 在此列出需要补充有关文档和技术问题。}